v?Sub

Performs element by element subtraction of vector b from vector a.

Syntax

Fortran:

call vssub( n, a, b, y )

call vdsub( n, a, b, y )

call vcsub( n, a, b, y )

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

call vzsub( n, a, b, y )

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

vsSub( n, a, b, y );

vdSub( n, a, b, y );

vcSub( n, a, b, y );

vmcSub( n, a, b, y, mode );

vzSub( n, a, b, y );

vmzSub( n, a, b, y, mode );

Include Files

The FORTRAN 77 interfaces are specified in the mkl_vml.f77 include file, the Fortran 95 interfaces are specified in the mkl_vml.f90 include file, and the C interfaces are specified in the mkl_vml_functions.h include file.

Input Parameters

Name	Type	Description
n	FORTRAN 77: INTEGER Fortran 90: INTEGER, INTENT(IN) C: const int	Specifies the number of elements to be calculated.
a, b	FORTRAN 77: REAL for vssub DOUBLE PRECISION for vdsub COMPLEX for vcsub DOUBLE COMPLEX for vzsub Fortran 90: REAL, INTENT(IN) for vssub DOUBLE PRECISION, INTENT(IN) for vdsub COMPLEX, INTENT(IN) for vcsub DOUBLE COMPLEX, INTENT(IN) for vzsub C: const float* for vsSub const double* for vdSub const MKL_Complex8* for vcSub const MKL_Complex16* for vzSub	FORTRAN: Arrays that specify the input vectors a and b. C: Pointers to arrays that contain the input vectors a and b.
mode	FORTRAN 77: INTEGER8 Fortran 90:* INTEGER(KIND=8), INTENT(IN) C: const MKL_INT64	Overrides global VML mode setting for this function call. See SetMode for possible values and their description.

Name

Type

Description

FORTRAN 77: INTEGER

Fortran 90: INTEGER, INTENT(IN)

C: const int

Specifies the number of elements to be calculated.

a, b

FORTRAN 77: REAL for vssub

DOUBLE PRECISION for vdsub

COMPLEX for vcsub

DOUBLE COMPLEX for vzsub

Fortran 90: REAL, INTENT(IN) for vssub

DOUBLE PRECISION, INTENT(IN) for vdsub

COMPLEX, INTENT(IN) for vcsub

DOUBLE COMPLEX, INTENT(IN) for vzsub

C: const float* for vsSub

const double* for vdSub

const MKL_Complex8* for vcSub

const MKL_Complex16* for vzSub

FORTRAN: Arrays that specify the input vectors a and b.

C: Pointers to arrays that contain the input vectors a and b.

mode

FORTRAN 77: INTEGER*8

Fortran 90: INTEGER(KIND=8), INTENT(IN)

C: const MKL_INT64

Overrides global VML mode setting for this function call. See SetMode for possible values and their description.

Output Parameters

Name	Type	Description
y	FORTRAN 77: REAL for vssub DOUBLE PRECISION for vdsub COMPLEX for vcsub DOUBLE COMPLEX for vzsub Fortran 90: REALINTENT(OUT) for vssub DOUBLE PRECISION, INTENT(OUT) for vdsub COMPLEX, INTENT(OUT) for vcsub DOUBLE COMPLEX, INTENT(OUT) for vzsub C: float* for vsSub double* for vdSub MKL_Complex8* for vcSub MKL_Complex16* for vzSub	FORTRAN: Array that specifies the output vector y. C: Pointer to an array that contains the output vector y.

Name

Type

Description

FORTRAN 77: REAL for vssub

DOUBLE PRECISION for vdsub

COMPLEX for vcsub

DOUBLE COMPLEX for vzsub

Fortran 90: REALINTENT(OUT) for vssub

DOUBLE PRECISION, INTENT(OUT) for vdsub

COMPLEX, INTENT(OUT) for vcsub

DOUBLE COMPLEX, INTENT(OUT) for vzsub

C: float* for vsSub

double* for vdSub

MKL_Complex8* for vcSub

MKL_Complex16* for vzSub

FORTRAN: Array that specifies the output vector y.

C: Pointer to an array that contains the output vector y.

Description

The v?Sub function performs element by element subtraction of vector b from vector a.

Special values for Real Function v?Sub(x)
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

Sub(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 x1, x2, y1, y2 are finite numbers, but the real or imaginary part of the exact 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 VML Error Status to VML_STATUS_OVERFLOW.