fmin¶
Returns the smaller of each pair of elements of the two vector arguments.
Syntax
Buffer API:
namespace oneapi::mkl::vm { void fmin(queue& exec_queue, int64_t n, buffer<T,1>& a, buffer<T,1>& b, buffer<T,1>& y, uint64_t mode = mode::not_defined) }namespace oneapi::mkl::vm { sycl::event fmin(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 lib_mode = oneapi::mkl::vm::mode::not_defined); }USM API:
namespace oneapi::mkl::vm { event fmin(queue& exec_queue, int64_t n, T* a, T* b, T* y, vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined ) }namespace oneapi::mkl::vm { sycl::event fmin(sycl::queue & exec_queue, T const * a, oneapi::mkl::slice sa, T const * b, oneapi::mkl::slice sb, T * y, oneapi::mkl::slice sy, sycl::vector_class<cl::sycl::event> const & depends = {}, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined); }
fmin
supports the following precisions and devices:
T
Devices supported
float
Host, CPU, and GPU
double
Host, CPU, and GPU
Description
The fmin(a,b) function returns a vector with element values equal to the smaller value from each pair of corresponding elements of the two vectors
a
andb
: ifa
>b
fmin(a,b) returnsb
, otherwise fmin(a,b) returnsa
.
Argument 1
Argument 2
Result
Error Code
a
not NANNAN
a
NAN
b
not NAN
b
NAN
NAN
NAN
The fmin(a,b) function does not generate any errors.
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
a
containing 1st input vector of sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
The buffer
b
containing 2nd input vector of sizen
.- 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 the 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
a
to the 1st input vector of sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
Pointer
b
to the 2nd input vector of sizen
.- 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).
- 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
y
containing the output vector of sizen
.USM API:
- y
Pointer
y
to the output vector of sizen
.- return value (event)
Function end event.
Example
An example of how to use fmincan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vfmin.cpp