Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Developer Reference

Contents

minmag

Computes the element-wise minimum of each pair of vector
a
 elements and vector
b
 elements in terms of magnitude.

Description

The
minmag(a,b)
 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 |
    a
    | < |
    b
    | minmag(a,b) returns
    a
    , otherwise minmag(a,b) returns
    b
    .
  • If |
    b
    | < |
    a
    | minmag(a,b) returns
    b
    , otherwise minmag(a,b) returns
    a
    .
  • Otherwise minmag behaves like fmin.
Argument 1
Argument 2
Result
Error Code
a
 not NAN
NAN
a
NAN
b
 not NAN
b
NAN
NAN
NAN
The
minmag(a,b)
 function does not generate any errors.

API

Syntax
Buffer API
namespace oneapi::mkl::vm {

sycl::event minmag(sycl::queue & exec_queue,
      std::int64_t n,
      sycl::buffer<T> & a,
      sycl::buffer<T> & b,
      sycl::buffer<T> & y,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}
namespace oneapi::mkl::vm {

sycl::event minmag(sycl::queue & exec_queue,
      sycl::buffer<T> & a,
      oneapi::mkl::slice sa,
      sycl::buffer<T> & b,
      oneapi::mkl::slice sb,
      sycl::buffer<T> & y,
      oneapi::mkl::slice sy,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}
USM API
namespace oneapi::mkl::vm {

sycl::event minmag(sycl::queue & exec_queue,
      std::int64_t n,
      T const * a,
      T const * b,
      T * y,
      std::vector<cl::sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}
namespace oneapi::mkl::vm {

sycl::event minmag(sycl::queue & exec_queue,
      T const * a,
      oneapi::mkl::slice sa,
      T const * b,
      oneapi::mkl::slice sb,
      T * y,
      oneapi::mkl::slice sy,
      std::vector<cl::sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}
minmag
 supports the following precisions and devices:
T
Devices supported
float
Host, CPU, and GPU
double
Host, CPU, and GPU
Input Parameters
Buffer API
exec_queue
The queue where the routine should be executed.
n
Specifies the number of elements to be calculated.
a
The buffer containing the 1st input vector.
sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.
b
The buffer containing the 2nd input vector.
sb
Slice selector for
b
. See Data Types for a description of the oneMKL slice type.
sy
Slice selector for
y
. See Data Types for a description of the oneMKL slice type.
mode
Overrides the global VM mode setting for this function call. See set_mode function for possible values and their description. This is an optional parameter. The default value is
mode::not_defined
.
USM API
exec_queue
The queue where the routine should be executed.
n
Specifies the number of elements to be calculated.
a
Pointer to the 1st input vector.
sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.
b
Pointer to the 2nd input vector.
sb
Slice selector for
b
. See Data Types for a description of the oneMKL slice type.
sy
Slice selector for
y
. See Data Types for a description of the oneMKL slice type.
depends
Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.
mode
Overrides the global VM mode setting for this function call. See the set_mode function for possible values and their description. This is an optional parameter. The default value is
mode::not_defined
.
Output Parameters
Buffer API
y
The buffer containing the output vector.
return value (event)
Computation end event.
USM API
y
Pointer to the output vector.
return value (event)
Computation end event.

Examples

An example of how to use
minmag
 can be found in the oneMKL installation directory, under:
examples/dpcpp/vml/source/vminmag.cpp

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.