tanpi

Computes the tangent of vector elements multiplied by π.

Syntax

Buffer API:

namespace oneapi::mkl::vm {

sycl::event tanpi(
        sycl::queue& exec_queue,
        std::int64_t n,
        sycl::buffer<T,1>& a,
        sycl::buffer<T,1>& y,
        oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
        oneapi::mkl::vm::error_handler<T> errhandler = {});

} // namespace oneapi::mkl::vm

USM API:

namespace oneapi::mkl::vm {

sycl::event tanpi(
        sycl::queue& exec_queue,
        std::int64_t n,
        const T *a,
        T* y,
        std::vector<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

tanpi supports the following precisions.

T
float
double

Description

The tanpi(a) function computes the tangent of vector elements multiplied by π. For an argument a, the function computes tan(π*a).

Argument	Result	Status code
+0	+0
-0	+0
n, even integer	*copysign(0.0, n)
n, odd integer	*copysign(0.0, -n)
n + 0.5, for n even integer and n + 0.5 representable	+∞
n + 0.5, for n odd integer and n + 0.5 representable	-∞
+∞	QNAN	oneapi::mkl::vm::status::errdom
-∞	QNAN	oneapi::mkl::vm::status::errdom
QNAN	QNAN
SNAN	QNAN

The copysign(x, y) function returns the first vector argument x with the sign changed to match that of the second argument y.

If arguments abs(a_i) ≤ 2 ¹³ for single precision or abs(a_i ) ≤ 2 ⁶⁷ for double precision, they belong to the fast computational path: arguments for which VM provides the best possible performance. Avoid arguments with do not belong to the fast computational path in VM High Accuracy (HA) or Low Accuracy (LA) functions. For arguments which do not belong to the fast computational path you can use VM Enhanced Performance (EP) functions, which are fast on the entire function domain. However, these functions provide lower accuracy.

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 oneapi::mkl::vm::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 oneapi::mkl::vm::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)

Event, signifying availability of computed output and status code(s).

Exceptions

For list of generated exceptions please refer to  Exceptions

Parent topic: VM Mathematical Functions