Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.10
  • 10/21/2020
  • Public Content
Contents

v?MaxMag

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

Syntax

vsMaxMag
(
n
,
a
,
b
,
y
);
vsMaxMagI(n, a, inca, b, incb, y, incy);
vmsMaxMag
(
n
,
a
,
b
,
y
,
mode
);
vmsMaxMagI(n, a, inca, b, incb, y, incy, mode);
vdMaxMag
(
n
,
a
,
b
,
y
);
vdMaxMagI(n, a, inca, b, incb, y, incy);
vmdMaxMag
(
n
,
a
,
b
,
y
,
mode
);
vmdMaxMagI(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
vsMaxMag
const float*
 for
vmsMaxMag
const double*
 for
vdMaxMag
const double*
 for
vmdMaxMag
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
vsMaxMag
float*
 for
vmsMaxMag
double*
 for
vdMaxMag
double*
 for
vmdMaxMag
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 |
    a
    i
    | > |
    b
    i
    |
    v?MaxMag
     returns
    a
    i
    , otherwise
    v?MaxMag
     returns
    a
    i
    .
  • If |
    b
    i
    | > |
    a
    i
    |
    v?MaxMag
     returns
    b
    i
    , otherwise
    v?MaxMag
     returns
    a
    i
    .
  • 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
a
i
 not NAN
NAN
a
i
NAN
b
i
 not NAN
b
i
NAN
NAN
NAN

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804