diff --git a/nalgebra-sparse/src/csc.rs b/nalgebra-sparse/src/csc.rs index 89cb88cd..fb454a43 100644 --- a/nalgebra-sparse/src/csc.rs +++ b/nalgebra-sparse/src/csc.rs @@ -369,11 +369,7 @@ impl CscMatrix { 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() } diff --git a/nalgebra-sparse/src/csr.rs b/nalgebra-sparse/src/csr.rs index 24c45e74..2e95460f 100644 --- a/nalgebra-sparse/src/csr.rs +++ b/nalgebra-sparse/src/csr.rs @@ -371,11 +371,7 @@ impl CsrMatrix { 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() } diff --git a/nalgebra-sparse/src/lib.rs b/nalgebra-sparse/src/lib.rs index 1de835c7..a2783545 100644 --- a/nalgebra-sparse/src/lib.rs +++ b/nalgebra-sparse/src/lib.rs @@ -55,7 +55,7 @@ //! | ------------------------|--------------------------------------------- | //! | [COO](`coo::CooMatrix`) | Well-suited for matrix construction.
Ill-suited for algebraic operations. | //! | [CSR](`csr::CsrMatrix`) | Immutable sparsity pattern, suitable for algebraic operations.
Fast row access. | -//! | [CSC](`csr::CscMatrix`) | Immutable sparsity pattern, suitable for algebraic operations.
Fast column access. | +//! | [CSC](`csc::CscMatrix`) | Immutable sparsity pattern, suitable for algebraic operations.
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