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

Performs element by element addition of vector a and vector b.

Syntax

call vsadd( n, a, b, y )

call vsaddi(n, a, inca, b, incb, y, incy)

call vmsadd( n, a, b, y, mode )

call vmsaddi(n, a, inca, b, incb, y, incy, mode)

call vdadd( n, a, b, y )

call vdaddi(n, a, inca, b, incb, y, incy)

call vmdadd( n, a, b, y, mode )

call vmdaddi(n, a, inca, b, incb, y, incy, mode)

call vcadd( n, a, b, y )

call vcaddi(n, a, inca, b, incb, y, incy)

call vmcadd( n, a, b, y, mode )

call vmcaddi(n, a, inca, b, incb, y, incy, mode)

call vzadd( n, a, b, y )

call vzaddi(n, a, inca, b, incb, y, incy)

call vmzadd( n, a, b, y, mode )

call vmzaddi(n, a, inca, b, incb, 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, b

DOUBLE PRECISION for vdadd, vmdadd

COMPLEX for vcadd, vmcadd

DOUBLE COMPLEX for vzadd, vmzadd

REAL, INTENT(IN) for vsAdd, vmsAdd

DOUBLE PRECISION, INTENT(IN) for vdadd, vmdadd

COMPLEX, INTENT(IN) for vcadd, vmcadd

DOUBLE COMPLEX, INTENT(IN) for vzadd, vmzadd

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.

Output Parameters

Name

Type

Description

y

DOUBLE PRECISION for vdadd, vmdadd

COMPLEX, for vcadd, vmcadd

DOUBLE COMPLEX for vzadd, vmzadd

REAL, INTENT(OUT) for vsAdd, vmsAdd

DOUBLE PRECISION, INTENT(OUT) for vdadd, vmdadd

COMPLEX, INTENT(OUT) for vcadd, vmcadd

DOUBLE COMPLEX, INTENT(OUT) for vzadd, vmzadd

Array that specifies the output vector y.

Description

The v?Add function performs element by element addition of vector a and vector b.

Special values for Real Function v?Add
Argument 1 Argument 2 Result Exception
+0 +0 +0  
+0 -0 +0  
-0 +0 +0  
-0 -0 -0  
+ + +  
+ - QNAN INVALID
- + QNAN INVALID
- - -  
SNAN any value QNAN INVALID
any value SNAN QNAN INVALID
QNAN non-SNAN QNAN  
non-SNAN QNAN QNAN  

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

Add(x1+i*y1,x2+i*y2) = (x1+x2) + i*(y1+y2)

Overflow in a complex function occurs (supported in the HA/LA accuracy modes only) when all RE(x), RE(y), IM(x), IM(y) arguments are finite numbers, but the real or imaginary part of the computed result is so large that it does not fit the target precision. In this case, the function returns in that part of the result, raises the OVERFLOW exception, and sets the VM Error Status to VML_STATUS_OVERFLOW (overriding any possible VML_STATUS_ACCURACYWARNING status).