Hypotenuse of the two inputs. More...

AFAPI array hypot (const array &lhs, const array &rhs)
 C++ Interface for getting length of hypotenuse of two inputs. More...
 
AFAPI array hypot (const array &lhs, const double rhs)
 C++ Interface for getting length of hypotenuse of two inputs. More...
 
AFAPI array hypot (const double lhs, const array &rhs)
 C++ Interface for getting length of hypotenuse of two inputs. More...
 

Detailed Description

Hypotenuse of the two inputs.

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

Function Documentation

◆ hypot() [1/3]

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

C++ Interface for getting length of hypotenuse of two inputs.

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

Parameters
[in]lhsis the length of first side
[in]rhsis the length of second side
Returns
the length of the hypotenuse
Examples:
image_processing/edge.cpp, image_processing/filters.cpp, and image_processing/gradient_diffusion.cpp.

◆ hypot() [2/3]

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

C++ Interface for getting length of hypotenuse of two inputs.

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

Parameters
[in]lhsis the length of first side
[in]rhsis the length of second side
Returns
the length of the hypotenuse

◆ hypot() [3/3]

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

C++ Interface for getting length of hypotenuse of two inputs.

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

Parameters
[in]lhsis the length of first side
[in]rhsis the length of second side
Returns
the length of the hypotenuse