Mercurial > repos > non-riemannian-opt / file diff

--- a/src/fb.rs	Fri Dec 06 14:27:14 2024 -0500
+++ b/src/fb.rs	Fri Dec 06 14:57:11 2024 -0500
@@ -11,11 +11,13 @@
 
 /// Trait for function objects that implement gradients
 pub trait Grad<M : ManifoldPoint> {
+    /// Calculates the gradient of `self` at `x`.
     fn grad(&self, x : &M) -> M::Tangent;
 }
 
 /// Trait for function objects that implement gradient steps
 pub trait Desc<M : ManifoldPoint> {
+    /// Calculates the gradient steps of `self` at `x` for the step length `τ`.
     fn desc(&self, τ : f64, x : M) -> M;
 }
 
@@ -39,6 +41,7 @@
 
 /// Trait for function objects that implement proximal steps
 pub trait Prox<M : ManifoldPoint> {
+    /// Calculates the proximap map of `self` at `x` for the step length `τ`.
     fn prox(&self, τ : f64, x : M) -> M;
 }