Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/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?MinMag

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

Syntax

vsMinMag (n, a, b, y);

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

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

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

vdMinMag (n, a, b, y);

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

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

vmdMinMagI(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 vsMinMag

const float* for vmsMinMag

const double* for vdMinMag

const double* for vmdMinMag

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 vsMinMag

float* for vmsMinMag

double* for vdMinMag

double* for vmdMinMag

Pointer to an array containing the output vector y.

Description

The v?MinMag function returns a vector with element values equal to the element with the smaller 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?Fmin.

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