hipblasstpmv Interface Reference

hipblasstpmv Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasstpmv Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblasstpmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasstpmv_ (handle, uplo, transa, diag, n, ap, x, incx)
 
integer(kind(hipblas_status_success)) function hipblasstpmv_rank_0 (handle, uplo, transa, diag, n, ap, x, incx)
 
integer(kind(hipblas_status_success)) function hipblasstpmv_rank_1 (handle, uplo, transa, diag, n, ap, x, incx)
 

Detailed Description

BLAS Level 2 API.

The tpmv functions perform one of the matrix-vector operations: 

 x = A*x or x = A**T*x,

where x is an n -element vector and A is an n by n unit, or non-unit, upper or lower triangular matrix, supplied in the pack form.

The vector x is overwritten.

  • Supported precisions in rocBLAS : s, d, c, and z.
  • Supported precisions in cuBLAS : s, d, c, and z.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t]
  • HIPBLAS_FILL_MODE_UPPER: A is an upper triangular matrix.
  • HIPBLAS_FILL_MODE_LOWER: A is a lower triangular matrix.
[in]transA- [hipblasOperation_t]
[in]diag- [hipblasDiagType_t]
  • HIPBLAS_DIAG_UNIT: A is assumed to be unit triangular.
  • HIPBLAS_DIAG_NON_UNIT: A is not assumed to be unit triangular.
[in]n- [int] n specifies the number of rows of A. n >= 0.
[in]AP- device pointer storing matrix A, of dimension at least ( n * ( n + 1 ) / 2 ).
  • Before entry with uplo = HIPBLAS_FILL_MODE_UPPER, the array A must contain the upper triangular matrix packed sequentially, column by column, so that A[0] contains a_{0,0}, A[1] and A[2] contain a_{0,1} and a_{1, 1} respectively, and so on.
  • Before entry with uplo = HIPBLAS_FILL_MODE_LOWER, the array A must contain the lower triangular matrix packed sequentially, column by column, so that A[0] contains a_{0,0}, A[1] and A[2] contain a_{1,0} and a_{2,0} respectively, and so on.
  • Note that when DIAG = HIPBLAS_DIAG_UNIT, the diagonal elements of A are not referenced, but are assumed to be unity.
[in]x- device pointer storing vector x.
[in]incx- [int] specifies the increment for the elements of x. incx must not be zero.

Member Function/Subroutine Documentation

◆ hipblasstpmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstpmv::hipblasstpmv_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(kind(hipblas_op_n)), value  transa,
integer(kind(hipblas_diag_non_unit)), value  diag,
integer(c_int), value  n,
type(c_ptr), value  ap,
type(c_ptr), value  x,
integer(c_int), value  incx 
)

◆ hipblasstpmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstpmv::hipblasstpmv_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transa,
integer(kind(hipblas_diag_non_unit))  diag,
integer(c_int)  n,
real(c_float), target  ap,
real(c_float), target  x,
integer(c_int)  incx 
)

◆ hipblasstpmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstpmv::hipblasstpmv_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(kind(hipblas_op_n))  transa,
integer(kind(hipblas_diag_non_unit))  diag,
integer(c_int)  n,
real(c_float), dimension(:), target  ap,
real(c_float), dimension(:), target  x,
integer(c_int)  incx 
)
The documentation for this interface was generated from the following file: