A high-performance general-purpose compute library

Evaluate the length of the hypotenuse of two inputs. More...

AFAPI array hypot (const array &lhs, const array &rhs)
 C++ Interface to calculate the length of the hypotenuse of two inputs.
 
AFAPI array hypot (const array &lhs, const double rhs)
 C++ Interface to calculate the length of the hypotenuse of two inputs.
 
AFAPI array hypot (const double lhs, const array &rhs)
 C++ Interface to calculate the length of the hypotenuse of two inputs.
 

Detailed Description

Evaluate the length of the hypotenuse of two inputs.

Note
This function supports real inputs only. Complex inputs are not yet supported.

Function Documentation

◆ hypot() [1/3]

AFAPI array hypot ( const array lhs,
const array rhs 
)

C++ Interface to calculate the length of the hypotenuse of two inputs.

Calculates the hypotenuse of two inputs. The inputs can be both arrays or an array and a scalar.

Parameters
[in]lhslength of first side
[in]rhslength of second side
Returns
length of the hypotenuse

◆ hypot() [2/3]

AFAPI array hypot ( const array lhs,
const double  rhs 
)

C++ Interface to calculate the length of the hypotenuse of two inputs.

Calculates the hypotenuse of two inputs. The inputs can be both arrays or an array and a scalar.

Parameters
[in]lhslength of first side
[in]rhslength of second side
Returns
length of the hypotenuse

◆ hypot() [3/3]

AFAPI array hypot ( const double  lhs,
const array rhs 
)

C++ Interface to calculate the length of the hypotenuse of two inputs.

Calculates the hypotenuse of two inputs. The inputs can be both arrays or an array and a scalar.

Parameters
[in]lhslength of first side
[in]rhslength of second side
Returns
length of the hypotenuse