gerc (USM Version)¶
Computes a rank-1 update (conjugated) of a general complex matrix.
Syntax
event gerc(queue &exec_queue,
std::int64_t m,
std::int64_t n,
T alpha,
const T *x,
std::int64_t incx,
const T *y,
std::int64_t incy,
T *a,
std::int64_t lda,
const vector_class<event> &dependencies = {})
The USM version of ``gerc`` supports the following precisions and
devices.
.. list-table::
:header-rows: 1
* - T
- Devices Supported
* - ``std::complex<float>``
- Host, CPU, and GPU
* - ``std::complex<double>``
- Host, CPU, and GPU
Description
The gerc routines compute a scalar-vector-vector product and add the result to a general matrix. The operation is defined as
A <- alpha*x*yH + A
where:
alpha
is a scalar,
A
is an m
-by-n
matrix,
x
is a vector of length m
,
y
is vector of length n
.
Input Parameters
- exec_queue
The queue where the routine should be executed.
- m
Number of rows of
A
. Must be at least zero.- n
Number of columns of
A
. Must be at least zero.- alpha
Scaling factor for the matrix-vector product.
- x
Pointer to the input vector
x
. The array holding input vectorx
must be of size at least (1 + (m
- 1)*abs(incx
)). See Matrix and Vector Storage for more details.- incx
Stride of vector
x
.- y
Pointer to the input/output vector
y
. The array holding the input/output vectory
must be of size at least (1 + (n
- 1)*abs(incy
)). See Matrix and Vector Storage for more details.- incy
Stride of vector
y
.- a
The array holding input matrix
A
must have size at leastlda
*n
if column major layout is used, or at leastlda
*m
if row major layout is used.- lda
Leading dimension of matrix
A
. It 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 the updated matrix A.
Return Values
Output event to wait on to ensure computation is complete.