Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/22/2024
Public
Document Table of Contents

v?Mul

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

Syntax

call vsmul( n, a, b, y )

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

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

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

call vdmul( n, a, b, y )

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

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

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

call vcmul( n, a, b, y )

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

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

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

call vzmul( n, a, b, y )

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

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

call vmzmuli(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 vdmul, vmdmul

COMPLEX for vcmul, vmcmul

DOUBLE COMPLEX for vzmul, vmzmul

REAL, INTENT(IN) for vsmul, vmsmul

DOUBLE PRECISION, INTENT(IN) for vdmul, vmdmul

COMPLEX, INTENT(IN) for vcmul, vmcmul

DOUBLE COMPLEX, INTENT(IN) for vzmul, vmzmul

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 vdmul, vmdmul

COMPLEX, for vcmul, vmcmul

DOUBLE COMPLEX for vzmul, vmzmul

REAL, INTENT(OUT) for vsmul, vmsmul

DOUBLE PRECISION, INTENT(OUT) for vdmul, vmdmul

COMPLEX, INTENT(OUT) for vcmul, vmcmul

DOUBLE COMPLEX, INTENT(OUT) for vzmul, vmzmul

Array that specifies the output vector y.

Description

The v?Mul function performs element by element multiplication of vector a and vector b.

Special values for Real Function v?Mul(x)
Argument 1 Argument 2 Result Exception
+0 +0 +0  
+0 -0 -0  
-0 +0 -0  
-0 -0 +0  
+0 + QNAN INVALID
+0 - QNAN INVALID
-0 + QNAN INVALID
-0 - QNAN INVALID
+ +0 QNAN INVALID
+ -0 QNAN INVALID
- +0 QNAN INVALID
- -0 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

Mul(x1+i*y1,x2+i*y2) = (x1*x2-y1*y2) + i*(x1*y2+y1*x2).

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