Developer Reference for Intel® oneAPI Math Kernel Library for C
v?Hypot
vsHypot vdHypot vmsHypot vmdHypot Computes a square root of sum of two squared elements.
Syntax
vhHypot ( n , a , b , y ) ;
vhHypotI(n, a, inca, b, incb, y, incy);
vmhHypot ( n , a , b , y , mode ) ;
vmhHypotI(n, a, inca, b, incb, y, incy, mode);
vsHypot ( n , a , b , y ) ;
vsHypotI(n, a, inca, b, incb, y, incy);
vmsHypot ( n , a , b , y , mode ) ;
vmsHypotI(n, a, inca, b, incb, y, incy, mode);
vdHypot ( n , a , b , y ) ;
vdHypotI(n, a, inca, b, incb, y, incy);
vmdHypot ( n , a , b , y , mode ) ;
vmdHypotI(n, a, inca, b, incb, y, incy, mode);
Include Files
mkl.h
Input Parameters
Name |
Type |
Description |
|---|---|---|
n |
const MKL_INT |
Number of elements to be calculated. |
a , b |
const _Float16* for vhHypot , vmhHypot const float* for vsHypot , vmsHypot const double* for vdHypot , vmdHypot |
Pointers to arrays that contain the input vectors a and b . |
inca , incb , incy |
const MKL_INT |
Specifies increments for the elements of a , b , and y . |
mode |
const MKL_INT64 |
Overrides global VM mode setting for this function call. See vmlSetMode (Sets a new mode for VM functions according to the mode parameter and stores the previous VM mode to oldmode.) for possible values and their description. |
Precision Overflow Thresholds for Hypot Function
Data Type |
Threshold Limitations on Input Parameters |
|---|---|
single precision |
abs(a[i]) < sqrt(FLT_MAX)abs(b[i]) < sqrt(FLT_MAX) |
double precision |
abs(a[i]) < sqrt(DBL_MAX)abs(b[i]) < sqrt(DBL_MAX) |
Output Parameters
Name |
Type |
Description |
|---|---|---|
y |
_Float16* for vhHypot , vmhHypot float* for vsHypot , vmsHypot double* for vdHypot , vmdHypot |
Pointer to an array that contains the output vector y . |
Description
The function v?Hypot computes a square root of sum of two squared elements.
Special values for Real Function v?Hypot(x)
Argument 1 |
Argument 2 |
Result |
Exception |
|---|---|---|---|
+0 |
+0 |
+0 |
|
-0 |
-0 |
+0 |
|
|
any value |
|
|
any value |
|
|
|
SNAN |
any value |
QNAN |
INVALID |
any value |
SNAN |
QNAN |
INVALID |
QNAN |
any value |
QNAN |
|
any value |
QNAN |
QNAN |