powx¶
Computes vector a
to the scalar power b
.
Syntax
Buffer API:
void powx(queue& exec_queue, int64_t n, buffer<T,1>& a, T b, buffer<T,1>& y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} )
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 lib_mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> eh = {});
USM API:
event powx(queue& exec_queue, int64_t n, T* a, T b, T* y, vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} )
sycl::event powx(sycl::queue & exec_queue, T const * a, oneapi::mkl::slice sa, T b, 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, oneapi::mkl::vm::error_handler<T> eh = {});
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 |
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 powfunction.
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
Fixed value of power
b
.- 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
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
Fixed value of power
b
.- 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
.- 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
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 powxcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vpowx.cpp