rocSPARSE enumerations

rocsparse_action

enum rocsparse_action

Specify where the operation is performed on.

The rocsparse_action indicates whether the operation is performed on the full matrix or only on the sparsity pattern of the matrix.

Values:

enumerator rocsparse_action_symbolic

Operate only on indices.

enumerator rocsparse_action_numeric

Operate on data and indices.

rocsparse_direction

enum rocsparse_direction

Specify the matrix direction.

The rocsparse_direction indicates whether a dense matrix should be parsed by rows or by columns, assuming column-major storage.

Values:

enumerator rocsparse_direction_row

Parse the matrix by rows.

enumerator rocsparse_direction_column

Parse the matrix by columns.

rocsparse_hyb_partition

enum rocsparse_hyb_partition

HYB matrix partitioning type.

The rocsparse_hyb_partition type indicates how the hybrid format partitioning between COO and ELL storage formats is performed.

Values:

enumerator rocsparse_hyb_partition_auto

Automatically decide on ELL nnz per row.

enumerator rocsparse_hyb_partition_user

User-provided ELL nnz per row.

enumerator rocsparse_hyb_partition_max

Max ELL nnz per row, no COO part.

rocsparse_index_base

enum rocsparse_index_base

Specify the matrix index base.

The rocsparse_index_base indicates the index base of the indices. For a given rocsparse_mat_descr, the rocsparse_index_base can be set using rocsparse_set_mat_index_base(). The current rocsparse_index_base of a matrix can be obtained by rocsparse_get_mat_index_base().

Values:

enumerator rocsparse_index_base_zero

Zero-based indexing.

enumerator rocsparse_index_base_one

One-based indexing.

rocsparse_matrix_type

enum rocsparse_matrix_type

Specify the matrix type.

The rocsparse_matrix_type indicates the type of a matrix. For a given rocsparse_mat_descr, the rocsparse_matrix_type can be set using rocsparse_set_mat_type(). The current rocsparse_matrix_type of a matrix can be obtained by rocsparse_get_mat_type().

For the matrix types rocsparse_matrix_type_symmetric, rocsparse_matrix_type_hermitian, and rocsparse_matrix_type_triangular, only the upper or lower part of the matrix (specified by setting the rocsparse_fill_mode) is assumed to be stored. The purpose of this is to minimize the amount of memory required to store the matrix.

Routines that accept rocsparse_matrix_type_symmetric or rocsparse_matrix_type_hermitian will only read from the stored upper or lower part of the matrix but will perform the computation as if the full symmetric/Hermitian matrix existed. For example, when computing \(y=A*x\), where A is symmetric and only the lower part is stored, internally the multiplication will be performed in two steps. First, the computation \(y=(L+D)*x\) will be performed. Secondly, the multiplication will be completed by performing \(y=L^T*x + y\). This second step involves a transposed multiplication, which is slower. For this reason, where space allows, it is faster to store the entire symmetric matrix and use rocsparse_matrix_type_general instead of rocsparse_matrix_type_symmetric.

Values:

enumerator rocsparse_matrix_type_general

General matrix type.

enumerator rocsparse_matrix_type_symmetric

Symmetric matrix type.

enumerator rocsparse_matrix_type_hermitian

Hermitian matrix type.

enumerator rocsparse_matrix_type_triangular

Triangular matrix type.

rocsparse_fill_mode

enum rocsparse_fill_mode

Specify the matrix fill mode.

The rocsparse_fill_mode indicates whether the lower or the upper part is stored in a sparse triangular matrix. For a given rocsparse_mat_descr, the rocsparse_fill_mode can be set using rocsparse_set_mat_fill_mode(). The current rocsparse_fill_mode of a matrix can be obtained by rocsparse_get_mat_fill_mode().

Values:

enumerator rocsparse_fill_mode_lower

Lower triangular part is stored.

enumerator rocsparse_fill_mode_upper

Upper triangular part is stored.

rocsparse_storage_mode

enum rocsparse_storage_mode

Specify whether the matrix is stored sorted or not.

The rocsparse_storage_mode indicates whether the matrix is stored as sorted or not. For a given rocsparse_mat_descr, the rocsparse_storage_mode can be set using rocsparse_set_mat_storage_mode(). The current rocsparse_storage_mode of a matrix can be obtained by rocsparse_get_mat_storage_mode().

Values:

enumerator rocsparse_storage_mode_sorted

Matrix is sorted.

enumerator rocsparse_storage_mode_unsorted

Matrix is unsorted.

rocsparse_diag_type

enum rocsparse_diag_type

Indicates if the diagonal entries are unity.

The rocsparse_diag_type indicates whether the diagonal entries of a matrix are unity or not. If rocsparse_diag_type_unit is specified, all present diagonal values will be ignored. For a given rocsparse_mat_descr, the rocsparse_diag_type can be set using rocsparse_set_mat_diag_type(). The current rocsparse_diag_type of a matrix can be obtained by rocsparse_get_mat_diag_type().

Values:

enumerator rocsparse_diag_type_non_unit

Diagonal entries are non-unity.

enumerator rocsparse_diag_type_unit

Diagonal entries are unity.

rocsparse_operation

enum rocsparse_operation

Specify whether the matrix is to be transposed or not.

The rocsparse_operation indicates the operation performed with the given matrix.

Values:

enumerator rocsparse_operation_none

Operate with matrix.

enumerator rocsparse_operation_transpose

Operate with transpose.

enumerator rocsparse_operation_conjugate_transpose

Operate with conj. transpose.

rocsparse_pointer_mode

enum rocsparse_pointer_mode

Indicates if the pointer is a device pointer or host pointer.

The rocsparse_pointer_mode indicates whether scalar values are passed by reference on the host or device. The rocsparse_pointer_mode can be changed by rocsparse_set_pointer_mode(). The current pointer mode in use can be obtained by rocsparse_get_pointer_mode().

Values:

enumerator rocsparse_pointer_mode_host

Scalar pointers are in host memory.

enumerator rocsparse_pointer_mode_device

Scalar pointers are in device memory.

rocsparse_analysis_policy

enum rocsparse_analysis_policy

Specify policy in analysis functions.

The rocsparse_analysis_policy specifies whether gathered analysis data should be reused or not. If meta data from, for example, a previous rocsparse_Xcsrilu0_analysis() call is available, it can be reused for subsequent calls to, for example, rocsparse_Xcsrsv_analysis() and greatly improve performance of the analysis function.

Values:

enumerator rocsparse_analysis_policy_reuse

Try to reuse meta data.

enumerator rocsparse_analysis_policy_force

Force to rebuild meta data.

rocsparse_solve_policy

enum rocsparse_solve_policy

Specify policy in triangular solvers and factorizations.

This is a placeholder.

Values:

enumerator rocsparse_solve_policy_auto

Automatically decide on level information.

rocsparse_layer_mode

enum rocsparse_layer_mode

Indicates if the layer is active through the use of a bitmask.

The rocsparse_layer_mode bit mask indicates the logging characteristics.

Values:

enumerator rocsparse_layer_mode_none

Layer is not active.

enumerator rocsparse_layer_mode_log_trace

Layer is in logging mode.

enumerator rocsparse_layer_mode_log_bench

Layer is in benchmarking mode (deprecated).

enumerator rocsparse_layer_mode_log_debug

Layer is in debug mode.

For more details on logging, see Activity logging [Deprecated].

rocsparse_status

enum rocsparse_status

List of rocSPARSE status codes definition.

This is a list of the rocsparse_status types that are used by the rocSPARSE library.

Values:

enumerator rocsparse_status_success

success.

enumerator rocsparse_status_invalid_handle

handle not initialized, invalid, or null.

enumerator rocsparse_status_not_implemented

function is not implemented.

enumerator rocsparse_status_invalid_pointer

invalid pointer parameter.

enumerator rocsparse_status_invalid_size

invalid size parameter.

enumerator rocsparse_status_memory_error

failed memory allocation, copy or dealloc.

enumerator rocsparse_status_internal_error

other internal library failure.

enumerator rocsparse_status_invalid_value

invalid value parameter.

enumerator rocsparse_status_arch_mismatch

device arch is not supported.

enumerator rocsparse_status_zero_pivot

encountered zero pivot.

enumerator rocsparse_status_not_initialized

descriptor has not been initialized.

enumerator rocsparse_status_type_mismatch

index types do not match.

enumerator rocsparse_status_requires_sorted_storage

sorted storage required.

enumerator rocsparse_status_thrown_exception

exception being thrown.

enumerator rocsparse_status_continue

Nothing preventing the function to proceed

rocsparse_data_status

enum rocsparse_data_status

List of rocSPARSE data status code definitions.

This is a list of the rocsparse_data_status types that are used by the rocSPARSE library in the matrix check routines.

Values:

enumerator rocsparse_data_status_success

Success.

enumerator rocsparse_data_status_inf

An inf value detected.

enumerator rocsparse_data_status_nan

A nan value detected.

enumerator rocsparse_data_status_invalid_offset_ptr

An invalid row pointer offset detected.

enumerator rocsparse_data_status_invalid_index

An invalid row index detected.

enumerator rocsparse_data_status_duplicate_entry

Duplicate indices detected.

enumerator rocsparse_data_status_invalid_sorting

Incorrect sorting detected.

