hipsparsescsrsm2_analysis Interface Reference

hipsparsescsrsm2_analysis Interface Reference#

HIPFORT API Reference: hipfort_hipsparse::hipsparsescsrsm2_analysis Interface Reference

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsescsrsm2_analysis_ (handle, algo, transa, transb, m, nrhs, nnz, alpha, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, b, ldb, myinfo, policy, pbuffer)

integer(kind(hipsparse_status_success)) function	hipsparsescsrsm2_analysis_rank_0 (handle, algo, transa, transb, m, nrhs, nnz, alpha, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, b, ldb, myinfo, policy, pbuffer)

integer(kind(hipsparse_status_success)) function	hipsparsescsrsm2_analysis_rank_1 (handle, algo, transa, transb, m, nrhs, nnz, alpha, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, b, ldb, myinfo, policy, pbuffer)

integer(kind(hipsparse_status_success)) function	hipsparsescsrsm2_analysis_full_rank (handle, algo, transa, transb, m, nrhs, nnz, alpha, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, b, ldb, myinfo, policy, pbuffer)

Detailed Description

hipsparseXcsrsm2_analysis performs the analysis step for hipsparseScsrsm2_solve "hipsparseXcsrsm2_solve()". It is expected that this function will be executed only once for a given matrix and particular operation type.

Note: If the matrix sparsity pattern changes, the gathered information will become invalid.; This function is non-blocking and executed asynchronously with respect to the host. It can return before the actual computation has finished.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	algo	- algorithm to use.
[in]	transA	- matrix \(A\) operation type.
[in]	transB	- matrix \(B\) operation type.
[in]	m	- number of rows of the sparse CSR matrix \(A\).
[in]	nrhs	- number of columns of the dense matrix \(op(B)\).
[in]	nnz	- number of non-zero entries of the sparse CSR matrix \(A\).
[in]	alpha	- scalar \(\alpha\).
[in]	descrA	- descriptor of the sparse CSR matrix \(A\).
[in]	csrSortedValA	- array of `nnz` elements of the sparse CSR matrix \(A\).
[in]	csrSortedRowPtrA	- array of `m+1` elements that point to the start of every row of the sparse CSR matrix \(A\).
[in]	csrSortedColIndA	- array of `nnz` elements containing the column indices of the sparse CSR matrix \(A\).
[in]	B	- array of `m` \(\times\) `nrhs` elements of the rhs matrix \(B\).
[in]	ldb	- leading dimension of rhs matrix \(B\).
[out]	myInfo	- structure that holds the information collected during the analysis step.
[in]	policy	- `HIPSPARSE_SOLVE_POLICY_NO_LEVEL` or `HIPSPARSE_SOLVE_POLICY_USE_LEVEL`.
[in]	pBuffer	- temporary storage buffer allocated by the user.

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUE	`handle`, `m`, `nrhs`, `nnz`, `alpha`, `descrA`, `csrSortedValA`, `csrSortedRowPtrA`, `csrSortedColIndA`, `B`, `info`, or `pBuffer` is invalid.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.
HIPSPARSE_STATUS_NOT_SUPPORTED	`transA` == `HIPSPARSE_OPERATION_CONJUGATE_TRANSPOSE`, `transB` == `HIPSPARSE_OPERATION_CONJUGATE_TRANSPOSE`, or `hipsparseMatrixType_t` != `HIPSPARSE_MATRIX_TYPE_GENERAL`.

Member Function/Subroutine Documentation

◆ hipsparsescsrsm2_analysis_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrsm2_analysis::hipsparsescsrsm2_analysis_	(	type(c_ptr), value	handle,
		integer(c_int), value	algo,
		integer(kind(hipsparse_operation_non_transpose)), value	transa,
		integer(kind(hipsparse_operation_non_transpose)), value	transb,
		integer(c_int), value	m,
		integer(c_int), value	nrhs,
		integer(c_int), value	nnz,
		real(c_float)	alpha,
		type(c_ptr), value	descra,
		type(c_ptr), value	csrsortedvala,
		type(c_ptr), value	csrsortedrowptra,
		type(c_ptr), value	csrsortedcolinda,
		type(c_ptr), value	b,
		integer(c_int), value	ldb,
		type(c_ptr), value	myinfo,
		integer(kind(hipsparse_solve_policy_no_level)), value	policy,
		type(c_ptr), value	pbuffer
	)

◆ hipsparsescsrsm2_analysis_full_rank()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrsm2_analysis::hipsparsescsrsm2_analysis_full_rank	(	type(c_ptr)	handle,
		integer(c_int)	algo,
		integer(kind(hipsparse_operation_non_transpose))	transa,
		integer(kind(hipsparse_operation_non_transpose))	transb,
		integer(c_int)	m,
		integer(c_int)	nrhs,
		integer(c_int)	nnz,
		real(c_float)	alpha,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	csrsortedvala,
		integer(c_int), dimension(:), target	csrsortedrowptra,
		integer(c_int), dimension(:), target	csrsortedcolinda,
		real(c_float), dimension(:,:), target	b,
		integer(c_int)	ldb,
		type(c_ptr)	myinfo,
		integer(kind(hipsparse_solve_policy_no_level))	policy,
		type(c_ptr)	pbuffer
	)

◆ hipsparsescsrsm2_analysis_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrsm2_analysis::hipsparsescsrsm2_analysis_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	algo,
		integer(kind(hipsparse_operation_non_transpose))	transa,
		integer(kind(hipsparse_operation_non_transpose))	transb,
		integer(c_int)	m,
		integer(c_int)	nrhs,
		integer(c_int)	nnz,
		real(c_float)	alpha,
		type(c_ptr)	descra,
		real(c_float), target	csrsortedvala,
		integer(c_int), target	csrsortedrowptra,
		integer(c_int), target	csrsortedcolinda,
		real(c_float), target	b,
		integer(c_int)	ldb,
		type(c_ptr)	myinfo,
		integer(kind(hipsparse_solve_policy_no_level))	policy,
		type(c_ptr)	pbuffer
	)

◆ hipsparsescsrsm2_analysis_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrsm2_analysis::hipsparsescsrsm2_analysis_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	algo,
		integer(kind(hipsparse_operation_non_transpose))	transa,
		integer(kind(hipsparse_operation_non_transpose))	transb,
		integer(c_int)	m,
		integer(c_int)	nrhs,
		integer(c_int)	nnz,
		real(c_float)	alpha,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	csrsortedvala,
		integer(c_int), dimension(:), target	csrsortedrowptra,
		integer(c_int), dimension(:), target	csrsortedcolinda,
		real(c_float), dimension(:), target	b,
		integer(c_int)	ldb,
		type(c_ptr)	myinfo,
		integer(kind(hipsparse_solve_policy_no_level))	policy,
		type(c_ptr)	pbuffer
	)

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

hipfort_hipsparse.F90