aoclsparse_set_mat_diag_type() - 5.2 English - 68552

AOCL API Guide (68552)

Document ID: 68552
Release Date: 2025-12-29
Version: 5.2 English

aoclsparse_status aoclsparse_set_mat_diag_type(aoclsparse_mat_descr descr, aoclsparse_diag_type diag_type)#

Specify the matrix diagonal type of a matrix descriptor.

aoclsparse_set_mat_diag_type sets the matrix diagonal type of a matrix descriptor. Valid diagonal types are aoclsparse_diag_type_unit, aoclsparse_diag_type_non_unit or aoclsparse_diag_type_zero.

Parameters:

descr – [inout] the matrix descriptor.
diag_type – [in] aoclsparse_diag_type_unit or aoclsparse_diag_type_non_unit or aoclsparse_diag_type_zero.

Return values:

aoclsparse_status_success – the operation completed successfully.
aoclsparse_status_invalid_pointer – descr pointer is invalid.
aoclsparse_status_invalid_value – diag_type is invalid.