Skip to content
Snippets Groups Projects
Commit 7abb34b2 authored by Liam M. Healy's avatar Liam M. Healy Committed by Liam M. Healy
Browse files

Improve wording and grammar in docstrings

parent 898260bd
No related branches found
No related tags found
No related merge requests found
;; Multivariate minimization. ;; Multivariate minimization.
;; Liam Healy <Tue Jan 8 2008 - 21:28> ;; Liam Healy <Tue Jan 8 2008 - 21:28>
;; Time-stamp: <2011-08-17 00:50:24EDT minimization-multi.lisp> ;; Time-stamp: <2011-09-28 13:30:49EDT minimization-multi.lisp>
;; ;;
;; Copyright 2008, 2009, 2011 Liam M. Healy ;; Copyright 2008, 2009, 2011 Liam M. Healy
;; Distributed under the terms of the GNU General Public License ;; Distributed under the terms of the GNU General Public License
...@@ -47,11 +47,11 @@ ...@@ -47,11 +47,11 @@
((type :pointer) ((first dimensions) sizet)) ((type :pointer) ((first dimensions) sizet))
"multi-dimensional minimizer with function only" "multi-dimensional minimizer with function only"
:documentation ; FDL :documentation ; FDL
"Make an instance of a minimizer of the given for an function of the "Make an instance of a minimizer for a function of the given
given dimensions. Optionally initialize the minimizer to minimize dimensions without derivative. Optionally initialize the minimizer
the function starting from the initial point. The size of the to minimize the function starting from the initial point. The size
initial trial steps is given in vector step-size. The precise of the initial trial steps is given in vector step-size. The
meaning of this parameter depends on the method used." precise meaning of this parameter depends on the method used."
:callbacks :callbacks
(callback fnstruct-dimension (dimension) (callback fnstruct-dimension (dimension)
(function :double (:input :double :foreign-array dim0) :slug)) (function :double (:input :double :foreign-array dim0) :slug))
...@@ -66,16 +66,15 @@ ...@@ -66,16 +66,15 @@
((type :pointer) ((first dimensions) sizet)) ((type :pointer) ((first dimensions) sizet))
"multi-dimensional minimizer with function and derivative" "multi-dimensional minimizer with function and derivative"
:documentation ; FDL :documentation ; FDL
"Make an instance of a derivative-based minimizer of the given for "Make an instance of a minimizer for a function of the given
an function of the given dimensions. Optionally initialize the dimensions with a derivative. Optionally initialize the minimizer
minimizer to minimize the function starting from the initial point. to minimize the function starting from the initial point. The size
The size of the first trial step is given by step-size. The of the first trial step is given by step-size. The accuracy of the
accuracy of the line minimization is specified by tolernace. The line minimization is specified by tolernace. The precise meaning
precise meaning of this parameter depends on the method used. of this parameter depends on the method used. Typically the line
Typically the line minimization is considered successful if the minimization is considered successful if the gradient of the
gradient of the function g is orthogonal to the current search function g is orthogonal to the current search direction p to a
direction p to a relative accuracy of tolerance, where dot(p,g) < relative accuracy of tolerance, where dot(p,g) < tol |p| |g|."
tol |p| |g|."
:callbacks :callbacks
(callback fnstruct-dimension-fdf (dimension) (callback fnstruct-dimension-fdf (dimension)
(function :double (:input :double :foreign-array dim0) :slug) (function :double (:input :double :foreign-array dim0) :slug)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment