cospi

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-A7331EB8-46D9-4C48-A81E-3E68D6BEBC4D

View Details

cospi

Computes the element-wise cosine of vector elements multiplied by pi.

Description
API
Examples

Description

The cospi(a) function computes the cosine of vector elements multiplied by . For an argument a, the function computes cos(*a).

Argument	Result	Error Code
+0	+1
-0	+1
`n` + 0.5, for any integer `n` where `n` + 0.5 is representable	+0
+	QNAN	`status::errdom`
-	QNAN	`status::errdom`
QNAN	QNAN
SNAN	QNAN

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 which 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.

API

Syntax

Buffer API

namespace oneapi::mkl::vm {

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

}

namespace oneapi::mkl::vm {

sycl::event cospi(sycl::queue & exec_queue,
      sycl::buffer<T> & a,
      oneapi::mkl::slice sa,
      sycl::buffer<T> & y,
      oneapi::mkl::slice sy,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

USM API

namespace oneapi::mkl::vm {

sycl::event cospi(sycl::queue & exec_queue,
      std::int64_t n,
      T const * 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 {

sycl::event cospi(sycl::queue & exec_queue,
      T const * a,
      oneapi::mkl::slice sa,
      T * y,
      oneapi::mkl::slice sy,
       std::vector<sycl::event> const & depends = {},
       oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
       oneapi::mkl::vm::error_handler<T> errhandler = {});

}

cospi supports the following precisions and devices:

T	Devices supported
`sycl::half`	GPU
`_Float16`	CPU
`float`	CPU and GPU
`double`	CPU and GPU

Input Parameters

Buffer API

exec_queue: The queue where the routine will be executed.
n: Specifies the number of elements to be calculated.
a: The buffer containing the input vector.
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 will be executed.
n: Specifies the number of elements to be calculated.
a: Pointer to the input vector.
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). This is an optional parameter. The default is an empty vector.
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 containing the output vector.
return value (event): Computation end event.

USM API

y: Pointer to the output vector.
return value (event): Computation end event.

Examples

An example of how to use cospi can be found in the oneMKL installation directory, under:

share/doc/mkl/examples/sycl/vml/source/vcospi.cpp

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

cospi

Description

API

Examples