Function

sparse_set_matrix_property

Sets the given property for a matrix object.

Declaration

sparse_status sparse_set_matrix_property(void *A, sparse_matrix_property pname);

Parameters

A

The sparse matrix object.

pname

The property name to set to YES. See sparse_matrix_property for options.

Return Value

SPARSE_SUCCESS when property is successfully set, otherwise return SPARSE_CANNOT_SET_PROPERTY.

Discussion

The matrix object must not have had values inserted, else SPARSE_CANNOT_SET_PROPERTY is returned and the property is not set.Certain groups of properties are mutually exclusive and setting multiple values within a group is undefined.

See Also

General Sparse Matrix Management Operations

sparse_commit

Forces any values recently added to the matrix to be put into the internal sparse storage format.

sparse_matrix_destroy

Releases any memory associated with the matrix object.

sparse_get_matrix_property

Returns the value of the given property name.

sparse_get_matrix_number_of_rows

Returns the number of rows of a matrix.

sparse_get_matrix_number_of_columns

Returns the number of columns of a matrix.

sparse_get_matrix_nonzero_count

Returns the number of nonzero values of a matrix.

sparse_get_matrix_nonzero_count_for_row

Returns the number of nonzero values in a specified row of a matrix.

sparse_get_matrix_nonzero_count_for_column

Returns the number of nonzero values in a specified column of a matrix.