M-Labs
/
nalgebra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Address review concerns: doc link, Csr/CScMatrix::pattern docs

This commit is contained in:
Andreas Longva 2021-02-01 08:41:37 +01:00
parent 86aeed6a09
commit 2d11b90149
3 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nalgebra-sparse/src/csc.rs
View File

@ -369,11 +369,7 @@ impl<T> CscMatrix<T> {
self.cs.pattern_and_values_mut() self.cs.pattern_and_values_mut()
} }
/// Returns the underlying sparsity pattern. /// Returns a reference to the underlying sparsity pattern.
///
/// The sparsity pattern is stored internally inside an `Arc`. This allows users to re-use
/// the same sparsity pattern for multiple matrices without storing the same pattern multiple
/// times in memory.
pub fn pattern(&self) -> &SparsityPattern { pub fn pattern(&self) -> &SparsityPattern {
self.cs.pattern() self.cs.pattern()
} }

6
nalgebra-sparse/src/csr.rs
View File

@ -371,11 +371,7 @@ impl<T> CsrMatrix<T> {
self.cs.pattern_and_values_mut() self.cs.pattern_and_values_mut()
} }
/// Returns the underlying sparsity pattern. /// Returns a reference to the underlying sparsity pattern.
///
/// The sparsity pattern is stored internally inside an `Arc`. This allows users to re-use
/// the same sparsity pattern for multiple matrices without storing the same pattern multiple
/// times in memory.
pub fn pattern(&self) -> &SparsityPattern { pub fn pattern(&self) -> &SparsityPattern {
self.cs.pattern() self.cs.pattern()
} }

2
nalgebra-sparse/src/lib.rs
View File

@ -55,7 +55,7 @@
//! | ------------------------|--------------------------------------------- | //! | ------------------------|--------------------------------------------- |
//! | [COO](`coo::CooMatrix`) | Well-suited for matrix construction. <br /> Ill-suited for algebraic operations. | //! | [COO](`coo::CooMatrix`) | Well-suited for matrix construction. <br /> Ill-suited for algebraic operations. |
//! | [CSR](`csr::CsrMatrix`) | Immutable sparsity pattern, suitable for algebraic operations. <br /> Fast row access. | //! | [CSR](`csr::CsrMatrix`) | Immutable sparsity pattern, suitable for algebraic operations. <br /> Fast row access. |
//! | [CSC](`csr::CscMatrix`) | Immutable sparsity pattern, suitable for algebraic operations. <br /> Fast column access. | //! | [CSC](`csc::CscMatrix`) | Immutable sparsity pattern, suitable for algebraic operations. <br /> Fast column access. |
//! //!
//! What format is best to use depends on the application. The most common use case for sparse //! What format is best to use depends on the application. The most common use case for sparse
//! matrices in science is the solution of sparse linear systems. Here we can differentiate between //! matrices in science is the solution of sparse linear systems. Here we can differentiate between