rotg

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 7/13/2023

Version

Public

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

rotg

Computes the parameters for a Givens rotation.

Description

Given the Cartesian coordinates (a, b) of a point, the rotg routines return the parameters c, s, r, and z associated with the Givens rotation. The parameters c and s define a unitary matrix such that:

The parameter z is defined such that if |a| > |b|, z is s; otherwise if c is not 0 z is 1/c; otherwise z is 1.

rotg supports the following precisions:

T	Tc
`float`	`float`
`double`	`double`
`std::complex<float>`	`float`
`std::complex<double>`	`double`

rotg (Buffer Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    void rotg(sycl::queue &queue,
              sycl::buffer<T,1> &a,
              sycl::buffer<T,1> &b,
              sycl::buffer<Tc,1> &c,
              sycl::buffer<T,1> &s)
}

namespace oneapi::mkl::blas::row_major {
    void rotg(sycl::queue &queue,
              sycl::buffer<T,1> &a,
              sycl::buffer<T,1> &b,
              sycl::buffer<Tc,1> &c,
              sycl::buffer<T,1> &s)
}

Input Parameters

queue: The queue where the routine should be executed
a: Buffer holding x-coordinate of the point.
b: Buffer holding y-coordinate of the point.

Output Parameters

a: Buffer holding parameter r associated with the Givens rotation.
b: Buffer holding parameter z associated with the Givens rotation.
c: Buffer holding parameter c associated with the Givens rotation.
s: Buffer holding parameter s associated with the Givens rotation.

rotg (USM Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event rotg(sycl::queue &queue,
                     T *a,
                     T *b,
                     Tc *c,
                     T *s,
                     const std::vector<sycl::event> &dependencies = {})
}

namespace oneapi::mkl::blas::row_major {
    sycl::event rotg(sycl::queue &queue,
                     T *a,
                     T *b,
                     Tc *c,
                     T *s,
                     const std::vector<sycl::event> &dependencies = {})
}

Input Parameters

queue: The queue where the routine should be executed
a: Pointer to x-coordinate of the point.
b: Pointer to y-coordinate of the point.
dependencies: List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

a: Pointer to parameter r associated with the Givens rotation.
b: Pointer to parameter z associated with the Givens rotation.
c: Pointer to parameter c associated with the Givens rotation.
s: Pointer to parameter s associated with the Givens rotation.

Return Values

Output event to wait on to ensure computation is complete.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

rotg

Description

rotg (Buffer Version)

rotg (USM Version)