enumerator rocsparse_data_status_invalid_fill

Incorrect fill mode detected.

rocsparse_indextype

enum rocsparse_indextype

List of rocSPARSE index types.

Indicates the index width of a rocSPARSE index type.

Values:

enumerator rocsparse_indextype_u16

16-bit unsigned integer.

enumerator rocsparse_indextype_i32

32-bit signed integer.

enumerator rocsparse_indextype_i64

64-bit signed integer.

rocsparse_datatype

enum rocsparse_datatype

List of rocSPARSE data types.

Indicates the precision width of data stored in a rocSPARSE type.

Values:

enumerator rocsparse_datatype_f16_r

16-bit floating point, real.

enumerator rocsparse_datatype_f32_r

32-bit floating point, real.

enumerator rocsparse_datatype_f64_r

64-bit floating point, real.

enumerator rocsparse_datatype_f32_c

32-bit floating point, complex.

enumerator rocsparse_datatype_f64_c

64-bit floating point, complex.

enumerator rocsparse_datatype_i8_r

8-bit signed integer, real

enumerator rocsparse_datatype_u8_r

8-bit unsigned integer, real

enumerator rocsparse_datatype_i32_r

32-bit signed integer, real

enumerator rocsparse_datatype_u32_r

32-bit unsigned integer, real

enumerator rocsparse_datatype_bf16_r

16-bit brain floating point, real

rocsparse_format

enum rocsparse_format

List of sparse matrix formats.

This is a list of supported rocsparse_format types that are used to describe a sparse matrix.

Values:

enumerator rocsparse_format_coo

COO sparse matrix format.

enumerator rocsparse_format_coo_aos

COO AoS sparse matrix format.

enumerator rocsparse_format_csr

CSR sparse matrix format.

enumerator rocsparse_format_csc

CSC sparse matrix format.

enumerator rocsparse_format_ell

ELL sparse matrix format.

enumerator rocsparse_format_bell

Blocked ELL sparse matrix format.

enumerator rocsparse_format_bsr

BSR sparse matrix format.

enumerator rocsparse_format_sell

Sliced ELL sparse matrix format.

rocsparse_order

enum rocsparse_order

List of dense matrix ordering.

This is a list of supported rocsparse_order types that are used to describe the memory layout of a dense matrix.

Values:

enumerator rocsparse_order_row

Row major.

enumerator rocsparse_order_column

Column major.

rocsparse_singularity

enum rocsparse_singularity

List of singularity types encountered in triangular solves and incomplete factorizations.

Values:

enumerator rocsparse_singularity_none

No singularity detected.

enumerator rocsparse_singularity_symbolic

The sparsity pattern inherently prevents a full rank, for example, a missing diagonal element.

enumerator rocsparse_singularity_numeric_exact

An exact zero was encountered during numerical calculation.

enumerator rocsparse_singularity_numeric_near

A near zero was encountered during numerical calculation, that is, within a given tolerance.

rocsparse_spmat_attribute

enum rocsparse_spmat_attribute

List of sparse matrix attributes.

Values:

enumerator rocsparse_spmat_fill_mode

Fill mode attribute.

enumerator rocsparse_spmat_diag_type

Diag type attribute.

enumerator rocsparse_spmat_matrix_type

Matrix type attribute.

enumerator rocsparse_spmat_storage_mode

Matrix storage attribute.

rocsparse_spmv_alg

enum rocsparse_spmv_alg

List of SpMV algorithms.

This is a list of supported rocsparse_spmv_alg types that are used to perform matrix vector product.

Values:

enumerator rocsparse_spmv_alg_default

Default SpMV algorithm for the given format.

enumerator rocsparse_spmv_alg_coo

COO SpMV algorithm 1 (segmented) for COO matrices.

enumerator rocsparse_spmv_alg_csr_adaptive

CSR SpMV algorithm 1 (adaptive) for CSR matrices.

enumerator rocsparse_spmv_alg_csr_rowsplit

CSR SpMV algorithm 2 (rowsplit) for CSR matrices.

enumerator rocsparse_spmv_alg_ell

ELL SpMV algorithm for ELL matrices.

enumerator rocsparse_spmv_alg_coo_atomic

COO SpMV algorithm 2 (atomic) for COO matrices.

enumerator rocsparse_spmv_alg_bsr

BSR SpMV algorithm 1 for BSR matrices.

enumerator rocsparse_spmv_alg_csr_lrb

CSR SpMV algorithm 3 (LRB) for CSR matrices.

enumerator rocsparse_spmv_alg_csr_nnzsplit

CSR SpMV algorithm 4 (nnzsplit) for CSR matrices.

enumerator rocsparse_spmv_alg_sell

SLICED ELL SpMV algorithm for SLICED ELL matrices.

