conj

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 10/31/2024

Version

Public

Visible to Intel only — GUID: GUID-6623F8DD-FEED-44F5-9716-2450FF98772A

View Details

conj

Computes the complex conjugate of vector elements.

Description
API
Examples

Description

The conj function performs element by element conjugation of the vector.

No special values are specified. The conj function does not generate any errors.

API

Syntax

Buffer API

namespace oneapi::mkl::vm {

sycl::event conj(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);

}

namespace oneapi::mkl::vm {

sycl::event conj(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);

}

USM API

namespace oneapi::mkl::vm {

sycl::event conj(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);

}

namespace oneapi::mkl::vm {

sycl::event conj(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);

}

conj supports the following precisions and devices:

T	Devices supported
`std::complex<float>`	CPU and GPU
`std::complex<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.

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.

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 conj can be found in the oneMKL installation directory, under:

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

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

conj

Description

API

Examples