sincos

Computes sine and cosine of vector elements.

Syntax

Buffer API:

void sincos(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &y, buffer<T, 1> &z, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {})

USM API:

event sincos(queue &exec_queue, int64_t n, T *a, T *y, T *z, vector_class<event> const &depends = {}, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {})

sincos supports the following precisions and devices:

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

Description

The sincos(a) function computes sine and cosine of vector elements.

Note that arguments abs(a[i]) 213and abs(a[i]) 216for single and double precisions respectively are called fast computational path. These are trigonometric function arguments for which VM provides the best possible performance. Avoid arguments that do not belong to the fast computational path in the VM High Accuracy (HA) and Low Accuracy (LA) functions. Alternatively, you can use VM Enhanced Performance (EP) functions that are fast on the entire function domain. However, these functions provide less accuracy.

Argument

Result 1

Result 2

Error Code

+0

+0

+1

-0

-0

+1

+∞

QNAN

QNAN

status::errdom

-∞

QNAN

QNAN

status::errdom

QNAN

QNAN

QNAN

SNAN

QNAN

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 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 sine vector of size n.

z

The buffer z containing the output cosine vector of size n.

USM API:

y

Pointer y to the output sine vector of size n.

z

The buffer z containing the output cosine vector of size n.

return value (event)

Function end event.

Example

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

examples/sycl/vml/vsincos.cpp