enumerator rocsparse_spmv_alg_csr_stream

CSR SpMV algorithm 2 (stream) for CSR matrices.

rocsparse_spmv_stage

enum rocsparse_spmv_stage

List of SpMV stages.

This is a list of possible stages during SpMV computation. The typical order is rocsparse_spmv_stage_buffer_size, rocsparse_spmv_stage_preprocess, and rocsparse_spmv_stage_compute.

Values:

enumerator rocsparse_spmv_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spmv_stage_preprocess

Preprocess data.

enumerator rocsparse_spmv_stage_compute

Performs the actual SpMV computation.

rocsparse_spmv_input

enum rocsparse_spmv_input

List of inputs to the SpMV descriptor.

This is a list of possible inputs to the SpMV descriptor.

Values:

enumerator rocsparse_spmv_input_alg

Select algorithm for input on a SpMV descriptor.

enumerator rocsparse_spmv_input_operation

Select matrix transpose operation for input on a SpMV descriptor.

enumerator rocsparse_spmv_input_scalar_datatype

Select scalar datatype for input on a SpMV descriptor.

enumerator rocsparse_spmv_input_compute_datatype

Select compute datatype for input on a SpMV descriptor.

enumerator rocsparse_spmv_input_nnz_use_starting_block_ids

Configure usage of starting block IDs for non-zero split.

enumerator rocsparse_spmv_input_enable_extra

Enable/disable extra vectors computation for SpMV descriptor.

rocsparse_v2_spmv_stage

enum rocsparse_v2_spmv_stage

List of SpMV-Version2 stages.

This is a list of possible stages during SpMV-Version2 computation.

Values:

enumerator rocsparse_v2_spmv_stage_analysis

Analysis of the data.

enumerator rocsparse_v2_spmv_stage_compute

Performs the actual SpMV computation.

rocsparse_spsv_alg

enum rocsparse_spsv_alg

List of SpSV algorithms.

This is a list of supported rocsparse_spsv_alg types that are used to perform triangular solve.

Values:

enumerator rocsparse_spsv_alg_default

Default SpSV algorithm for the given format.

rocsparse_spsv_stage

enum rocsparse_spsv_stage

List of SpSV stages.

This is a list of possible stages during SpSV computation. The typical order is rocsparse_spsv_stage_buffer_size, rocsparse_spsv_stage_preprocess, and rocsparse_spsv_stage_compute.

Values:

enumerator rocsparse_spsv_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spsv_stage_preprocess

Preprocess data.

enumerator rocsparse_spsv_stage_compute

Performs the actual SpSV computation.

rocsparse_sptrsv_alg

enum rocsparse_sptrsv_alg

List of SpTRSV algorithms.

This is a list of supported rocsparse_sptrsv_alg types that are used to perform triangular solve.

Values:

enumerator rocsparse_sptrsv_alg_default

Default SpTRSV algorithm for the given format.

rocsparse_sptrsv_stage

enum rocsparse_sptrsv_stage

List of SpTRSV stages.

This is a list of possible stages during SpTRSV computation.

Values:

enumerator rocsparse_sptrsv_stage_analysis

Analysis.

enumerator rocsparse_sptrsv_stage_compute

Performs the actual SpTRSV computation.

rocsparse_sptrsv_input

enum rocsparse_sptrsv_input

List of inputs to the SpTRSV descriptor.

This is a list of possible inputs to the SpTRSV descriptor.

Values:

enumerator rocsparse_sptrsv_input_alg

Select algorithm rocsparse_sptrsv_alg for input on a SpTRSV descriptor.

enumerator rocsparse_sptrsv_input_operation

Select matrix operation rocsparse_operation for input on a SpTRSV descriptor.

enumerator rocsparse_sptrsv_input_scalar_datatype

Select scalar datatype rocsparse_datatype for input on a SpTRSV descriptor.

enumerator rocsparse_sptrsv_input_compute_datatype

Select compute datatype rocsparse_datatype for input on a SpTRSV descriptor.

enumerator rocsparse_sptrsv_input_scalar_alpha

Select scalar alpha pointer for input on a SpTRSV descriptor.

enumerator rocsparse_sptrsv_input_analysis_policy

Select the analysis policy rocsparse_analysis_policy for input on a SpTRSV descriptor.

rocsparse_sptrsv_output

enum rocsparse_sptrsv_output

List of outputs to SpTRSV descriptor.

This is a list of possible outputs to the SpTRSV descriptor.

Values:

enumerator rocsparse_sptrsv_output_zero_pivot_position

Get zero pivot int64_t based position for output from the SpTRSV descriptor.

enumerator rocsparse_sptrsv_output_singularity

Get the type of rocsparse_singularity detected during SpTRSV calculation for output from the SpTRSV descriptor.

enumerator rocsparse_sptrsv_output_singularity_position

Get the singularity int64_t based position for output from the SpTRSV descriptor.

rocsparse_spsm_alg

enum rocsparse_spsm_alg

List of SpSM algorithms.

This is a list of supported rocsparse_spsm_alg types that are used to perform triangular solve.

Values:

enumerator rocsparse_spsm_alg_default

Default SpSM algorithm for the given format.

rocsparse_spsm_stage

enum rocsparse_spsm_stage

List of SpSM stages.

This is a list of possible stages during SpSM computation. The typical order is rocsparse_spsm_stage_buffer_size, rocsparse_spsm_stage_preprocess, and rocsparse_spsm_stage_compute.

Values:

enumerator rocsparse_spsm_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spsm_stage_preprocess

Preprocess data.

enumerator rocsparse_spsm_stage_compute

Performs the actual SpSM computation.

rocsparse_sptrsm_alg

enum rocsparse_sptrsm_alg

List of SpTRSM algorithms.

This is a list of supported rocsparse_sptrsm_alg types that are used to perform triangular solve.

Values:

enumerator rocsparse_sptrsm_alg_default

Default SpTRSM algorithm for the given format.

rocsparse_sptrsm_stage

enum rocsparse_sptrsm_stage

List of SpTRSM stages.

This is a list of possible stages during SpTRSM computation.

Values:

enumerator rocsparse_sptrsm_stage_analysis

Analysis.

enumerator rocsparse_sptrsm_stage_compute

Performs the actual SpTRSM computation.

rocsparse_sptrsm_input

enum rocsparse_sptrsm_input

List of inputs to the SpTRSM descriptor.

This is a list of possible inputs to the SpTRSM descriptor.

Values:

enumerator rocsparse_sptrsm_input_alg

Select algorithm rocsparse_sptrsm_alg for input on a SpTRSM descriptor.

enumerator rocsparse_sptrsm_input_operation_A

Select matrix A operation rocsparse_operation for input on a SpTRSM descriptor.

enumerator rocsparse_sptrsm_input_operation_X

Select matrix X operation rocsparse_operation for input on a SpTRSM descriptor.

enumerator rocsparse_sptrsm_input_compute_datatype

Select compute datatype rocsparse_datatype for input on a SpTRSM descriptor.

enumerator rocsparse_sptrsm_input_scalar_datatype

Select scalar datatype rocsparse_datatype for input on a SpTRSM descriptor.

enumerator rocsparse_sptrsm_input_scalar_alpha

Select scalar alpha pointer for input on a SpTRSM descriptor. This datatype is used as the compute type.

enumerator rocsparse_sptrsm_input_analysis_policy

Select the analysis policy rocsparse_analysis_policy for input on a SpTRSM descriptor.

rocsparse_sptrsm_output

enum rocsparse_sptrsm_output

List of outputs to SpTRSM descriptor.

This is a list of possible outputs to the SpTRSM descriptor.

Values:

enumerator rocsparse_sptrsm_output_zero_pivot_position

Get zero pivot int64_t based position for output from the SpTRSM descriptor and synchronously return zero_pivot.

rocsparse_spilu0_alg

enum rocsparse_spilu0_alg

List of SpILU0 algorithms.

This is a list of supported rocsparse_spilu0_alg types that are used to perform the incomplete LU factorization of level 0.

Values:

enumerator rocsparse_spilu0_alg_default

rocsparse_spilu0_stage

enum rocsparse_spilu0_stage

List of SpILU0 stages.

This is a list of possible stages during SpILU0 computation.

Values:

enumerator rocsparse_spilu0_stage_analysis

Analysis.

enumerator rocsparse_spilu0_stage_compute

Performs the actual SpILU0 computation.

rocsparse_spilu0_input

enum rocsparse_spilu0_input

List of inputs to the SpILU0 descriptor.

This is a list of possible inputs to the SpILU0 descriptor.

Values:

enumerator rocsparse_spilu0_input_alg

Select algorithm rocsparse_spilu0_alg for input on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_analysis_policy

Select the analysis policy rocsparse_analysis_policy for input on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_compute_datatype

Select compute datatype rocsparse_datatype for input on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_boost_enable

Enable diagonal boosting for input on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_boost_tolerance

Select diagonal boosting tolerance on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_boost_value

Select diagonal boosting value on a SpILU0 descriptor.

enumerator rocsparse_spilu0_input_singularity_tolerance

Select singularity tolerance for input on a SpILU0 descriptor.

rocsparse_spilu0_output

enum rocsparse_spilu0_output

List of outputs to the SpILU0 descriptor.

This is a list of possible outputs to the SpILU0 descriptor.

