Skip to content

Commit

Permalink
[oneMKL][spblas] Add sorted_by_rows property
Browse files Browse the repository at this point in the history
  • Loading branch information
Rbiessy committed Sep 23, 2024
1 parent 46530e0 commit a4e7676
Showing 1 changed file with 11 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Matrix properties
enum class matrix_property {
symmetric,
sorted,
sorted_by_rows,
};
}
Expand All @@ -39,12 +40,20 @@ Matrix properties
the matrix is square, the user data contain both lower and upper
triangular regions, and that its transpose is equal to itself.
* - ``sorted``
- | Guarantees that the user-provided matrix data has some sorting
property.
- | Guarantees that the user-provided matrix data is fully sorted.
| For CSR this guarantees that the column indices are sorted in
ascending order for a given row.
| For COO this guarantees that the indices are sorted by row then by
column in ascending order.
* - ``sorted_by_rows``
- | Guarantees that the user-provided matrix data is partially sorted.
Has no effect if the property ``sorted`` is set.
| For COO this guarantees that the indices are sorted by row in
ascending order. The column indices within a row do not need to be
sorted.
| Setting this property for a matrix using the CSR format will throw an
:ref:`oneapi::mkl::invalid_argument<onemkl_exception_invalid_argument>`
exception.
set_matrix_property
-------------------
Expand Down

0 comments on commit a4e7676

Please sign in to comment.