hpr

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/2024

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-B43FCBB6-1771-4B83-B1EB-BA11773066E7

View Details

hpr

Computes a rank-1 update of a hermitian packed matrix.

Description

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

where:

alpha is scalar
A is n x n hermitian matrix, supplied in packed form
x is a vector of length n

hpr supports the following precisions:

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

hpr (Buffer Version)

Syntax

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

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

Input Parameters

queue

The queue where the routine should be executed.

upper_lower

Specifies whether matrix A is upper or lower triangular. See Data Types for more details.

n

Number of rows and 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 + (n - 1)*abs(incx)). See Matrix Storage for more details.

incx

Stride of vector x. Must not be zero.

a

Buffer holding input matrix A. Size of the buffer must be at least (n*(n-1))/2. See Matrix Storage for more details.

The imaginary parts of the diagonal elements do not need to be set and are assumed to be zero.

Output Parameters

a

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

If alpha is zero, A matrix is unchanged, otherwise imaginary parts of the diagonal elements are set to zero.

hpr (USM Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event hpr(sycl::queue &queue,
                    oneapi::mkl::uplo upper_lower,
                    std::int64_t n,
                    oneapi::mkl::value_or_pointer<Treal> alpha,
                    const T *x,
                    std::int64_t incx,
                    T *a,
                    const std::vector<sycl::event> &dependencies = {})
}

namespace oneapi::mkl::blas::row_major {
    sycl::event hpr(sycl::queue &queue,
                    oneapi::mkl::uplo upper_lower,
                    std::int64_t n,
                    oneapi::mkl::value_or_pointer<Treal> alpha,
                    const T *x,
                    std::int64_t incx,
                    T *a,
                    const std::vector<sycl::event> &dependencies = {})
}

Input Parameters

queue

The queue where the routine should be executed.

upper_lower

Specifies whether matrix A is upper or lower triangular. See Data Types for more details.

n

Number of rows and 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 + (n - 1)*abs(incx)). See Matrix Storage for more details.

incx

Stride of vector x. Must not be zero.

a

Pointer to input matrix A. Size of the array holding input matrix A must be at least (n*(n-1))/2. See Matrix Storage for more details.

The imaginary parts of the diagonal elements do not need to be set and are assumed to be zero.

dependencies

List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

a

Pointer to updated upper triangular part of the hermitian matrix A if upper_lower=upper, or updated lower triangular part of the hermitian matrix A if upper_lower=lower.

If alpha is zero, A matrix is unchanged, otherwise imaginary parts of the diagonal elements are set to zero.

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

hpr

Description

hpr (Buffer Version)

hpr (USM Version)