hipsparsesbsrilu02_buffersize Interface Reference

• hipfort_hipsparse
• hipsparsesbsrilu02_buffersize

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsesbsrilu02_buffersize Interface Reference

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsesbsrilu02_buffersize_ (handle, dira, mb, nnzb, descra, bsrsortedvala, bsrsortedrowptra, bsrsortedcolinda, blockdim, myinfo, pbuffersizeinbytes)
integer(kind(hipsparse_status_success)) function	hipsparsesbsrilu02_buffersize_rank_0 (handle, dira, mb, nnzb, descra, bsrsortedvala, bsrsortedrowptra, bsrsortedcolinda, blockdim, myinfo, pbuffersizeinbytes)
integer(kind(hipsparse_status_success)) function	hipsparsesbsrilu02_buffersize_rank_1 (handle, dira, mb, nnzb, descra, bsrsortedvala, bsrsortedrowptra, bsrsortedcolinda, blockdim, myinfo, pbuffersizeinbytes)

Detailed Description

hipsparseXbsrilu02_bufferSize returns the size of the temporary storage buffer in bytes that is required by hipsparseSbsrilu02_analysis "hipsparseXbsrilu02_analysis()" and hipsparseSbsrilu02 "hipsparseXbsrilu02()". The temporary storage buffer must be allocated by the user.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	dirA	- direction that specifies whether to count non-zero elements by HIPSPARSE_DIRECTION_ROW or by HIPSPARSE_DIRECTION_COLUMN.
[in]	mb	- number of block rows in the sparse BSR matrix.
[in]	nnzb	- number of non-zero block entries of the sparse BSR matrix.
[in]	descrA	- descriptor of the sparse BSR matrix.
[in]	bsrSortedValA	- array of length nnzb*blockDim*blockDim containing the values of the sparse BSR matrix.
[in]	bsrSortedRowPtrA	- array of mb+1 elements that point to the start of every block row of the sparse BSR matrix.
[in]	bsrSortedColIndA	- array of nnzb elements containing the block column indices of the sparse BSR matrix.
[in]	blockDim	- the block dimension of the BSR matrix, which is between 1 and m where m=mb*blockDim.
[out]	myInfo	- structure that holds the information collected during the analysis step.
[out]	pBufferSizeInBytes	- number of bytes of the temporary storage buffer required by hipsparseSbsrilu02_analysis(), hipsparseDbsrilu02_analysis(), hipsparseCbsrilu02_analysis(), hipsparseZbsrilu02_analysis(), hipsparseSbsrilu02(), hipsparseDbsrilu02(), hipsparseCbsrilu02(), and hipsparseZbsrilu02().

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUE	handle, mb, nnzb, blockDim, descrA, bsrSortedValA, bsrSortedRowPtrA, bsrSortedColIndA, info, or pBufferSizeInBytes pointer is invalid.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.
HIPSPARSE_STATUS_NOT_SUPPORTED	hipsparseMatrixType_t != HIPSPARSE_MATRIX_TYPE_GENERAL.

Member Function/Subroutine Documentation

◆ hipsparsesbsrilu02_buffersize_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrilu02_buffersize::hipsparsesbsrilu02_buffersize_	(	type(c_ptr), value	handle,
		integer(kind(hipsparse_direction_row)), value	dira,
		integer(c_int), value	mb,
		integer(c_int), value	nnzb,
		type(c_ptr), value	descra,
		type(c_ptr), value	bsrsortedvala,
		type(c_ptr), value	bsrsortedrowptra,
		type(c_ptr), value	bsrsortedcolinda,
		integer(c_int), value	blockdim,
		type(c_ptr), value	myinfo,
		integer(c_int)	pbuffersizeinbytes
	)

◆ hipsparsesbsrilu02_buffersize_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrilu02_buffersize::hipsparsesbsrilu02_buffersize_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipsparse_direction_row))	dira,
		integer(c_int)	mb,
		integer(c_int)	nnzb,
		type(c_ptr)	descra,
		real(c_float), target	bsrsortedvala,
		integer(c_int), target	bsrsortedrowptra,
		integer(c_int), target	bsrsortedcolinda,
		integer(c_int)	blockdim,
		type(c_ptr)	myinfo,
		integer(c_int)	pbuffersizeinbytes
	)

◆ hipsparsesbsrilu02_buffersize_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrilu02_buffersize::hipsparsesbsrilu02_buffersize_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipsparse_direction_row))	dira,
		integer(c_int)	mb,
		integer(c_int)	nnzb,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	bsrsortedvala,
		integer(c_int), dimension(:), target	bsrsortedrowptra,
		integer(c_int), dimension(:), target	bsrsortedcolinda,
		integer(c_int)	blockdim,
		type(c_ptr)	myinfo,
		integer(c_int)	pbuffersizeinbytes
	)

---

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

• hipfort_hipsparse.F90