expm1

Computes an exponential of vector elements decreased by 1.

Syntax

Buffer API:

void expm1(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 expm1(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 = {})

expm1 supports the following precisions and devices:

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

Description

The expm1(a) function computes an exponential of vector elements decreased by 1.

Argument

Result

Error Code

+0

+1

-0

+1

a > overflow

+∞

status::overflow

+∞

+∞

-∞

-0

QNAN

QNAN

SNAN

QNAN

Data Type

Threshold Limitations on Input Parameters

single precision

a[i] < Log( FLT_MAX )

double precision

a[i] < Log( DBL_MAX )

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 size n.

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 size n.

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 size n.

USM API:

y

Pointer y to the output vector of size n.

return value (event)

Function end event.

Example

An example of how to use expm1can be found in the Intel® oneMKL installation directory, under:

examples/sycl/vml/vexpm1.cpp