Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

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

Document Table of Contents

v?Atan

Computes inverse tangent of vector elements.

Syntax

call vsatan( n, a, y )

call vsatani(n, a, inca, y, incy)

call vmsatan( n, a, y, mode )

call vmsatani(n, a, inca, y, incy, mode)

call vdatan( n, a, y )

call vdatani(n, a, inca, y, incy)

call vmdatan( n, a, y, mode )

call vmdatani(n, a, inca, y, incy, mode)

call vcatan( n, a, y )

call vcatani(n, a, inca, y, incy)

call vmcatan( n, a, y, mode )

call vmcatani(n, a, inca, y, incy, mode)

call vzatan( n, a, y )

call vzatani(n, a, inca, y, incy)

call vmzatan( n, a, y, mode )

call vmzatani(n, a, inca, y, incy, mode)

Include Files

  • mkl_vml.f90

Input Parameters

Name

Type

Description

n

INTEGER, INTENT(IN)

Specifies the number of elements to be calculated.

a

DOUBLE PRECISION for vdatan, vmdatan

COMPLEX for vcatan, vmcatan

DOUBLE COMPLEX for vzatan, vmzatan

REAL, INTENT(IN) for vsatan, vmsatan

DOUBLE PRECISION, INTENT(IN) for vdatan, vmdatan

COMPLEX, INTENT(IN) for vcatan, vmcatan

DOUBLE COMPLEX, INTENT(IN) for vzatan, vmzatan

Array that specifies the input vector a.

inca, incy

INTEGER, INTENT(IN)

Specifies increments for the elements of a 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.

Output Parameters

Name

Type

Description

y

DOUBLE PRECISION for vdatan, vmdatan

COMPLEX for vcatan, vmcatan

DOUBLE COMPLEX for vzatan, vmzatan

REAL, INTENT(OUT) for vsatan, vmsatan

DOUBLE PRECISION, INTENT(OUT) for vdatan, vmdatan

COMPLEX, INTENT(OUT) for vcatan, vmcatan

DOUBLE COMPLEX, INTENT(OUT) for vzatan, vmzatan

Array that specifies the output vector y.

Description

The v?Atan function computes inverse tangent of vector elements.

Special Values for Real Function v?Atan(x)
Argument Result VM Error Status Exception
+0 +0    
-0 -0    
+ +π/2    
- -π/2    
QNAN QNAN    
SNAN QNAN   INVALID

Specifications for special values of the complex functions are defined according to the following formula

Atan(z) = -i*Atanh(i*z).