syr2 (USM Version)¶
Computes a rank-2 update of a symmetric matrix.
Description¶
The syr2
routines compute two scalar-vector-vector product add them
and add the result to a matrix, with a symmetric matrix. The
operation is defined as
where:
alpha
is a scalar,A
is ann
-by-n
symmetric matrix,x
andy
are vectors of lengthn
.
API¶
Syntax¶
event syr2(queue &exec_queue,
uplo upper_lower,
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 syr2
supports the following precisions and devices.
T |
Devices Supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Input Parameters¶
- exec_queue
The queue where the routine should be executed.
- upper_lower
Specifies whether
A
is upper or lower triangular. See Data Types for more details.- n
Number of columns of
A
. Must be at least zero.- alpha
Scaling factor for the matrix-vector product.
- x
Pointer to input vector
x
. The array holding input vectorx
must be of size at least (1 + (n
- 1)*abs(incx
)). See Matrix and Vector Storage for more details.- incx
Stride of vector
x
.- y
Pointer to input/output vector
y
. The array holding 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
Pointer to input matrix
A
. The array holding input matrixA
must have size at leastlda
*n
. See Matrix and Vector Storage for more details.- lda
Leading dimension of matrix
A
. Must be at leastn
, and positive.- 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 upper triangularpart of the symmetric matrix
A
ifupper_lower =upper
, or the updated lower triangular part of thesymmetric matrixA
ifupper_lower =lower
.
Return Values¶
Output event to wait on to ensure computation is complete.