Update module-level docs
This commit is contained in:
parent
8424232dfb
commit
ef9a3dd767
|
@ -19,10 +19,12 @@
|
||||||
//! which also uses the Matrix Market file format.
|
//! which also uses the Matrix Market file format.
|
||||||
//!
|
//!
|
||||||
//! We currently offer functionality for importing a Matrix market file to an instance of a
|
//! We currently offer functionality for importing a Matrix market file to an instance of a
|
||||||
//! [CooMatrix](crate::CooMatrix) through the function [load_coo_from_matrix_market_file]. It is also possible to load
|
//! [CooMatrix](crate::CooMatrix) through the function [load_coo_from_matrix_market_file],
|
||||||
//! a matrix stored in the matrix market format with the function [load_coo_from_matrix_market_str].
|
//! as well as functionality for writing various sparse matrices to the matrix market format
|
||||||
//!
|
//! through [write_to_matrix_market_file]. It is also possible to load
|
||||||
//! Export is currently not implemented, but [planned](https://github.com/dimforge/nalgebra/issues/1037).
|
//! a matrix stored as a string in the matrix market format with the function
|
||||||
|
//! [load_coo_from_matrix_market_str], or similarly write to a string with
|
||||||
|
//! [write_to_matrix_market_str].
|
||||||
//!
|
//!
|
||||||
//! Our implementation is based on the [format description](https://math.nist.gov/MatrixMarket/formats.html)
|
//! Our implementation is based on the [format description](https://math.nist.gov/MatrixMarket/formats.html)
|
||||||
//! on the Matrix Market website and the
|
//! on the Matrix Market website and the
|
||||||
|
|
Loading…
Reference in New Issue