hipsparsesbsrsv2_buffersizeext Interface Reference

hipsparsesbsrsv2_buffersizeext Interface Reference#

HIPFORT API Reference: hipfort_hipsparse::hipsparsesbsrsv2_buffersizeext Interface Reference

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

integer(kind(hipsparse_status_success)) function	hipsparsesbsrsv2_buffersizeext_rank_0 (handle, dira, transa, mb, nnzb, descra, bsrsortedvala, bsrsortedrowptra, bsrsortedcolinda, blockdim, myinfo, pbuffersizeinbytes)

integer(kind(hipsparse_status_success)) function	hipsparsesbsrsv2_buffersizeext_rank_1 (handle, dira, transa, mb, nnzb, descra, bsrsortedvala, bsrsortedrowptra, bsrsortedcolinda, blockdim, myinfo, pbuffersizeinbytes)

Detailed Description

hipsparseXbsrsv2_bufferSizeExt returns the size of the temporary storage buffer in bytes that is required by hipsparseSbsrsv2_analysis "hipsparseXbsrsv2_analysis()" and hipsparseSbsrsv2_solve "hipsparseXbsrsv2_solve()". The temporary storage buffer must be allocated by the user.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	dirA	- matrix storage of BSR blocks.
[in]	transA	- matrix operation type.
[in]	mb	- number of block rows of the sparse BSR matrix.
[in]	nnzb	- number of non-zero blocks of the sparse BSR matrix.
[in]	descrA	- descriptor of the sparse BSR matrix.
[in]	bsrSortedValA	- array of `nnzb` blocks 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 `nnz` containing the block column indices of the sparse BSR matrix.
[in]	blockDim	- block dimension of the sparse BSR matrix.
[out]	myInfo	- structure that holds the information collected during the analysis step.
[out]	pBufferSizeInBytes	- number of bytes of the temporary storage buffer required by `hipsparseSbsrsv2_analysis` "hipsparseXbsrsv2_analysis()" and `hipsparseSbsrsv2_solve` "hipsparseXbsrsv2_solve()".

Return values

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

Member Function/Subroutine Documentation

◆ hipsparsesbsrsv2_buffersizeext_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrsv2_buffersizeext::hipsparsesbsrsv2_buffersizeext_	(	type(c_ptr), value	handle,
		integer(kind(hipsparse_direction_row)), value	dira,
		integer(kind(hipsparse_operation_non_transpose)), value	transa,
		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_size_t)	pbuffersizeinbytes
	)

◆ hipsparsesbsrsv2_buffersizeext_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrsv2_buffersizeext::hipsparsesbsrsv2_buffersizeext_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipsparse_direction_row))	dira,
		integer(kind(hipsparse_operation_non_transpose))	transa,
		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_size_t)	pbuffersizeinbytes
	)

◆ hipsparsesbsrsv2_buffersizeext_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesbsrsv2_buffersizeext::hipsparsesbsrsv2_buffersizeext_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipsparse_direction_row))	dira,
		integer(kind(hipsparse_operation_non_transpose))	transa,
		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_size_t)	pbuffersizeinbytes
	)

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

hipfort_hipsparse.F90