Contents

her

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:

\[A \leftarrow alpha*x*x^H + A\]

where:

alpha is scalar,

A is an n-by-n Hermitian matrix,

x is a vector of length n.

her supports the following precisions.

T

std::complex<float>

std::complex<double>

her (Buffer Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    void her(sycl::queue &queue,
             onemkl::uplo upper_lower,
             std::int64_t n,
             T alpha,
             sycl::buffer<T,1> &x,
             std::int64_t incx,
             sycl::buffer<T,1> &a,
             std::int64_t lda)
}

namespace oneapi::mkl::blas::row_major {
    void her(sycl::queue &queue,
             onemkl::uplo upper_lower,
             std::int64_t n,
             T alpha,
             sycl::buffer<T,1> &x,
             std::int64_t incx,
             sycl::buffer<T,1> &a,
             std::int64_t lda)
}

Input Parameters

queue

The queue where the routine should be executed.

upper_lower

Specifies whether A is upper or lower triangular. See oneMKL defined datatypes 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

Buffer holding input vector x. The buffer must be of size at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.

incx

Stride of vector x.

a

Buffer holding input matrix A. Must have size at least lda*n. See Matrix Storage for more details.

lda

Leading dimension of matrix A. Must be at least n, and positive.

Output Parameters

a

Buffer holding the updated upper triangular part of the Hermitian matrix A if upper_lower = upper or the updated lower triangular part of the Hermitian matrix A if upper_lower=lower.

The imaginary parts of the diagonal elements are set to zero.

Throws

This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.

oneapi::mkl::invalid_argument

oneapi::mkl::unsupported_device

oneapi::mkl::host_bad_alloc

oneapi::mkl::device_bad_alloc

oneapi::mkl::unimplemented

her (USM Version)

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 sycl::vector_class<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 sycl::vector_class<sycl::event> &dependencies = {})
}

Input Parameters

queue

The queue where the routine should be executed.

upper_lower

Specifies whether A is upper or lower triangular. See oneMKL defined datatypes 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 vector x 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 matrix A must have size at least lda*n. See Matrix Storage for more details.

lda

Leading dimension of matrix A. Must be at least n, 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 the Hermitian matrix A if upper_lower=upper or the updated lower triangular part of the Hermitian matrix A if upper_lower=lower.

The imaginary parts of the diagonal elements are set to zero.

Return Values

Output event to wait on to ensure computation is complete.

Throws

This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.

oneapi::mkl::invalid_argument

oneapi::mkl::unsupported_device

oneapi::mkl::host_bad_alloc

oneapi::mkl::device_bad_alloc

oneapi::mkl::unimplemented

Parent topic: BLAS Level 2 Routines

hemv her2