lgamma¶
Computes the natural logarithm of the absolute value of gamma function for vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
void lgamma(queue& exec_queue,
int64_t n,
buffer<T,1>& a,
buffer<T,1>& y,
uint64_t mode = mode::not_defined,
error_handler<T> errhandler = {} )
}
sycl::event lgamma(sycl::queue & exec_queue,
sycl::buffer<T> & a,
oneapi::mkl::slice sa,
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:
namespace oneapi::mkl::vm {
event lgamma(queue& exec_queue,
int64_t n,
T* a,
T* y,
vector_class<event> const & depends = {},
uint64_t mode = mode::not_defined,
error_handler<T> errhandler = {} )
}
sycl::event lgamma(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
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 = {});
lgamma
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host and CPU |
|
Host and CPU |
Description
The lgamma(a)
function computes the natural logarithm of the absolute value of gamma function for elements of the input vector a
and writes them to the output vector y
. Precision overflow thresholds for the lgamma function are beyond the scope of this document. If the result does not meet the target precision, the function sets the VM Error Status to status::overflow
.
Argument |
Result |
Error Code |
---|---|---|
+1 |
+0 |
|
+2 |
+0 |
|
+0 |
+∞ |
|
-0 |
+∞ |
|
negative integer |
+∞ |
|
-∞ |
+∞ |
|
+∞ |
+∞ |
|
a > overflow |
+∞ |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
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 input vector of sizen
.- 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.- 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 input vector of sizen
.- 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).
- 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 lgamma
can be found in the Intel® oneMKL
installation directory, under:
examples/dpcpp/vml/source/vlgamma.cpp