hipblassgetrs Interface Reference

hipblassgetrs Interface Reference#

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

SOLVER API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassgetrs_ (handle, trans, n, nrhs, a, lda, ipiv, b, ldb, myinfo)
 
integer(kind(hipblas_status_success)) function hipblassgetrs_rank_0 (handle, trans, n, nrhs, a, lda, ipiv, b, ldb, myinfo)
 
integer(kind(hipblas_status_success)) function hipblassgetrs_rank_1 (handle, trans, n, nrhs, a, lda, ipiv, b, ldb, myinfo)
 
integer(kind(hipblas_status_success)) function hipblassgetrs_full_rank (handle, trans, n, nrhs, a, lda, ipiv, b, ldb, myinfo)
 

Detailed Description

SOLVER API.

The getrs functions solve a system of n linear equations on n variables in its factorized form.

They solve one of the following systems, depending on the value of trans:

\[ \begin{array}{cl} A X = B & \: \text{not transposed,}\\% A^T X = B & \: \text{transposed, or}\\% A^H X = B & \: \text{conjugate transposed.} \end{array} \]

Matrix A is defined by its triangular factors as returned by hipblasSgetrf "getrf".

  • Supported precisions in rocSOLVER : s, d, c, and z.
  • Supported precisions in cuBLAS : s, d, c, and z.
Parameters
[in]handle- hipblasHandle_t.
[in]trans- hipblasOperation_t. Specifies the form of the system of equations.
[in]n- int. n >= 0. The order of the system, that is, the number of columns and rows of A.
[in]nrhs- int. nrhs >= 0. The number of right hand sides, that is, the number of columns of the matrix B.
[in]A- pointer to type. Array on the GPU of dimension lda*n. The factors L and U of the factorization A = P*L*U returned by hipblasSgetrf "getrf".
[in]lda- int. lda >= n. The leading dimension of A.
[in]ipiv- pointer to int. Array on the GPU of dimension n. The pivot indices returned by hipblasSgetrf "getrf".
[in,out]B- pointer to type. Array on the GPU of dimension ldb*nrhs.
  • On entry, the right hand side matrix B.
  • On exit, the solution matrix X.
[in]ldb- int. ldb >= n. The leading dimension of B.
[out]myInfo- pointer to a int on the host.
  • If info = 0, successful exit.
  • If info = j < 0, the argument at position -j is invalid.

Member Function/Subroutine Documentation

◆ hipblassgetrs_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrs::hipblassgetrs_ ( type(c_ptr), value  handle,
integer(kind(hipblas_op_n)), value  trans,
integer(c_int), value  n,
integer(c_int), value  nrhs,
type(c_ptr), value  a,
integer(c_int), value  lda,
type(c_ptr), value  ipiv,
type(c_ptr), value  b,
integer(c_int), value  ldb,
type(c_ptr), value  myinfo 
)

◆ hipblassgetrs_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrs::hipblassgetrs_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
real(c_float), dimension(:,:), target  a,
integer(c_int)  lda,
integer(c_int), dimension(:), target  ipiv,
real(c_float), dimension(:,:), target  b,
integer(c_int)  ldb,
type(c_ptr)  myinfo 
)

◆ hipblassgetrs_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrs::hipblassgetrs_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
real(c_float), target  a,
integer(c_int)  lda,
integer(c_int), target  ipiv,
real(c_float), target  b,
integer(c_int)  ldb,
type(c_ptr)  myinfo 
)

◆ hipblassgetrs_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgetrs::hipblassgetrs_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
real(c_float), dimension(:), target  a,
integer(c_int)  lda,
integer(c_int), dimension(:), target  ipiv,
real(c_float), dimension(:), target  b,
integer(c_int)  ldb,
type(c_ptr)  myinfo 
)
The documentation for this interface was generated from the following file: