rot (USM Version)

Performs rotation of points in the plane.

Description

Given two vectors x and y of n elements, the rot routines compute four scalar-vector products and update the input vectors with the sum of two of these scalar-vector products as follow:

\[x_i = c*x_i + s*y_i\]
\[y_i = c*y_i - s*x_i\]

API

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event rot(sycl::queue &queue,
                    std::int64_t n,
                    T *x,
                    std::int64_t incx,
                    T *y,
                    std::int64_t incy,
                    T_scalar c,
                    T_scalar s,
                    const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
    sycl::event rot(sycl::queue &queue,
                    std::int64_t n,
                    T *x,
                    std::int64_t incx,
                    T *y,
                    std::int64_t incy,
                    T_scalar c,
                    T_scalar s,
                    const std::vector<sycl::event> &dependencies = {})
}

The USM version of rot supports the following precisions and devices.

T

T_scalar

Devices Supported

float

float

Host, CPU, and GPU

double

double

Host, CPU, and GPU

std::complex<float>

float

Host, CPU, and GPU

std::complex<double>

double

Host, CPU, and GPU

Input Parameters

exec_queue

The queue where the routine should be executed.

n

Number of elements in vector x.

x

Pointer to input vector x. The array holding input vector x must be of size at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.

incx

Stride of vector x.

y

Pointer to input vector y. The array holding input vector y must be of size at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.

incy

Stride of vector y.

c

Scaling factor.

s

Scaling factor.

dependencies

List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

x

Pointer to the updated matrix x.

y

Pointer to the updated matrix y.

Return Values

Output event to wait on to ensure computation is complete.