hipsparsesprunecsr2csr_buffersize Interface Reference

• hipfort_hipsparse
• hipsparsesprunecsr2csr_buffersize

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsesprunecsr2csr_buffersize Interface Reference

Convert and prune a sparse CSR matrix into a sparse CSR matrix. More...

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsesprunecsr2csr_buffersize_ (handle, m, n, nnza, descra, csrvala, csrrowptra, csrcolinda, threshold, descrc, csrvalc, csrrowptrc, csrcolindc, pbuffersizeinbytes)
integer(kind(hipsparse_status_success)) function	hipsparsesprunecsr2csr_buffersize_rank_0 (handle, m, n, nnza, descra, csrvala, csrrowptra, csrcolinda, threshold, descrc, csrvalc, csrrowptrc, csrcolindc, pbuffersizeinbytes)
integer(kind(hipsparse_status_success)) function	hipsparsesprunecsr2csr_buffersize_rank_1 (handle, m, n, nnza, descra, csrvala, csrrowptra, csrcolinda, threshold, descrc, csrvalc, csrrowptrc, csrcolindc, pbuffersizeinbytes)

Detailed Description

Convert and prune a sparse CSR matrix into a sparse CSR matrix.

hipsparseXpruneCsr2csr_bufferSize returns the size of the temporary buffer that is required by hipsparseXpruneCsr2csrNnz and hipsparseXpruneCsr2csr. The temporary storage buffer must be allocated by the user.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	m	- number of rows in the sparse CSR matrix.
[in]	n	- number of columns in the sparse CSR matrix.
[in]	nnzA	- number of non-zeros in the sparse CSR matrix A.
[in]	descrA	- descriptor of the sparse CSR matrix A. Currently, only HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
[in]	csrValA	- array of nnzA elements containing the values of the sparse CSR matrix A.
[in]	csrRowPtrA	- array of m+1 elements that point to the start of every row of the sparse CSR matrix A.
[in]	csrColIndA	- array of nnzA elements containing the column indices of the sparse CSR matrix A.
[in]	threshold	- pointer to the non-negative pruning threshold, which can exist in either host or device memory.
[in]	descrC	- descriptor of the sparse CSR matrix C. Currently, only HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
[in]	csrValC	- array of nnzC elements containing the values of the sparse CSR matrix C.
[in]	csrRowPtrC	- array of m+1 elements that point to the start of every row of the sparse CSR matrix C.
[in]	csrColIndC	- array of nnzC elements containing the column indices of the sparse CSR matrix C.
[out]	pBufferSizeInBytes	- number of bytes of the temporary storage buffer required by hipsparseSpruneCsr2csrNnz(), hipsparseDpruneCsr2csrNnz(), hipsparseSpruneCsr2csr(), and hipsparseDpruneCsr2csr().

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_INVALID_VALUE	handle or pBufferSizeInBytes pointer is invalid.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.

Member Function/Subroutine Documentation

◆ hipsparsesprunecsr2csr_buffersize_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesprunecsr2csr_buffersize::hipsparsesprunecsr2csr_buffersize_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	nnza,
		type(c_ptr), value	descra,
		type(c_ptr), value	csrvala,
		type(c_ptr), value	csrrowptra,
		type(c_ptr), value	csrcolinda,
		type(c_ptr), value	threshold,
		type(c_ptr), value	descrc,
		type(c_ptr), value	csrvalc,
		type(c_ptr), value	csrrowptrc,
		type(c_ptr), value	csrcolindc,
		integer(c_size_t)	pbuffersizeinbytes
	)

◆ hipsparsesprunecsr2csr_buffersize_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesprunecsr2csr_buffersize::hipsparsesprunecsr2csr_buffersize_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnza,
		type(c_ptr)	descra,
		real(c_float), target	csrvala,
		integer(c_int), target	csrrowptra,
		integer(c_int), target	csrcolinda,
		real(c_float), target	threshold,
		type(c_ptr)	descrc,
		real(c_float), target	csrvalc,
		integer(c_int), target	csrrowptrc,
		integer(c_int), target	csrcolindc,
		integer(c_size_t)	pbuffersizeinbytes
	)

◆ hipsparsesprunecsr2csr_buffersize_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsesprunecsr2csr_buffersize::hipsparsesprunecsr2csr_buffersize_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		integer(c_int)	nnza,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	csrvala,
		integer(c_int), dimension(:), target	csrrowptra,
		integer(c_int), dimension(:), target	csrcolinda,
		real(c_float), dimension(:), target	threshold,
		type(c_ptr)	descrc,
		real(c_float), dimension(:), target	csrvalc,
		integer(c_int), dimension(:), target	csrrowptrc,
		integer(c_int), dimension(:), target	csrcolindc,
		integer(c_size_t)	pbuffersizeinbytes
	)

---

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

• hipfort_hipsparse.F90