rocsparse_scsr2gebsr_buffer_size Interface Reference

rocsparse_scsr2gebsr_buffer_size Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_scsr2gebsr_buffer_size Interface Reference
hipfort_rocsparse::rocsparse_scsr2gebsr_buffer_size Interface Reference

Public Member Functions

integer(kind(rocsparse_status_success)) function rocsparse_scsr2gebsr_buffer_size_ (handle, dir, m, n, csr_descr, csr_val, csr_row_ptr, csr_col_ind, row_block_dim, col_block_dim, buffer_size)
 
integer(kind(rocsparse_status_success)) function rocsparse_scsr2gebsr_buffer_size_rank_0 (handle, dir, m, n, csr_descr, csr_val, csr_row_ptr, csr_col_ind, row_block_dim, col_block_dim, buffer_size)
 
integer(kind(rocsparse_status_success)) function rocsparse_scsr2gebsr_buffer_size_rank_1 (handle, dir, m, n, csr_descr, csr_val, csr_row_ptr, csr_col_ind, row_block_dim, col_block_dim, buffer_size)
 

Detailed Description

rocsparse_csr2gebsr_buffer_size returns the size of the temporary buffer that is required by rocsparse_csr2gebsr_nnz and rocsparse_Xcsr2gebsr(). The temporary storage buffer must be allocated by the user.

Note
This function is non-blocking and executed asynchronously with respect to the host. It can return before the actual computation has finished.
This routine supports execution in a hipGraph context.
Parameters
[in]handle- handle to the rocSPARSE library context queue.
[in]dir- direction that specifies whether to count non-zero elements by rocsparse_direction_row or by rocsparse_direction_column.
[in]m- number of rows of the sparse CSR matrix.
[in]n- number of columns of the sparse CSR matrix.
[in]csr_descr- descriptor of the sparse CSR matrix. Currently, only rocsparse_matrix_type_general is supported.
[in]csr_val- array of nnz elements containing the values of the sparse CSR matrix.
[in]csr_row_ptr- integer array containing m+1 elements that point to the start of each row of the CSR matrix.
[in]csr_col_ind- integer array of the column indices for each non-zero element in the CSR matrix.
[in]row_block_dim- the row block dimension of the general BSR matrix. Between 1 and m.
[in]col_block_dim- the col block dimension of the general BSR matrix. Between 1 and n.
[out]buffer_size- number of bytes of the temporary storage buffer required by rocsparse_csr2gebsr_nnz and rocsparse_Xcsr2gebsr().
Return values
rocsparse_status_successthe operation completed successfully.
rocsparse_status_invalid_handlethe library context was not initialized.
rocsparse_status_invalid_sizem, n, row_block_dim, or col_block_dim is invalid.
rocsparse_status_invalid_pointercsr_val, csr_row_ptr, csr_col_ind, or buffer_size pointer is invalid.

Member Function/Subroutine Documentation

◆ rocsparse_scsr2gebsr_buffer_size_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsr2gebsr_buffer_size::rocsparse_scsr2gebsr_buffer_size_ ( type(c_ptr), value  handle,
integer(kind(rocsparse_direction_row)), value  dir,
integer(c_int), value  m,
integer(c_int), value  n,
type(c_ptr), value  csr_descr,
type(c_ptr), value  csr_val,
type(c_ptr), value  csr_row_ptr,
type(c_ptr), value  csr_col_ind,
integer(c_int), value  row_block_dim,
integer(c_int), value  col_block_dim,
integer(c_size_t)  buffer_size 
)

◆ rocsparse_scsr2gebsr_buffer_size_rank_0()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsr2gebsr_buffer_size::rocsparse_scsr2gebsr_buffer_size_rank_0 ( type(c_ptr)  handle,
integer(kind(rocsparse_direction_row))  dir,
integer(c_int)  m,
integer(c_int)  n,
type(c_ptr)  csr_descr,
real(c_float), target  csr_val,
integer(c_int), target  csr_row_ptr,
integer(c_int), target  csr_col_ind,
integer(c_int)  row_block_dim,
integer(c_int)  col_block_dim,
integer(c_size_t)  buffer_size 
)

◆ rocsparse_scsr2gebsr_buffer_size_rank_1()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_scsr2gebsr_buffer_size::rocsparse_scsr2gebsr_buffer_size_rank_1 ( type(c_ptr)  handle,
integer(kind(rocsparse_direction_row))  dir,
integer(c_int)  m,
integer(c_int)  n,
type(c_ptr)  csr_descr,
real(c_float), dimension(:), target  csr_val,
integer(c_int), dimension(:), target  csr_row_ptr,
integer(c_int), dimension(:), target  csr_col_ind,
integer(c_int)  row_block_dim,
integer(c_int)  col_block_dim,
integer(c_size_t)  buffer_size 
)

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