Values:

enumerator rocsparse_spilu0_output_singularity

Get the type of rocsparse_singularity detected during SpILU0 calculation for output from the SpILU0 descriptor.

enumerator rocsparse_spilu0_output_singularity_position

Get the singularity int64_t based position for output from the SpILU0 descriptor.

rocsparse_spic0_alg

enum rocsparse_spic0_alg

List of SpIC0 algorithms.

This is a list of supported rocsparse_spic0_alg types that are used to perform the incomplete Cholesky factorization of level 0.

Values:

enumerator rocsparse_spic0_alg_default

rocsparse_spic0_stage

enum rocsparse_spic0_stage

List of SpIC0 stages.

This is a list of possible stages during SpIC0 computation.

Values:

enumerator rocsparse_spic0_stage_analysis

Analysis.

enumerator rocsparse_spic0_stage_compute

Performs the actual SpIC0 computation.

rocsparse_spic0_input

enum rocsparse_spic0_input

List of inputs to the SpIC0 descriptor.

This is a list of possible inputs to the SpIC0 descriptor.

Values:

enumerator rocsparse_spic0_input_alg

Select algorithm rocsparse_spic0_alg for input on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_analysis_policy

Select the analysis policy rocsparse_analysis_policy for input on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_compute_datatype

Select compute datatype rocsparse_datatype for input on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_boost_enable

Enable diagonal boosting for input on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_boost_tolerance

Select diagonal boosting tolerance on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_boost_value

Select diagonal boosting value on a SpIC0 descriptor.

enumerator rocsparse_spic0_input_singularity_tolerance

Select singularity tolerance for input on a SpIC0 descriptor.

rocsparse_spic0_output

enum rocsparse_spic0_output

List of outputs to SpIC0 descriptor.

This is a list of possible outputs to the SpIC0 descriptor.

Values:

enumerator rocsparse_spic0_output_singularity

Get the type of rocsparse_singularity detected during SpIC0 calculation for output from the SpIC0 descriptor.

enumerator rocsparse_spic0_output_singularity_position

Get the singularity int64_t based position for output from the SpIC0 descriptor.

rocsparse_spmm_alg

enum rocsparse_spmm_alg

List of SpMM algorithms.

This is a list of supported rocsparse_spmm_alg types that are used to perform matrix vector product.

Values:

enumerator rocsparse_spmm_alg_default

Default SpMM algorithm for the given format.

enumerator rocsparse_spmm_alg_csr

SpMM algorithm for the CSR format using row split and shared memory.

enumerator rocsparse_spmm_alg_coo_segmented

SpMM algorithm for the COO format using segmented scan.

enumerator rocsparse_spmm_alg_coo_atomic

SpMM algorithm for the COO format using atomics.

enumerator rocsparse_spmm_alg_csr_row_split

SpMM algorithm for the CSR format using row split and shfl.

enumerator rocsparse_spmm_alg_csr_merge

SpMM algorithm for CSR format using the nnz split algorithm. This is the same as rocsparse_spmm_alg_csr_nnz_split.

enumerator rocsparse_spmm_alg_coo_segmented_atomic

SpMM algorithm for the COO format using segmented scan and atomics.

enumerator rocsparse_spmm_alg_bell

SpMM algorithm for the Blocked ELL format.

enumerator rocsparse_spmm_alg_bsr

SpMM algorithm for the BSR format.

enumerator rocsparse_spmm_alg_csr_merge_path

SpMM algorithm for the CSR format using the merge path algorithm.

enumerator rocsparse_spmm_alg_csr_nnz_split

SpMM algorithm for the CSR format using the nnz split algorithm.

rocsparse_spmm_stage

enum rocsparse_spmm_stage

List of SpMM stages.

This is a list of possible stages during SpMM computation. The typical order is rocsparse_spmm_stage_buffer_size, rocsparse_spmm_stage_preprocess, and rocsparse_spmm_stage_compute.

Values:

enumerator rocsparse_spmm_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spmm_stage_preprocess

Preprocess data.

enumerator rocsparse_spmm_stage_compute

Performs the actual SpMM computation.

rocsparse_sddmm_alg

enum rocsparse_sddmm_alg

List of sddmm algorithms.

This is a list of supported rocsparse_sddmm_alg types that are used to perform matrix vector product.

Values:

enumerator rocsparse_sddmm_alg_default

Default sddmm algorithm for the given format.

enumerator rocsparse_sddmm_alg_dense

Sddmm algorithm using dense blas operations.

rocsparse_spgemm_stage

enum rocsparse_spgemm_stage

List of SpGEMM stages.

This is a list of possible stages during SpGEMM computation. The typical order is rocsparse_spgemm_stage_buffer_size, rocsparse_spgemm_stage_nnz, and rocsparse_spgemm_stage_compute.

