rocblas_stpmv Interface Reference

rocblas_stpmv Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_stpmv Interface Reference
hipfort_rocblas::rocblas_stpmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_stpmv_ (handle, uplo, transa, diag, n, a, x, incx)
 
integer(kind(rocblas_status_success)) function rocblas_stpmv_rank_0 (handle, uplo, transa, diag, n, a, x, incx)
 
integer(kind(rocblas_status_success)) function rocblas_stpmv_rank_1 (handle, uplo, transa, diag, n, a, 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 or
x = A**H*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.

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]uplo- [rocblas_fill]
  • rocblas_fill_upper: A is an upper triangular matrix.
  • rocblas_fill_lower: A is a lower triangular matrix.
[in]transA- [rocblas_operation]
  • rocblas_operation_none: op(A) = A.
  • rocblas_operation_transpose: op(A) = A^T
  • rocblas_operation_conjugate_transpose: op(A) = A^H
[in]diag- [rocblas_diagonal]
  • rocblas_diagonal_unit: A is assumed to be unit triangular.
  • rocblas_diagonal_non_unit: A is not assumed to be unit triangular.
[in]n- [rocblas_int] n specifies the number of rows of A. n >= 0.
[in]A- device pointer storing matrix A, of dimension at leat ( n * ( n + 1 ) / 2 ).
  • Before entry with uplo = rocblas_fill_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 = rocblas_fill_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 = rocblas_diagonal_unit, the diagonal elements of A are not referenced, but are assumed to be unity.

[in,out]x- device pointer storing vector x. On exit, x is overwritten with the transformed vector x.
[in]incx- [rocblas_int] specifies the increment for the elements of x. incx must not be zero.

Member Function/Subroutine Documentation

◆ rocblas_stpmv_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_stpmv::rocblas_stpmv_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(kind(rocblas_operation_none)), value  transa,
integer(kind(rocblas_diagonal_non_unit)), value  diag,
integer(c_int), value  n,
type(c_ptr), value  a,
type(c_ptr), value  x,
integer(c_int), value  incx 
)

◆ rocblas_stpmv_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_stpmv::rocblas_stpmv_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transa,
integer(kind(rocblas_diagonal_non_unit))  diag,
integer(c_int)  n,
real(c_float), target  a,
real(c_float), target  x,
integer(c_int)  incx 
)

◆ rocblas_stpmv_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_stpmv::rocblas_stpmv_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transa,
integer(kind(rocblas_diagonal_non_unit))  diag,
integer(c_int)  n,
real(c_float), dimension(:), target  a,
real(c_float), dimension(:), target  x,
integer(c_int)  incx 
)

The documentation for this interface was generated from the following file: