hpmv

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 11/07/2023

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-4AE04888-FF65-4AFF-8FB6-2FBEA6E5A4C1

View Details

hpmv

Computes a matrix-vector product using a hermitian packed matrix.

Description

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

where:

alpha and beta are scalars
A is n x n hermitian matrix supplied in packed form
x and y are vectors of length n

hpmv supports the following precisions:

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

hpmv (Buffer Version)

Syntax

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

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

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.

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 need not be set and are assumed to be zero.

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.

beta

Scaling factor for vector y. If beta = 0, vector y does not need to be initialized before calling hpmv.

y

Buffer holding input/output vector y. Size of the buffer must be at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.

incy

Stride of vector y. Must not be zero.

Output Parameters

y: Buffer holding updated vector y.

hpmv (USM Version)

Syntax

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

namespace oneapi::mkl::blas::row_major {
    sycl::event hpmv(sycl::queue &queue,
                     oneapi::mkl::uplo upper_lower,
                     std::int64_t n,
                     oneapi::mkl::value_or_pointer<T> alpha,
                     const T *a,
                     const T *x,
                     std::int64_t incx,
                     oneapi::mkl::value_or_pointer<T> beta,
                     T *y,
                     std::int64_t incy,
                     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.

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 need not be set and are assumed to be zero.

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.

beta

Scaling factor for vector y. If beta = 0, vector y does not need to be initialized before calling hpmv. See Scalar Arguments for more information on the value_or_pointer data type.

y

Pointer to input/output vector y. Size of the array holding input/output vector y must be at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.

incy

Stride of vector y. Must not be zero.

dependencies

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

Output Parameters

y: Pointer to updated vector y.

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

hpmv

Description

hpmv (Buffer Version)

hpmv (USM Version)