Improved documentation of GaussNewtonLSand added doc tests and unit…

… tests
argmin-rs · Apr 8, 2022 · 6190c1a · 6190c1a
1 parent 7e8d566
commit 6190c1a
Show file tree

Hide file tree

Showing 4 changed files with 309 additions and 55 deletions.
diff --git a/argmin/src/solver/conjugategradient/cg.rs b/argmin/src/solver/conjugategradient/cg.rs
@@ -22,6 +22,8 @@ use serde::{Deserialize, Serialize};
 ///
 /// Requires that the provided optimization problem implements [`Operator`].
 ///
+/// Requires an initial parameter vector.
+///
 /// ## Reference
 ///
 /// Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization.

diff --git a/argmin/src/solver/conjugategradient/nonlinear_cg.rs b/argmin/src/solver/conjugategradient/nonlinear_cg.rs
@@ -20,6 +20,8 @@ use serde::{Deserialize, Serialize};
 ///
 /// Requires that the provided optimization problem implements [`CostFunction`] and [`Gradient`].
 ///
+/// Requires an initial parameter vector.
+///
 /// # Reference
 ///
 /// \[0\] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization.