Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 7/13/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

v?Fmax

Returns the larger of each pair of elements of the two vector arguments.

Syntax

vsFmax (n, a, b, y);

vsFmaxI(n, a, inca, b, incb, y, incy);

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

vmsFmaxI(n, a, inca, b, incb, y, incy, mode);

vdFmax (n, a, b, y);

vdFmaxI(n, a, inca, b, incb, y, incy);

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

vmdFmaxI(n, a, inca, b, incb, y, incy, mode);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

n

const MKL_INT

Specifies the number of elements to be calculated.

a, b

const float* for vsFmax

const float* for vmsFmax

const double* for vdFmax

const double* for vmdFmax

Pointers to the arrays containing the input vectors a and b.

inca, incb, incy

const MKL_INT

Specifies increments for the elements of a, b, and y.

mode

const MKL_INT64

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

Output Parameters

Name

Type

Description

y

float* for vsFmax

float* for vmsFmax

double* for vdFmax

double* for vmdFmax

Pointer to an array containing the output vector y.

Description

The v?Fmax function returns a vector with element values equal to the larger value from each pair of corresponding elements of the two vectors a and b: if ai < biv?Fmax returns bi, otherwise v?Fmax returns ai.

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