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

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

Syntax

call vcmulbyconj( n, a, b, y )

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

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

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

call vzmulbyconj( n, a, b, y )

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

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

call vmdmulbyconji(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 COMPLEX for vzmulbyconj, vmzmulbyconj

COMPLEX, INTENT(IN) for vcmulbyconj, vmcmulbyconj

DOUBLE COMPLEX, INTENT(IN) for vzmulbyconj, vmzmulbyconj

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 COMPLEX for vzmulbyconj, vmzmulbyconj

COMPLEX, INTENT(OUT) for vcmulbyconj, vmcmulbyconj

DOUBLE COMPLEX, INTENT(OUT) for vzmulbyconj, vmzmulbyconj

Array that specifies the output vector y.

Description

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

Specifications for special values of the functions are found according to the formula

MulByConj(x1+i*y1,x2+i*y2) = Mul(x1+i*y1,x2-i*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).