tgamma¶
Computes the element-wise gamma function of vector elements.
Description¶
The tgamma(a) function computes the gamma function for elements of
the input vector a and writes them to the output vector y.
Precision overflow thresholds for the tgamma function are beyond the
scope of this document. If the result does not meet the target
precision, the function raises sets the VM Error Status to
status::sing.
Argument |
Result |
Error Code |
|---|---|---|
+0 |
+ |
|
-0 |
- |
|
negative integer |
QNAN |
|
- |
QNAN |
|
+ |
+ |
|
a > overflow |
+ |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
API¶
Syntax¶
Buffer API
namespace oneapi::mkl::vm {
sycl::event tgamma(sycl::queue & exec_queue,
std::int64_t n,
sycl::buffer<T> & a,
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 tgamma(sycl::queue & exec_queue,
sycl::buffer<T> & a,
oneapi::mkl::slice sa,
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 tgamma(sycl::queue & exec_queue,
std::int64_t n,
T const * a,
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 tgamma(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
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 = {});
}
tgamma supports the following precisions and devices:
T |
Devices supported |
|---|---|
|
Host and CPU |
|
Host and CPU |
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 more details.- sy
Slice selector for
y. See Data Types for more details.- 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.- 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 tgamma can be found in the oneMKL
installation directory, under:
examples/dpcpp/vml/source/vtgamma.cpp