Commit 8c2cd8a6 authored by Liam M. Healy's avatar Liam M. Healy
Browse files

Clearer docstring for one-dimensional-minimizer

parent f9193d2c
;; Univariate minimization
;; Liam Healy Tue Jan 8 2008 - 21:02
;; Time-stamp: <2009-12-27 10:05:32EST minimization-one.lisp>
;; Time-stamp: <2010-07-01 11:55:38EDT minimization-one.lisp>
;; Copyright 2008, 2009 Liam M. Healy
;; Distributed under the terms of the GNU General Public License
......@@ -31,10 +31,11 @@
((type :pointer))
"one-dimensional minimizer"
:documentation ; FDL
"Make an instance of a minimizer of the given type. Optionally
set to use the function and the initial search interval [lower,
upper], with a guess for the location of the minimum."
"Make an instance of a minimizer of the given type. Specify
a guess of the minimum point, the search interval
(x-minimum x-lower x-upper) and optionally
function values at those points (f-minimum f-lower f-upper)."
(callback fnstruct nil (function :double (:input :double) :slug))
:initialize-suffix ("set" "set_with_values")
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment