rocsparse_coo_get Interface Reference

rocsparse_coo_get Interface Reference#

HIPFORT API Reference: hipfort_rocsparse::rocsparse_coo_get Interface Reference
hipfort_rocsparse::rocsparse_coo_get Interface Reference

Get the fields of the sparse COO matrix descriptor. More...

Public Member Functions

integer(kind(rocsparse_status_success)) function rocsparse_coo_get_ (descr, rows, cols, nnz, coo_row_ind, coo_col_ind, coo_val, idx_type, idx_base, data_type)
 

Detailed Description

Get the fields of the sparse COO matrix descriptor.

rocsparse_coo_get gets the fields of the sparse COO matrix descriptor.

Parameters
[in]descr- the pointer to the sparse COO matrix descriptor.
[out]rows- number of rows in the sparse COO matrix.
[out]cols- number of columns in the sparse COO matrix.
[out]nnz- number of non-zeros in sparse COO matrix.
[out]coo_row_ind- row indices of the COO matrix. Must be an array of length nnz.
[out]coo_col_ind- column indices of the COO matrix. Must be an array of length nnz.
[out]coo_val- values of the COO matrix. Must be an array of length nnz.
[out]idx_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, coo_row_ind, coo_col_ind, or coo_val is invalid.
rocsparse_status_invalid_sizeif rows, cols, or nnz is invalid.
rocsparse_status_invalid_valueif idx_type, idx_base, or data_type is invalid.

Member Function/Subroutine Documentation

◆ rocsparse_coo_get_()

integer(kind(rocsparse_status_success)) function hipfort_rocsparse::rocsparse_coo_get::rocsparse_coo_get_ ( type(c_ptr), value  descr,
integer(c_int64_t)  rows,
integer(c_int64_t)  cols,
integer(c_int64_t)  nnz,
type(c_ptr)  coo_row_ind,
type(c_ptr)  coo_col_ind,
type(c_ptr)  coo_val,
type(c_ptr), value  idx_type,
type(c_ptr), value  idx_base,
type(c_ptr), value  data_type 
)

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