hipblasstbsv Interface Reference

hipblasstbsv Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasstbsv Interface Reference
hipfort_hipblas::hipblasstbsv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasstbsv_ (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
 
integer(kind(hipblas_status_success)) function hipblasstbsv_rank_0 (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
 
integer(kind(hipblas_status_success)) function hipblasstbsv_rank_1 (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
 
integer(kind(hipblas_status_success)) function hipblasstbsv_full_rank (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
 

Detailed Description

BLAS Level 2 API.

The tbsv functions solve:

 A*x = b or A**T*x = b or A**H*x = b,

where x and b are vectors and A is a banded triangular matrix.

  • 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]
  • HIPBLAS_OP_N: Solves A*x = b
  • HIPBLAS_OP_T: Solves A**T*x = b
  • HIPBLAS_OP_C: Solves A**H*x = b
[in]diag- [hipblasDiagType_t]
  • HIPBLAS_DIAG_UNIT: A is assumed to be unit triangular (that is, the diagonal elements of A are not used in computations).
  • HIPBLAS_DIAG_NON_UNIT: A is not assumed to be unit triangular.
[in]n- [int] n specifies the number of rows of b. n >= 0.
[in]k- [int]
  • if(uplo == HIPBLAS_FILL_MODE_UPPER), k specifies the number of super-diagonals of A.
  • if(uplo == HIPBLAS_FILL_MODE_LOWER), k specifies the number of sub-diagonals of A.
  • k >= 0.
[in]AP- device pointer storing the matrix A in banded format.
[in]lda- [int] specifies the leading dimension of A. lda >= (k + 1).
[in,out]x- device pointer storing input vector b. Overwritten by the output vector x.
[in]incx- [int] specifies the increment for the elements of x.

Member Function/Subroutine Documentation

◆ hipblasstbsv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbsv::hipblasstbsv_ ( 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,
integer(c_int), value  k,
type(c_ptr), value  ap,
integer(c_int), value  lda,
type(c_ptr), value  x,
integer(c_int), value  incx 
)

◆ hipblasstbsv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbsv::hipblasstbsv_full_rank ( 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,
integer(c_int)  k,
real(c_float), dimension(:,:), target  ap,
integer(c_int)  lda,
real(c_float), dimension(:), target  x,
integer(c_int)  incx 
)

◆ hipblasstbsv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbsv::hipblasstbsv_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,
integer(c_int)  k,
real(c_float), target  ap,
integer(c_int)  lda,
real(c_float), target  x,
integer(c_int)  incx 
)

◆ hipblasstbsv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbsv::hipblasstbsv_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,
integer(c_int)  k,
real(c_float), dimension(:), target  ap,
integer(c_int)  lda,
real(c_float), dimension(:), target  x,
integer(c_int)  incx 
)

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