Implement Csr/CscMatrix::identity

nalgebra-sparse/src/cs.rs

@@ -4,6 +4,8 @@ use crate::{SparseEntry, SparseEntryMut};
 use std::sync::Arc;
 use std::ops::Range;
 use std::mem::replace;
+use num_traits::One;
+use nalgebra::Scalar;
 
 /// An abstract compressed matrix.
 ///
@@ -156,6 +158,21 @@ impl<T> CsMatrix<T> {
     }
 }
 
+impl<T: Scalar + One> CsMatrix<T> {
+    /// TODO
+    #[inline]
+    pub fn identity(n: usize) -> Self {
+        let offsets: Vec<_> = (0 ..= n).collect();
+        let indices: Vec<_> = (0 .. n).collect();
+        let values = vec![T::one(); n];
+
+        // TODO: We should skip checks here
+        let pattern = SparsityPattern::try_from_offsets_and_indices(n, n, offsets, indices)
+            .unwrap();
+        Self::from_pattern_and_values(Arc::new(pattern), values)
+    }
+}
+
 fn get_entry_from_slices<'a, T>(
     minor_dim: usize,
     minor_indices: &'a [usize],

nalgebra-sparse/src/csc.rs

@@ -7,7 +7,7 @@ use crate::cs::{CsMatrix, CsLane, CsLaneMut, CsLaneIter, CsLaneIterMut};
 
 use std::sync::Arc;
 use std::slice::{IterMut, Iter};
-use num_traits::Zero;
+use num_traits::{Zero, One};
 use nalgebra::Scalar;
 
 /// A CSC representation of a sparse matrix.
@@ -337,6 +337,16 @@ impl<T> CscMatrix<T>
     }
 }
 
+impl<T: Scalar + One> CscMatrix<T> {
+    /// TODO
+    #[inline]
+    pub fn identity(n: usize) -> Self {
+        Self {
+            cs: CsMatrix::identity(n)
+        }
+    }
+}
+
 /// Convert pattern format errors into more meaningful CSC-specific errors.
 ///
 /// This ensures that the terminology is consistent: we are talking about rows and columns,

nalgebra-sparse/src/csr.rs

@@ -5,7 +5,7 @@ use crate::csc::CscMatrix;
 use crate::cs::{CsMatrix, CsLaneIterMut, CsLaneIter, CsLane, CsLaneMut};
 
 use nalgebra::Scalar;
-use num_traits::Zero;
+use num_traits::{Zero, One};
 
 use std::sync::Arc;
 use std::slice::{IterMut, Iter};
@@ -338,6 +338,16 @@ where
     }
 }
 
+impl<T: Scalar + One> CsrMatrix<T> {
+    /// TODO
+    #[inline]
+    pub fn identity(n: usize) -> Self {
+        Self {
+            cs: CsMatrix::identity(n)
+        }
+    }
+}
+
 /// Convert pattern format errors into more meaningful CSR-specific errors.
 ///
 /// This ensures that the terminology is consistent: we are talking about rows and columns,