rocsparse_scsrsv_analysis Interface Reference

• hipfort_rocsparse
• rocsparse_scsrsv_analysis

Public Member Functions | List of all members

hipfort_rocsparse::rocsparse_scsrsv_analysis Interface Reference

Public Member Functions
integer(kind(rocsparse_status_success)) function	rocsparse_scsrsv_analysis_ (handle, trans, m, nnz, descr, csr_val, csr_row_ptr, csr_col_ind, myinfo, analysis, solve, temp_buffer)
integer(kind(rocsparse_status_success)) function	rocsparse_scsrsv_analysis_rank_0 (handle, trans, m, nnz, descr, csr_val, csr_row_ptr, csr_col_ind, myinfo, analysis, solve, temp_buffer)
integer(kind(rocsparse_status_success)) function	rocsparse_scsrsv_analysis_rank_1 (handle, trans, m, nnz, descr, csr_val, csr_row_ptr, csr_col_ind, myinfo, analysis, solve, temp_buffer)

Detailed Description

rocsparse_csrsv_analysis performs the analysis step for rocsparse_Xcsrsv_solve(). It is expected that this function will be executed only once for a given matrix and particular operation type. The analysis metadata can be cleared by rocsparse_csrsv_clear().

If the matrix sparsity pattern changes, the gathered information will become invalid. To perform another sparse triangular solve with a matrix having a different sparsity pattern, either destroy the old info object and create a new one or clear the existing info object using rocsparse_csrsv_clear(). In both cases, the analysis will need to be called again.

rocsparse_csrsv_analysis can share its meta data with rocsparse_Xcsrsm_analysis(), rocsparse_Xcsrilu0_analysis(), and rocsparse_Xcsric0_analysis(). Selecting rocsparse_analysis_policy_reuse policy can greatly improve the computation performance of the metadata. However, the user needs to ensure that the sparsity pattern remains unchanged. If this cannot be assured, rocsparse_analysis_policy_force must be used.

Note

If the matrix sparsity pattern changes, the gathered information will become invalid.

This function is blocking with respect to the host.

This routine does not support execution in a hipGraph context.

Parameters

[in]	handle	- handle to the rocSPARSE library context queue.
[in]	trans	- matrix operation type.
[in]	m	- number of rows of the sparse CSR matrix.
[in]	nnz	- number of non-zero entries of the sparse CSR matrix.
[in]	descr	- descriptor of the sparse CSR matrix.
[in]	csr_val	- array of nnz elements of the sparse CSR matrix.
[in]	csr_row_ptr	- array of m+1 elements that point to the start of every row of the sparse CSR matrix.
[in]	csr_col_ind	- 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]	analysis	- rocsparse_analysis_policy_reuse or rocsparse_analysis_policy_force.
[in]	solve	- rocsparse_solve_policy_auto.
[in]	temp_buffer	- temporary storage buffer allocated by the user.

Return values

rocsparse_status_success	the operation completed successfully.
rocsparse_status_invalid_handle	the library context was not initialized.
rocsparse_status_invalid_size	m or nnz is invalid.
rocsparse_status_invalid_pointer	descr, csr_row_ptr, csr_col_ind, info, or temp_buffer pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.
rocsparse_status_not_implemented	trans == rocsparse_operation_conjugate_transpose or rocsparse_matrix_type != rocsparse_matrix_type_general.

Member Function/Subroutine Documentation

◆ rocsparse_scsrsv_analysis_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsrsv_analysis::rocsparse_scsrsv_analysis_	(	type(c_ptr), value	handle,
		integer(kind(rocsparse_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	nnz,
		type(c_ptr), value	descr,
		type(c_ptr), value	csr_val,
		type(c_ptr), value	csr_row_ptr,
		type(c_ptr), value	csr_col_ind,
		type(c_ptr), value	myinfo,
		integer(kind(rocsparse_analysis_policy_reuse)), value	analysis,
		integer(kind(rocsparse_solve_policy_auto)), value	solve,
		type(c_ptr), value	temp_buffer
	)

◆ rocsparse_scsrsv_analysis_rank_0()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsrsv_analysis::rocsparse_scsrsv_analysis_rank_0	(	type(c_ptr)	handle,
		integer(kind(rocsparse_operation_none))	trans,
		integer(c_int)	m,
		integer(c_int)	nnz,
		type(c_ptr)	descr,
		real(c_float), target	csr_val,
		integer(c_int), target	csr_row_ptr,
		integer(c_int), target	csr_col_ind,
		type(c_ptr)	myinfo,
		integer(kind(rocsparse_analysis_policy_reuse))	analysis,
		integer(kind(rocsparse_solve_policy_auto))	solve,
		type(c_ptr)	temp_buffer
	)

◆ rocsparse_scsrsv_analysis_rank_1()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsrsv_analysis::rocsparse_scsrsv_analysis_rank_1	(	type(c_ptr)	handle,
		integer(kind(rocsparse_operation_none))	trans,
		integer(c_int)	m,
		integer(c_int)	nnz,
		type(c_ptr)	descr,
		real(c_float), dimension(:), target	csr_val,
		integer(c_int), dimension(:), target	csr_row_ptr,
		integer(c_int), dimension(:), target	csr_col_ind,
		type(c_ptr)	myinfo,
		integer(kind(rocsparse_analysis_policy_reuse))	analysis,
		integer(kind(rocsparse_solve_policy_auto))	solve,
		type(c_ptr)	temp_buffer
	)

---

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

• hipfort_rocsparse.F90