Update solvers.rs

sarah-quinones · Sep 7, 2024 · 5eef3eb · 5eef3eb
1 parent 1a8461b
commit 5eef3eb
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/src/sparse/linalg/solvers.rs b/src/sparse/linalg/solvers.rs
@@ -25,24 +25,24 @@ pub trait SpSolverLstsqCore<E: Entity>: SpSolverCore<E> {
 
 /// Solver that can compute solution of a linear system.
 pub trait SpSolver<E: ComplexField>: SpSolverCore<E> {
-    /// Solves the equation `self * X = rhs`, and stores the result in `rhs`.
+    /// Solves the equation `self * X = rhs` when self is square, and stores the result in `rhs`.
     fn solve_in_place(&self, rhs: impl ColBatchMut<E>);
-    /// Solves the equation `conjugate(self) * X = rhs`, and stores the result in `rhs`.
+    /// Solves the equation `conjugate(self) * X = rhs` when self is square, and stores the result in `rhs`.
     fn solve_conj_in_place(&self, rhs: impl ColBatchMut<E>);
-    /// Solves the equation `transpose(self) * X = rhs`, and stores the result in `rhs`.
+    /// Solves the equation `transpose(self) * X = rhs` when self is square, and stores the result in `rhs`.
     fn solve_transpose_in_place(&self, rhs: impl ColBatchMut<E>);
-    /// Solves the equation `adjoint(self) * X = rhs`, and stores the result in `rhs`.
+    /// Solves the equation `adjoint(self) * X = rhs` when self is square, and stores the result in `rhs`.
     fn solve_conj_transpose_in_place(&self, rhs: impl ColBatchMut<E>);
-    /// Solves the equation `self * X = rhs`, and returns the result.
+    /// Solves the equation `self * X = rhs` when self is square, and returns the result.
     fn solve<ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>>(&self, rhs: B) -> B::Owned;
-    /// Solves the equation `conjugate(self) * X = rhs`, and returns the result.
+    /// Solves the equation `conjugate(self) * X = rhs` when self is square, and returns the result.
     fn solve_conj<ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>>(&self, rhs: B) -> B::Owned;
-    /// Solves the equation `transpose(self) * X = rhs`, and returns the result.
+    /// Solves the equation `transpose(self) * X = rhs` when self is square, and returns the result.
     fn solve_transpose<ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>>(
         &self,
         rhs: B,
     ) -> B::Owned;
-    /// Solves the equation `adjoint(self) * X = rhs`, and returns the result.
+    /// Solves the equation `adjoint(self) * X = rhs` when self is square, and returns the result.
     fn solve_conj_transpose<ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>>(
         &self,
         rhs: B,