Values:

enumerator rocsparse_spgemm_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spgemm_stage_nnz

Computes the number of non-zero entries.

enumerator rocsparse_spgemm_stage_compute

Performs the actual SpGEMM computation.

enumerator rocsparse_spgemm_stage_symbolic

Performs the actual SpGEMM symbolic computation.

enumerator rocsparse_spgemm_stage_numeric

Performs the actual SpGEMM numeric computation.

rocsparse_spgemm_alg

enum rocsparse_spgemm_alg

List of SpGEMM algorithms.

This is a list of supported rocsparse_spgemm_alg types that are used to perform a sparse matrix sparse matrix product.

Values:

enumerator rocsparse_spgemm_alg_default

Default SpGEMM algorithm for the given format.

rocsparse_spgeam_stage

enum rocsparse_spgeam_stage

List of SpGEAM stages.

This is a list of possible stages during SpGEAM computation. The typical order is rocsparse_spgeam_stage_buffer_size, rocsparse_spgeam_stage_analysis, and rocsparse_spgeam_stage_compute.

Values:

enumerator rocsparse_spgeam_stage_analysis

Computes number of non-zero entries.

enumerator rocsparse_spgeam_stage_compute

Performs the actual SpGEAM computation.

enumerator rocsparse_spgeam_stage_symbolic_analysis

Performs only the symbolic analysis SpGEAM computation to fill the column indices array.

enumerator rocsparse_spgeam_stage_symbolic_compute

Performs only the symbolic SpGEAM computation to fill the column indices array.

enumerator rocsparse_spgeam_stage_numeric_analysis

Performs only the numeric analysis SpGEAM computation to fill the values array.

enumerator rocsparse_spgeam_stage_numeric_compute

Performs only the numeric SpGEAM computation to fill the values array.

rocsparse_spgeam_alg

enum rocsparse_spgeam_alg

List of SpGEAM algorithms.

This is a list of supported rocsparse_spgeam_alg types that are used to perform sparse matrix sparse matrix product.

Values:

enumerator rocsparse_spgeam_alg_default

Default SpGEAM algorithm for the given format.

rocsparse_spgeam_input

enum rocsparse_spgeam_input

List of inputs to the SpGEAM descriptor.

This is a list of possible inputs to the SpGEAM descriptor.

Values:

enumerator rocsparse_spgeam_input_alg

Select algorithm for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_scalar_datatype

Select scalar data type for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_compute_datatype

Select compute data type for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_operation_A

Select A matrix transpose operation for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_operation_B

Select B matrix transpose operation for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_scalar_alpha

Select scalar multiplier alpha for input on a SpGEAM descriptor.

enumerator rocsparse_spgeam_input_scalar_beta

Select scalar multiplier beta for input on a SpGEAM descriptor.

rocsparse_spgeam_output

enum rocsparse_spgeam_output

List of outputs to SpGEAM descriptor.

This is a list of possible outputs to the SpGEAM descriptor.

Values:

enumerator rocsparse_spgeam_output_nnz

Select nnz count for output from the SpGEAM descriptor.

rocsparse_sparse_to_dense_alg

enum rocsparse_sparse_to_dense_alg

List of sparse-to-dense algorithms.

This is a list of supported rocsparse_sparse_to_dense_alg types that are used to perform sparse-to-dense conversion.

Values:

enumerator rocsparse_sparse_to_dense_alg_default

Default sparse-to-dense algorithm for the given format.

rocsparse_sparse_to_sparse_alg

enum rocsparse_sparse_to_sparse_alg

List of sparse-to-sparse algorithms.

This is a list of supported rocsparse_sparse_to_sparse_alg types that are used to perform sparse-to-sparse conversion.

Values:

enumerator rocsparse_sparse_to_sparse_alg_default

Default sparse-to-sparse algorithm for the given format.

rocsparse_sparse_to_sparse_stage

enum rocsparse_sparse_to_sparse_stage

List of sparse-to-sparse stages.

This is a list of possible stages during sparse-to-sparse conversion. The typical order is rocsparse_sparse_to_sparse_stage_analysis, then rocsparse_sparse_to_sparse_stage_compute.

Values:

enumerator rocsparse_sparse_to_sparse_stage_analysis

Data analysis.

enumerator rocsparse_sparse_to_sparse_stage_compute

Performs the actual conversion.

rocsparse_extract_alg

enum rocsparse_extract_alg

List of extract algorithms.

This is a list of supported rocsparse_extract_alg types that are used to perform the submatrix extraction.

Values:

enumerator rocsparse_extract_alg_default

Default extract algorithm for the given format.

rocsparse_extract_stage

