Skip to content

Commit

Permalink
Readme improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
alugowski committed Jun 25, 2023
1 parent b4646be commit dedad39
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ The `write_matrix_market_*` methods accept a `std::ostream` and a datastructure.

The methods also accept an optional `header` argument that can be used to read and write file metadata, such as the comment or whether the matrix is a `pattern`.

**Important: Open files in binary mode.**

## Coordinate / Triplets

Matrix composed of row and column index vectors and a value vector. Any vector class that can be resized and iterated like `std::vector` will work.
Expand All @@ -105,6 +107,8 @@ fast_matrix_market::read_matrix_market_triplet(
Doublet sparse vectors, composed of index and value vectors, are supported in a similar way by `read_matrix_market_doublet()`.
CSC and CSR matrices composed of `indptr`, `indices`, and `values` arrays can be written directly with `write_matrix_market_csc()`.
## Dense arrays
Any vector class that can be resized and iterated like `std::vector` will work.
Expand Down

0 comments on commit dedad39

Please sign in to comment.