Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 7/13/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

v?Hypot

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

DOUBLE PRECISION for vdhypot, vmdhypot

REAL, INTENT(IN) for vshypot, vmshypot

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 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

DOUBLE PRECISION for vdhypot, vmdhypot

REAL, INTENT(OUT) for vshypot, vmshypot

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