enum rocsparse_extract_stage

List of extract stages.

The analysis rocsparse_extract_stage_analysis must be done before the first call of the calculation function rocsparse_extract_stage_compute.

Values:

enumerator rocsparse_extract_stage_analysis

Data analysis.

enumerator rocsparse_extract_stage_compute

Performs the actual extraction.

rocsparse_dense_to_sparse_alg

enum rocsparse_dense_to_sparse_alg

List of dense-to-sparse algorithms.

This is a list of supported rocsparse_dense_to_sparse_alg types that are used to perform dense-to-sparse conversion.

Values:

enumerator rocsparse_dense_to_sparse_alg_default

Default dense to sparse algorithm for the given format.

rocsparse_gtsv_interleaved_alg

enum rocsparse_gtsv_interleaved_alg

List of interleaved gtsv algorithms.

This is a list of supported rocsparse_gtsv_interleaved_alg types that are used to perform interleaved tridiagonal solve.

Values:

enumerator rocsparse_gtsv_interleaved_alg_default

Solve interleaved gtsv using QR algorithm (stable).

enumerator rocsparse_gtsv_interleaved_alg_thomas

Solve interleaved gtsv using Thomas algorithm (unstable).

enumerator rocsparse_gtsv_interleaved_alg_lu

Solve interleaved gtsv using LU algorithm (stable).

enumerator rocsparse_gtsv_interleaved_alg_qr

Solve interleaved gtsv using QR algorithm (stable).

rocsparse_gpsv_interleaved_alg

enum rocsparse_gpsv_interleaved_alg

List of gpsv algorithms.

This is a list of supported rocsparse_gpsv_interleaved_alg types that are used to solve pentadiagonal linear systems.

Values:

enumerator rocsparse_gpsv_interleaved_alg_default

Default gpsv algorithm.

enumerator rocsparse_gpsv_interleaved_alg_qr

QR algorithm.

rocsparse_check_spmat_stage

enum rocsparse_check_spmat_stage

List of check matrix stages.

This is a list of possible stages during check matrix computation. The typical order is rocsparse_check_spmat_stage_buffer_size, then rocsparse_check_spmat_stage_compute.

Values:

enumerator rocsparse_check_spmat_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_check_spmat_stage_compute

Performs check.

rocsparse_spitsv_alg

enum rocsparse_spitsv_alg

List of SpITSV algorithms.

This is a list of supported rocsparse_spitsv_alg types that are used to perform triangular solve.

Values:

enumerator rocsparse_spitsv_alg_default

Default SpITSV algorithm for the given format.

rocsparse_spitsv_stage

enum rocsparse_spitsv_stage

List of SpITSV stages.

This is a list of possible stages during SpITSV computation. The typical order is rocsparse_spitsv_stage_buffer_size, rocsparse_spitsv_stage_preprocess, and rocsparse_spitsv_stage_compute.

Values:

enumerator rocsparse_spitsv_stage_buffer_size

Returns the required buffer size.

enumerator rocsparse_spitsv_stage_preprocess

Preprocess data.

enumerator rocsparse_spitsv_stage_compute

Performs the actual SpITSV computation.

rocsparse_itilu0_alg

enum rocsparse_itilu0_alg

List of Iterative ILU0 algorithms.

This is a list of supported rocsparse_itilu0_alg types that are used to perform the iterative ILU0 algorithm.

Values:

enumerator rocsparse_itilu0_alg_default

Asynchronous ITILU0 algorithm with in-place storage.

enumerator rocsparse_itilu0_alg_async_inplace

Asynchronous ITILU0 algorithm with in-place storage.

enumerator rocsparse_itilu0_alg_async_split

Asynchronous ITILU0 algorithm with explicit storage splitting.

enumerator rocsparse_itilu0_alg_sync_split

Synchronous ITILU0 algorithm with explicit storage splitting.

enumerator rocsparse_itilu0_alg_sync_split_fusion

Semi-synchronous ITILU0 algorithm with explicit storage splitting.

rocsparse_itilu0_option

enum rocsparse_itilu0_option

List of iterative ILU0 options.

This is a list of supported rocsparse_itilu0_option options that are used to perform the iterative ILU0 algorithm.

Values:

enumerator rocsparse_itilu0_option_verbose

Compute a stopping criteria.

enumerator rocsparse_itilu0_option_stopping_criteria

Compute a stopping criteria.

enumerator rocsparse_itilu0_option_compute_nrm_correction

Compute correction.

enumerator rocsparse_itilu0_option_compute_nrm_residual

Compute residual.

enumerator rocsparse_itilu0_option_convergence_history

Log convergence history.

enumerator rocsparse_itilu0_option_coo_format

Use internal coordinate format.