hipsparsescsrilu02_analysis Interface Reference

• hipfort_hipsparse
• hipsparsescsrilu02_analysis

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsescsrilu02_analysis Interface Reference

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsescsrilu02_analysis_ (handle, m, nnz, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, myinfo, policy, pbuffer)
integer(kind(hipsparse_status_success)) function	hipsparsescsrilu02_analysis_rank_0 (handle, m, nnz, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, myinfo, policy, pbuffer)
integer(kind(hipsparse_status_success)) function	hipsparsescsrilu02_analysis_rank_1 (handle, m, nnz, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, myinfo, policy, pbuffer)

Detailed Description

hipsparseXcsrilu02_analysis performs the analysis step for hipsparseScsrilu02 "hipsparseXcsrilu02()". 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]	m	- number of rows of the sparse CSR matrix.
[in]	nnz	- number of non-zero entries of the sparse CSR matrix.
[in]	descrA	- descriptor of the sparse CSR matrix.
[in]	csrSortedValA	- array of nnz elements of the sparse CSR matrix.
[in]	csrSortedRowPtrA	- array of m+1 elements that point to the start of every row of the sparse CSR matrix.
[in]	csrSortedColIndA	- array of nnz elements containing the column indices of the sparse CSR matrix.
[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, nnz, descrA, csrSortedValA, csrSortedRowPtrA, csrSortedColIndA, info, or pBuffer pointer is invalid.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.

Member Function/Subroutine Documentation

◆ hipsparsescsrilu02_analysis_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrilu02_analysis::hipsparsescsrilu02_analysis_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	nnz,
		type(c_ptr), value	descra,
		type(c_ptr), value	csrsortedvala,
		type(c_ptr), value	csrsortedrowptra,
		type(c_ptr), value	csrsortedcolinda,
		type(c_ptr), value	myinfo,
		integer(kind(hipsparse_solve_policy_no_level)), value	policy,
		type(c_ptr), value	pbuffer
	)

◆ hipsparsescsrilu02_analysis_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrilu02_analysis::hipsparsescsrilu02_analysis_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	nnz,
		type(c_ptr)	descra,
		real(c_float), target	csrsortedvala,
		integer(c_int), target	csrsortedrowptra,
		integer(c_int), target	csrsortedcolinda,
		type(c_ptr)	myinfo,
		integer(kind(hipsparse_solve_policy_no_level))	policy,
		type(c_ptr)	pbuffer
	)

◆ hipsparsescsrilu02_analysis_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsrilu02_analysis::hipsparsescsrilu02_analysis_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	nnz,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	csrsortedvala,
		integer(c_int), dimension(:), target	csrsortedrowptra,
		integer(c_int), dimension(:), target	csrsortedcolinda,
		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