This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipblaszgetrs Interface Reference

hipblaszgetrs Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszgetrs Interface Reference
hipfort_hipblas::hipblaszgetrs Interface Reference

SOLVER API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszgetrs_ (handle, trans, n, nrhs, A, lda, ipiv, B, ldb, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrs_full_rank (handle, trans, n, nrhs, A, lda, ipiv, B, ldb, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrs_rank_0 (handle, trans, n, nrhs, A, lda, ipiv, B, ldb, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgetrs_rank_1 (handle, trans, n, nrhs, A, lda, ipiv, B, ldb, myInfo)
 

Detailed Description

SOLVER API.

getrs solves a system of n linear equations on n variables in its factorized form.

It solves one of the following systems, depending on the value of trans:

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

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

Parameters
[in]handlehipblasHandle_t.
[in]transhipblasOperation_t.
Specifies the form of the system of equations.
[in]nint. n >= 0.
The order of the system, i.e. the number of columns and rows of A.
[in]nrhsint. nrhs >= 0.
The number of right hand sides, i.e., the number of columns of the matrix B.
[in]Apointer 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]ldaint. lda >= n.
The leading dimension of A.
[in]ipivpointer to int. Array on the GPU of dimension n.
The pivot indices returned by hipblasSgetrf "getrf".
[in,out]Bpointer 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]ldbint. ldb >= n.
The leading dimension of B.
[out]infopointer to a int on the host.
If info = 0, successful exit. If info = j < 0, the j-th argument is invalid.

Member Function/Subroutine Documentation

◆ hipblaszgetrs_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrs::hipblaszgetrs_ ( 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 
)

◆ hipblaszgetrs_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrs::hipblaszgetrs_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
complex(c_double_complex), dimension(:,:), target  B,
integer(c_int)  ldb,
type(c_ptr)  myInfo 
)

◆ hipblaszgetrs_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrs::hipblaszgetrs_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
complex(c_double_complex), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
complex(c_double_complex), target  B,
integer(c_int)  ldb,
type(c_ptr)  myInfo 
)

◆ hipblaszgetrs_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgetrs::hipblaszgetrs_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  n,
integer(c_int)  nrhs,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
complex(c_double_complex), dimension(:), target  B,
integer(c_int)  ldb,
type(c_ptr)  myInfo 
)

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