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

Returns the element with the larger magnitude between each pair of elements of the two vector arguments.

Syntax

call vsmaxmag (n, a, b, y)

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

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

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

call vdmaxmag (n, a, b, y)

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

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

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

Include Files

  • mkl_vml.f90

Input Parameters

Name

Type

Description

n

INTEGER

Specifies the number of elements to be calculated.

a, b

REAL for vsmaxmag

REAL for vmsmaxmag

DOUBLE PRECISION for vdmaxmag

DOUBLE PRECISION for vmdmaxmag

Pointers to the arrays containing 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)

Overrides the global VM mode setting for this function call. See vmlSetMode for possible values and their description.

Output Parameters

Name

Type

Description

y

REAL for vsmaxmag

REAL for vmsmaxmag

DOUBLE PRECISION for vdmaxmag

DOUBLE PRECISION for vmdmaxmagjjssd

Pointer to an array containing the output vector y.

Description

The v?MaxMag function returns a vector with element values equal to the element with the larger magnitude from each pair of corresponding elements of the two vectors a and b:

  • If |ai| > |bi| v?MaxMag returns ai, otherwise v?MaxMag returns ai.

  • If |bi| > |ai| v?MaxMag returns bi, otherwise v?MaxMag returns ai.

  • Otherwise v?MaxMag behaves like v?Fmax.

Special values for Real Function v?MaxMag(x, y)
Argument 1 Argument 2 Result VM Error Status Exception
ai not NAN NAN ai    
NAN bi not NAN bi    
NAN NAN NAN    

See Also