fmax
fmax#
Returns the larger of each pair of elements of the two vector arguments.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event fmax(
sycl::queue& exec_queue,
std::int64_t n,
sycl::buffer<T,1>& a,
sycl::buffer<T,1>& b,
sycl::buffer<T,1>& y,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);
} // namespace oneapi::mkl::vm
USM API:
namespace oneapi::mkl::vm {
sycl::event fmax(
sycl::queue& exec_queue,
std::int64_t n,
const T *a,
const T *b,
T* y,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);
} // namespace oneapi::mkl::vm
fmax
supports the following precisions.
T |
---|
|
|
Description
The fmax(a, b) 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 a
< b
fmax(a, b) returns b
,
otherwise fmax(a, b) returns a
.
Argument 1 |
Argument 2 |
Result |
Status code |
---|---|---|---|
|
NAN |
|
|
NAN |
|
|
|
NAN |
NAN |
NAN |
The fmax(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
.- b
The buffer
b
containing 2nd input vector of sizen
.- 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
oneapi::mkl::vm::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
.- b
Pointer
b
to the 2nd input vector of sizen
.- 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
oneapi::mkl::vm::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)
Event, signifying availability of computed output and status code(s).
Exceptions
For list of generated exceptions please refer to Exceptions
Parent topic: VM Mathematical Functions