rocblas_ztpmv Interface Reference

rocblas_ztpmv Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_ztpmv Interface Reference
hipfort_rocblas::rocblas_ztpmv Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_ztpmv_ (handle, uplo, transA, diag, m, A, x, incx)
 
integer(kind(rocblas_status_success)) function rocblas_ztpmv_full_rank (handle, uplo, transA, diag, m, A, x, incx)
 
integer(kind(rocblas_status_success)) function rocblas_ztpmv_rank_0 (handle, uplo, transA, diag, m, A, x, incx)
 
integer(kind(rocblas_status_success)) function rocblas_ztpmv_rank_1 (handle, uplo, transA, diag, m, A, x, incx)
 

Detailed Description

!

BLAS Level 2 API

\details
tpmv performs one of the matrix-vector operations

     x = Ax or x = ATx,

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.

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.

@param[in]
uplo    [rocblas_fill]
        rocblas_fill_upper:  A is an upper triangular matrix.
        rocblas_fill_lower:  A is a  lower triangular matrix.

@param[in]
transA     [rocblas_operation]

@param[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.

@param[in]
m       [rocblas_int]
        m specifies the number of rows of A. m >= 0.

@param[in]
A       device pointer storing matrix A,
        of dimension at leat ( m  ( m + 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.

@param[in]
x       device pointer storing vector x.

@param[in]
incx    [rocblas_int]
        specifies the increment for the elements of x. incx must not be zero.

Member Function/Subroutine Documentation

◆ rocblas_ztpmv_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ztpmv::rocblas_ztpmv_ ( 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  m,
type(c_ptr), value  A,
type(c_ptr), value  x,
integer(c_int), value  incx 
)

◆ rocblas_ztpmv_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ztpmv::rocblas_ztpmv_full_rank ( 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)  m,
complex(c_double_complex), dimension(:,:), target  A,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx 
)

◆ rocblas_ztpmv_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ztpmv::rocblas_ztpmv_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)  m,
complex(c_double_complex), target  A,
complex(c_double_complex), target  x,
integer(c_int)  incx 
)

◆ rocblas_ztpmv_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ztpmv::rocblas_ztpmv_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)  m,
complex(c_double_complex), dimension(:), target  A,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx 
)

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