tpmv

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 12/16/2022

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-36DA02EE-7D7D-46F7-A94E-16078BC657B1

View Details

tpmv

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

Description

The tpmv routines compute a matrix-vector product with a triangular packed matrix. The operation is defined as:

where:

op(A) is one of op(A) = A, or op(A) = A^T, or op(A) = A^H
A is n x n unit or non-unit, upper or lower triangular band matrix, supplied in packed form
x is a vector of length n

tpmv supports the following precisions:

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

tpmv (Buffer Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    void tpmv(sycl::queue &queue,
              oneapi::mkl::uplo upper_lower,
              oneapi::mkl::transpose trans,
              oneapi::mkl::diag unit_diag,
              std::int64_t n,
              sycl::buffer<T,1> &a,
              sycl::buffer<T,1> &x,
              std::int64_t incx)
}

namespace oneapi::mkl::blas::row_major {
    void tpmv(sycl::queue &queue,
              oneapi::mkl::uplo upper_lower,
              oneapi::mkl::transpose trans,
              oneapi::mkl::diag unit_diag,
              std::int64_t n,
              sycl::buffer<T,1> &a,
              sycl::buffer<T,1> &x,
              std::int64_t incx)
}

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.
trans: Specifies op(A), the transposition operation applied to matrix A. See Data Types for more details.
unit_diag: Specifies whether matrix A is unit triangular or not. See Data Types for more details.
n: Number of rows and columns of matrix A. Must be at least 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.
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.

Output Parameters

x: Buffer holding updated vector x.

tpmv (USM Version)

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event tpmv(sycl::queue &queue,
                     oneapi::mkl::uplo upper_lower,
                     oneapi::mkl::transpose trans,
                     oneapi::mkl::diag unit_diag,
                     std::int64_t n,
                     const T *a,
                     T *x,
                     std::int64_t incx,
                     const std::vector<sycl::event> &dependencies = {})
}

namespace oneapi::mkl::blas::row_major {
    sycl::event tpmv(sycl::queue &queue,
                     oneapi::mkl::uplo upper_lower,
                     oneapi::mkl::transpose trans,
                     oneapi::mkl::diag unit_diag,
                     std::int64_t n,
                     const T *a,
                     T *x,
                     std::int64_t incx,
                     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.
trans: Specifies op(A), the transposition operation applied to matrix A. See Data Types for more details.
unit_diag: Specifies whether matrix A is unit triangular or not. See Data Types for more details.
n: Number of rows and columns of matrix A. Must be at least 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.
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.
dependencies: List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

x: Pointer to updated vector x.

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

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

tpmv

Description

tpmv (Buffer Version)

tpmv (USM Version)