rocsparse_csritilu0_preprocess Interface Reference

• hipfort_rocsparse
• rocsparse_csritilu0_preprocess

Public Member Functions | List of all members

hipfort_rocsparse::rocsparse_csritilu0_preprocess Interface Reference

Preconditioner Functions

Public Member Functions
integer(c_int) function	rocsparse_csritilu0_preprocess_ (handle, alg, option, nmaxiter, m, nnz, csr_row_ptr, csr_col_ind, idx_base, datatype, buffer_size, buffer)
integer(kind(rocsparse_status_success)) function	rocsparse_csritilu0_preprocess_rank_0 (handle, alg, option, nmaxiter, m, nnz, csr_row_ptr, csr_col_ind, idx_base, datatype, buffer_size, buffer)
integer(kind(rocsparse_status_success)) function	rocsparse_csritilu0_preprocess_rank_1 (handle, alg, option, nmaxiter, m, nnz, csr_row_ptr, csr_col_ind, idx_base, datatype, buffer_size, buffer)

Detailed Description

rocsparse_csritilu0_preprocess computes the information required to run rocsparse_Xcsritilu0_compute() and rocsparse_Xcsritilu0_compute_ex() and stores it in the buffer.

Note

The sparse CSR matrix has to be sorted. This can be achieved by calling rocsparse_csrsort().

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]	alg	- algorithm to use, rocsparse_itilu0_alg.
[in]	option	- combination of enumeration values from rocsparse_itilu0_option.
[in]	nmaxiter	- maximum number of iterations.
[in]	m	- number of rows of the sparse CSR matrix.
[in]	nnz	- number of non-zero entries 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.
[in]	idx_base	- rocsparse_index_base_zero or rocsparse_index_base_one.
[in]	datatype	- type of numerical values, rocsparse_datatype.
[in]	buffer_size	- size of the storage buffer allocated by the user.
[in]	buffer	- 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_value	alg, base, or datatype is invalid.
rocsparse_status_invalid_size	m or nnz is invalid.
rocsparse_status_invalid_pointer	csr_row_ptr or csr_col_ind pointer is invalid.
rocsparse_status_internal_error	an internal error occurred.
rocsparse_status_zero_pivot	if a missing diagonal element is detected.

Member Function/Subroutine Documentation

◆ rocsparse_csritilu0_preprocess_()

integer(c_int) function hipfort_rocsparse::rocsparse_csritilu0_preprocess::rocsparse_csritilu0_preprocess_	(	type(c_ptr), value	handle,
		integer(c_int), value	alg,
		integer(c_int), value	option,
		integer(c_int), value	nmaxiter,
		integer(c_int), value	m,
		integer(c_int), value	nnz,
		type(c_ptr), value	csr_row_ptr,
		type(c_ptr), value	csr_col_ind,
		integer(c_int), value	idx_base,
		integer(c_int), value	datatype,
		integer(c_size_t), value	buffer_size,
		type(c_ptr), value	buffer
	)

◆ rocsparse_csritilu0_preprocess_rank_0()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_csritilu0_preprocess::rocsparse_csritilu0_preprocess_rank_0	(	type(c_ptr), value	handle,
		integer(kind(rocsparse_itilu0_alg_default))	alg,
		integer(c_int)	option,
		integer(c_int)	nmaxiter,
		integer(c_int)	m,
		integer(c_int)	nnz,
		integer(c_int), target	csr_row_ptr,
		integer(c_int), target	csr_col_ind,
		integer(kind(rocsparse_index_base_zero))	idx_base,
		integer(kind(rocsparse_datatype_f16_r))	datatype,
		integer(c_size_t)	buffer_size,
		type(c_ptr), value	buffer
	)

◆ rocsparse_csritilu0_preprocess_rank_1()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_csritilu0_preprocess::rocsparse_csritilu0_preprocess_rank_1	(	type(c_ptr), value	handle,
		integer(kind(rocsparse_itilu0_alg_default))	alg,
		integer(c_int)	option,
		integer(c_int)	nmaxiter,
		integer(c_int)	m,
		integer(c_int)	nnz,
		integer(c_int), dimension(:), target	csr_row_ptr,
		integer(c_int), dimension(:), target	csr_col_ind,
		integer(kind(rocsparse_index_base_zero))	idx_base,
		integer(kind(rocsparse_datatype_f16_r))	datatype,
		integer(c_size_t)	buffer_size,
		type(c_ptr), value	buffer
	)

---

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

• hipfort_rocsparse.F90