sqrt
Computes the element-wise square root of vector elements.
Description
The
sqrt
function computes a square root of vector elements.Argument | Result | VM Error Status |
|---|---|---|
a< +0 | QNAN | status::errdom |
+0 | +0 | |
-0 | -0 | |
 | QNAN | status::errdom |
 | | |
QNAN | QNAN | |
SNAN | QNAN |
+i·  | +  infty` | + infty` | + infty` | + infty` | + infty` | + infty` | + infty` |
+i·Y | +0+i· |  | |||||
+i·0 | +0+i· | +0+i·0 | +0+i·0 | | |||
-i·0 | +0-i· | +0-i·0 | +0-i·0 | + -i·0 | |||
-i·Y | +0-i· | + -i·0 | |||||
-i· | + -i· | + -i· | + -i· | + -i· | + -i· | + -i· | + -i· |
+i·NAN |
Sqrt(CONJ(z))=CONJ(Sqrt(z))
. API
Syntax
Buffer API
namespace oneapi::mkl::vm {
sycl::event sqrt(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 sqrt(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 sqrt(sycl::queue & exec_queue,
std::int64_t n,
T const * a,
T * y,
std::vector<cl::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 sqrt(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
T * y,
oneapi::mkl::slice sy,
std::vector<cl::sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}sqrt
supports the following precisions and devices:T | Devices supported |
|---|---|
float | Host, CPU, and GPU |
double | Host, CPU, and GPU |
std::complex<float> | Host |
std::complex<double> | Host |
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 containing the input vector.
- sa
- Slice selector fora. See Data Types for a description of the oneMKL slice type.
- sy
- Slice selector fory. 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 ismode::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 to the input vector.
- sa
- Slice selector fora. See Data Types for a description of the oneMKL slice type.
- sy
- Slice selector fory. 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 ismode::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
sqrt
can be found in the oneMKL
installation directory, under:examples/dpcpp/vml/source/vsqrt.cpp