gerc

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 11/07/2023

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-C4E5E40D-7873-4DA5-ACEC-C7576EDEEFD3

View Details

gerc

Computes a rank-1 update (conjugated) of a general complex matrix.

Description

The gerc routines compute a scalar-vector-vector product and add the result to a general matrix. The operation is defined as:

where:

alpha is a scalar
A is m x n matrix
x is a vector of length m
y is vector of length n

gerc supports the following precisions:

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

gerc (Buffer Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    void gerc(sycl::queue &queue,
              std::int64_t m,
              std::int64_t n,
              T alpha,
              sycl::buffer<T,1> &x,
              std::int64_t incx,
              sycl::buffer<T,1> &y,
              std::int64_t incy,
              sycl::buffer<T,1> &a,
              std::int64_t lda)
}

namespace oneapi::mkl::blas::row_major {
    void gerc(sycl::queue &queue,
              std::int64_t m,
              std::int64_t n,
              T alpha,
              sycl::buffer<T,1> &x,
              std::int64_t incx,
              sycl::buffer<T,1> &y,
              std::int64_t incy,
              sycl::buffer<T,1> &a,
              std::int64_t lda)
}

Input Parameters

queue: The queue where the routine should be executed.
m: Number of rows of matrix A. Must be at least zero.
n: Number of columns of matrix A. Must be at least zero.
alpha: Scaling factor for the matrix-vector product.
x: Buffer holding input vector x. Size of the buffer must be at least (1 + (m - 1)*abs(incx)). See Matrix Storage for more details.
incx: Stride of vector x. Must not be zero.
y: Buffer holding input/output vector y. Size of the buffer must be at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.
incy: Stride of vector y. Must not be zero.
a: Buffer holding input matrix A. Size of the buffer must be at least lda * n if column major layout is used, or at least lda * m if row major layout is used. See Matrix Storage for more details.
lda: Leading dimension of matrix A. Must be positive and at least m if column major layout is used or at least n if row major layout is used.

Output Parameters

a: Buffer holding updated matrix A.

gerc (USM Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event gerc(sycl::queue &queue,
                     std::int64_t m,
                     std::int64_t n,
                     oneapi::mkl::value_or_pointer<T> alpha,
                     const T *x,
                     std::int64_t incx,
                     const T *y,
                     std::int64_t incy,
                     T *a,
                     std::int64_t lda,
                     const std::vector<sycl::event> &dependencies = {})
}

namespace oneapi::mkl::blas::row_major {
    sycl::event gerc(sycl::queue &queue,
                     std::int64_t m,
                     std::int64_t n,
                     oneapi::mkl::value_or_pointer<T> alpha,
                     const T *x,
                     std::int64_t incx,
                     const T *y,
                     std::int64_t incy,
                     T *a,
                     std::int64_t lda,
                     const std::vector<sycl::event> &dependencies = {})
}

Input Parameters

queue: The queue where the routine should be executed.
m: Number of rows of matrix A. Must be at least zero.
n: Number of columns of matrix A. Must be at least zero.
alpha: Scaling factor for the matrix-vector product. See Scalar Arguments for more information on the value_or_pointer data type.
x: Pointer to input vector x. Size of the array holding input vector x must be at least (1 + (m - 1)*abs(incx)). See Matrix Storage for more details.
incx: Stride of vector x. Must not be zero.
y: Pointer to input/output vector y. Size of the array holding input/output vector y must be at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.
incy: Stride of vector y. Must not be zero.
a: Pointer to input matrix A. Size of the array must be at least lda * n if column major layout is used, or at least lda * m if row major layout is used.
lda: Leading dimension of matrix A. Must be positive and at least m if column major layout is used or at least n if row major layout is used.
dependencies: List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

a: Pointer to updated matrix A.

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

gerc

Description

gerc (Buffer Version)

gerc (USM Version)