her (USM Version)¶
Computes a rank-1 update of a Hermitian matrix.
Description¶
The her
routines compute a scalar-vector-vector product and add the result to a Hermitian matrix. The operation is defined as
where:
alpha
is scalar,A
is ann
-by-n
Hermitian matrix,x
is a vector of lengthn
.
API¶
Syntax¶
namespace oneapi::mkl::blas::column_major {
sycl::event her(sycl::queue &queue,
onemkl::uplo upper_lower,
std::int64_t n,
T alpha,
const T *x,
std::int64_t incx,
T *a,
std::int64_t lda,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event her(sycl::queue &queue,
onemkl::uplo upper_lower,
std::int64_t n,
T alpha,
const T *x,
std::int64_t incx,
T *a,
std::int64_t lda,
const std::vector<sycl::event> &dependencies = {})
}
The USM version of her
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 rows and 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 Storage for more details.- incx
Stride of vector
x
.- a
Pointer to input matrix
A
. The array holding input matrixA
must have size at leastlda
*n
. See Matrix 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 triangular part of theHermitian matrix
A
ifupper_lower = upper
or the updated lowertriangular part of the Hermitian matrixA
ifupper_lower = lower
.The imaginary parts of the diagonal elementsare set to zero.
Return Values¶
Output event to wait on to ensure computation is complete.