Nelder_mead: added doc

biocaml · Mar 16, 2022 · e505f14 · e505f14
1 parent 7d32744
commit e505f14
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/lib/nelder_mead.ml b/lib/nelder_mead.ml
@@ -1,10 +1,3 @@
-(**
-   Implements method as described in https://en.wikipedia.org/wiki/Nelder%E2%80%93Mead_method
-   some tests from original publication:
-
-     A simplex method for function minimization
-     J. A. Nelder and R. Mead
-*)
 open Core_kernel
 
 let centroid xs =
@@ -124,4 +117,3 @@ let%test "Powell quartic" =
   let sample () = Array.init 4 ~f:rfloat in
   let obj, _, _ = minimize ~f ~sample () in
   Float.(abs obj < 1e-3)
-
diff --git a/lib/nelder_mead.mli b/lib/nelder_mead.mli
@@ -1,3 +1,14 @@
+(** An implementation of Nelder-Mead algorithm for function
+   optimization
+
+   Implements method as described in
+   {{:https://en.wikipedia.org/wiki/Nelder%E2%80%93Mead_method}Wikipedia}
+   and uses some tests from the original publication:
+
+     A simplex method for function minimization
+     J. A. Nelder and R. Mead
+ *)
+
 (** Minimizes cost function [f].
     [sample] function must return a vector of initial parameters.
     Returns the minimum value of [f], the vector of optimized parameters,