powx¶
Computes the element-wise exponentiation of vector a elements raised to the power of scalar b.
Description¶
The powx function computes a to the power b for a vector
a and a scalar b.
The real function powx has certain limitations on the input range of
a and b parameters. Specifically, if a[i] is positive,
then b may be arbitrary. For negative a[i], the value of
b must be an integer (either positive or negative).
The complex function powx has no input range limitations.
Special values and VM Error Status treatment are the same as for the
pow function.
API¶
Syntax¶
Buffer API
namespace oneapi::mkl::vm {
sycl::event powx(sycl::queue & exec_queue,
std::int64_t n,
sycl::buffer<T> & a,
T b,
sycl::buffer<T> & y,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event powx(sycl::queue & exec_queue,
sycl::buffer<T> & a,
oneapi::mkl::slice sa,
T b,
sycl::buffer<T> & y,
oneapi::mkl::slice sy,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
USM API
namespace oneapi::mkl::vm {
sycl::event powx(sycl::queue & exec_queue,
std::int64_t n,
T const * a,
T b,
T * y,
std::vector<cl::sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event powx(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
T b,
T * y,
oneapi::mkl::slice sy,
std::vector<cl::sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
powx supports the following precisions and devices:
T |
Devices supported |
|---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
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 input vector.
- sa
Slice selector for
a. See Data Types for a description of the oneMKL slice type.- b
Fixed value of power.
- 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.- errhandler
Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.
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 input vector.
- sa
Slice selector for
a. See Data Types for a description of the oneMKL slice type.- b
Fixed value of power.
- 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.- errhandler
Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.
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 powx can be found in the oneMKL
installation directory, under:
examples/dpcpp/vml/source/vpowx.cpp