rocsparse_sell_get Interface Reference

rocsparse_sell_get Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_sell_get Interface Reference
hipfort_rocsparse::rocsparse_sell_get Interface Reference

Get the fields of the sparse sliced ELL matrix descriptor. More...

Public Member Functions

integer(kind(rocsparse_status_success)) function rocsparse_sell_get_ (descr, rows, cols, nnz, sell_slice_size, sell_colval_size, sell_slice_offsets, sell_col_ind, sell_val, sell_slice_offsets_type, sell_col_ind_type, idx_base, data_type)
 

Detailed Description

Get the fields of the sparse sliced ELL matrix descriptor.

rocsparse_sell_get gets the fields of the sparse sliced ELL matrix descriptor.

Parameters
[in]descr- the pointer to the sparse sliced ELL matrix descriptor.
[out]rows- number of rows in the sliced ELL matrix.
[out]cols- number of columns in the sliced ELL matrix.
[out]nnz- number of non-zeros in the sliced ELL matrix.
[out]sell_slice_size- slice size in the sliced ELL matrix.
[out]sell_colval_size- actual number of elements stored in the sliced ELL matrix.
[out]sell_slice_offsets- slice offsets array in the sliced ELL matrix. Must be an array of length nslices + 1 where nslices=(rows-1)/sell_slice_size+1.
[out]sell_col_ind- column indices of the sliced ELL matrix. Must be an array of length sell_colval_size.
[out]sell_val- values of the sliced ELL matrix. Must be an array of length sell_colval_size.
[out]sell_slice_offsets_type- rocsparse_indextype_i32 or rocsparse_indextype_i64.
[out]sell_col_ind_type- rocsparse_indextype_i32 or rocsparse_indextype_i64.
[out]idx_base- rocsparse_index_base_zero or rocsparse_index_base_one.
[out]data_type- rocsparse_datatype_f32_r, rocsparse_datatype_f64_r, rocsparse_datatype_f32_c, or rocsparse_datatype_f64_c.
Return values
rocsparse_status_successthe operation completed successfully.
rocsparse_status_invalid_pointerif descr, sell_slice_offsets, sell_col_ind, or sell_val is invalid.
rocsparse_status_invalid_sizeif rows, cols, nnz, sell_colval_size, or sell_slice_size is invalid.
rocsparse_status_invalid_valueif sell_slice_offsets_type, sell_col_ind_type, idx_base, or data_type is invalid.

Member Function/Subroutine Documentation

◆ rocsparse_sell_get_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_sell_get::rocsparse_sell_get_ ( type(c_ptr), value  descr,
integer(c_int64_t)  rows,
integer(c_int64_t)  cols,
integer(c_int64_t)  nnz,
type(c_ptr), value  sell_slice_size,
type(c_ptr), value  sell_colval_size,
type(c_ptr)  sell_slice_offsets,
type(c_ptr)  sell_col_ind,
type(c_ptr)  sell_val,
type(c_ptr), value  sell_slice_offsets_type,
type(c_ptr), value  sell_col_ind_type,
type(c_ptr), value  idx_base,
type(c_ptr), value  data_type 
)

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