Computes the natural logarithm of the absolute value of gamma function for vector elements.
Buffer API:
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 = {} );
USM API:
event lgamma(queue& exec_queue, int64_t n, T* a, T* y, vector_class<event>* depends, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} );
lgamma supports the following precisions and devices:
T | Devices supported |
---|---|
float | Host and CPU |
double | Host and CPU |
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 | +∞ | status::sing |
-0 | +∞ | status::sing |
negative integer | +∞ | status::sing |
-∞ | +∞ | |
+∞ | +∞ | |
a > overflow | +∞ | status::overflow |
QNAN | QNAN | |
SNAN | QNAN |
Buffer API:
The queue where the routine should be executed.
Specifies the number of elements to be calculated.
The buffer a containing input vector of size n.
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.
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:
The queue where the routine should be executed.
Specifies the number of elements to be calculated.
Pointer a to the input vector of size n.
Vector of dependent events (to wait for input data to be ready).
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.
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.
Buffer API:
The buffer y containing the output vector of size n.
USM API:
Pointer y to the output vector of size n.
Function end event.
An example of how to use lgammacan be found in the Intel® oneMKL installation directory, under:
examples/sycl/vml/vlgamma.cpp