hipsparsescsr2hyb Interface Reference

• hipfort_hipsparse
• hipsparsescsr2hyb

Public Member Functions | List of all members

hipfort_hipsparse::hipsparsescsr2hyb Interface Reference

Convert a sparse CSR matrix into a sparse HYB matrix. More...

Public Member Functions
integer(kind(hipsparse_status_success)) function	hipsparsescsr2hyb_ (handle, m, n, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, hyba, userellwidth, partitiontype)
integer(kind(hipsparse_status_success)) function	hipsparsescsr2hyb_rank_0 (handle, m, n, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, hyba, userellwidth, partitiontype)
integer(kind(hipsparse_status_success)) function	hipsparsescsr2hyb_rank_1 (handle, m, n, descra, csrsortedvala, csrsortedrowptra, csrsortedcolinda, hyba, userellwidth, partitiontype)

Detailed Description

Convert a sparse CSR matrix into a sparse HYB matrix.

hipsparseXcsr2hyb converts a CSR matrix into a HYB matrix. It is assumed that hyb has been initialized with hipsparseCreateHybMat().

Note

This function requires a significant amount of storage for the HYB matrix, depending on the matrix structure.

This function is non-blocking and executed asynchronously with respect to the host. It can return before the actual computation has finished.

Deprecated:

This function is deprecated when using the CUDA backend (CUDA 10.0+) and will be removed in CUDA 11.0. This deprecation does not apply to the ROCm backend.

Parameters

[in]	handle	- handle to the hipSPARSE library context queue.
[in]	m	- number of rows of the sparse CSR matrix, which must be non-negative.
[in]	n	- number of columns of the sparse CSR matrix, which must be non-negative.
[in]	descrA	- descriptor of the sparse CSR matrix. Currently, only HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
[in]	csrSortedValA	- array containing the values of the sparse CSR matrix.
[in]	csrSortedRowPtrA	- array of m+1 elements that point to the start of every row of the sparse CSR matrix.
[in]	csrSortedColIndA	- array containing the column indices of the sparse CSR matrix.
[out]	hybA	- sparse matrix in HYB format.
[in]	userEllWidth	- width of the ELL part of the HYB matrix (only required if partitionType == HIPSPARSE_HYB_PARTITION_USER). Must be non-negative.
[in]	partitionType	- HIPSPARSE_HYB_PARTITION_AUTO (recommended), HIPSPARSE_HYB_PARTITION_USER, or HIPSPARSE_HYB_PARTITION_MAX.

Return values

HIPSPARSE_STATUS_SUCCESS	the operation completed successfully.
HIPSPARSE_STATUS_NOT_INITIALIZED	handle is not initialized.
HIPSPARSE_STATUS_INVALID_VALUE	handle, descrA, hybA, csrSortedValA, csrSortedRowPtrA, or csrSortedColIndA is nullptr, m or n is negative, or userEllWidth or partitionType is invalid.
HIPSPARSE_STATUS_ALLOC_FAILED	the buffer for the HYB matrix could not be allocated.
HIPSPARSE_STATUS_INTERNAL_ERROR	an internal error occurred.
HIPSPARSE_STATUS_NOT_SUPPORTED	hipsparseMatrixType_t != HIPSPARSE_MATRIX_TYPE_GENERAL.

Member Function/Subroutine Documentation

◆ hipsparsescsr2hyb_()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsr2hyb::hipsparsescsr2hyb_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	n,
		type(c_ptr), value	descra,
		type(c_ptr), value	csrsortedvala,
		type(c_ptr), value	csrsortedrowptra,
		type(c_ptr), value	csrsortedcolinda,
		type(c_ptr), value	hyba,
		integer(c_int), value	userellwidth,
		integer(kind(hipsparse_hyb_partition_auto)), value	partitiontype
	)

◆ hipsparsescsr2hyb_rank_0()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsr2hyb::hipsparsescsr2hyb_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		type(c_ptr)	descra,
		real(c_float), target	csrsortedvala,
		integer(c_int), target	csrsortedrowptra,
		integer(c_int), target	csrsortedcolinda,
		type(c_ptr)	hyba,
		integer(c_int)	userellwidth,
		integer(kind(hipsparse_hyb_partition_auto))	partitiontype
	)

◆ hipsparsescsr2hyb_rank_1()

integer(kind(hipsparse_status_success)) function hipfort_hipsparse::hipsparsescsr2hyb::hipsparsescsr2hyb_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		type(c_ptr)	descra,
		real(c_float), dimension(:), target	csrsortedvala,
		integer(c_int), dimension(:), target	csrsortedrowptra,
		integer(c_int), dimension(:), target	csrsortedcolinda,
		type(c_ptr)	hyba,
		integer(c_int)	userellwidth,
		integer(kind(hipsparse_hyb_partition_auto))	partitiontype
	)

---

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

• hipfort_hipsparse.F90