Developer Reference for Intel® oneAPI Math Kernel Library for Fortran
v?Hypot
vsHypot vdHypot vmsHypot vmdHypot Computes a square root of sum of two squared elements.
Syntax
call vshypot ( n , a , b , y )
call vshypoti(n, a, inca, b, incb, y, incy)
call vmshypot ( n , a , b , y , mode )
call vmshypoti(n, a, inca, b, incb, y, incy, mode)
call vdhypot ( n , a , b , y )
call vdhypoti(n, a, inca, b, incb, y, incy)
call vmdhypot ( n , a , b , y , mode )
call vmdhypoti(n, a, inca, b, incb, y, incy, mode)
Include Files
mkl_vml.f90
Input Parameters
Name |
Type |
Description |
|---|---|---|
n |
INTEGER , INTENT(IN) |
Number of elements to be calculated. |
a , b |
Fortran 77: DOUBLE PRECISION for vdhypot , vmdhypotFortran 90: REAL , INTENT(IN) for vshypot , vmshypotFortran 90: DOUBLE PRECISION , INTENT(IN) for vdhypot , vmdhypot |
Arrays that specify the input vectors a and b |
inca , incb , incy |
INTEGER, INTENT(IN) |
Specifies increments for the elements of a , b , and y . |
mode |
INTEGER(KIND=8) , INTENT(IN) |
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 |
Fortran 77: DOUBLE PRECISION for vdhypot , vmdhypotFortran 90: REAL , INTENT(OUT) for vshypot , vmshypotFortran 90: DOUBLE PRECISION , INTENT(OUT) for vdhypot , vmdhypot |
Array that specifies 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 |