Address review concerns: doc link, Csr/CScMatrix::pattern docs
This commit is contained in:
parent
86aeed6a09
commit
2d11b90149
|
@ -369,11 +369,7 @@ impl<T> CscMatrix<T> {
|
|||
self.cs.pattern_and_values_mut()
|
||||
}
|
||||
|
||||
/// Returns 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.
|
||||
/// Returns a reference to the underlying sparsity pattern.
|
||||
pub fn pattern(&self) -> &SparsityPattern {
|
||||
self.cs.pattern()
|
||||
}
|
||||
|
|
|
@ -371,11 +371,7 @@ impl<T> CsrMatrix<T> {
|
|||
self.cs.pattern_and_values_mut()
|
||||
}
|
||||
|
||||
/// Returns 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.
|
||||
/// Returns a reference to the underlying sparsity pattern.
|
||||
pub fn pattern(&self) -> &SparsityPattern {
|
||||
self.cs.pattern()
|
||||
}
|
||||
|
|
|
@ -55,7 +55,7 @@
|
|||
//! | ------------------------|--------------------------------------------- |
|
||||
//! | [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. |
|
||||
//! | [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
|
||||
//! matrices in science is the solution of sparse linear systems. Here we can differentiate between
|
||||
|
|
Loading…
Reference in New Issue