1math::optimize(n) Tcl Math Library math::optimize(n)
2______________________________________________________________________________
6
8 math::optimize - Optimisation routines
9
11 package require Tcl 8.4
12 package require math::optimize ?1.0?
14 ::math::optimize::minimum begin end func maxerr
16 ::math::optimize::maximum begin end func maxerr
18 ::math::optimize::min_bound_1d func begin end ?-relerror reltol? ?-ab‐
20 serror abstol? ?-maxiter maxiter? ?-trace traceflag?
21 ::math::optimize::min_unbound_1d func begin end ?-relerror reltol?
23 ?-abserror abstol? ?-maxiter maxiter? ?-trace traceflag?
24 ::math::optimize::solveLinearProgram objective constraints
26 ::math::optimize::linearProgramMaximum objective result
28 ::math::optimize::nelderMead objective xVector ?-scale xScaleVector?
30 ?-ftol epsilon? ?-maxiter count? ??-trace? flag?
31______________________________________________________________________________
33
35 This package implements several optimisation algorithms:
36 • Minimize or maximize a function over a given interval
38 • Solve a linear program (maximize a linear function subject to
40 linear constraints)
41 • Minimize a function of several variables given an initial guess
43 for the location of the minimum.
44 The package is fully implemented in Tcl. No particular attention has
46 been paid to the accuracy of the calculations. Instead, the algorithms
47 have been used in a straightforward manner.
48 This document describes the procedures and explains their usage.
50
52 This package defines the following public procedures:
53 ::math::optimize::minimum begin end func maxerr
55 Minimize the given (continuous) function by examining the values
56 in the given interval. The procedure determines the values at
57 both ends and in the centre of the interval and then constructs
58 a new interval of 1/2 length that includes the minimum. No guar‐
59 antee is made that the global minimum is found.
60 The procedure returns the "x" value for which the function is
62 minimal.
63 This procedure has been deprecated - use min_bound_1d instead
65 begin - Start of the interval
67 end - End of the interval
69 func - Name of the function to be minimized (a procedure taking
71 one argument).
72 maxerr - Maximum relative error (defaults to 1.0e-4)
74 ::math::optimize::maximum begin end func maxerr
76 Maximize the given (continuous) function by examining the values
77 in the given interval. The procedure determines the values at
78 both ends and in the centre of the interval and then constructs
79 a new interval of 1/2 length that includes the maximum. No guar‐
80 antee is made that the global maximum is found.
81 The procedure returns the "x" value for which the function is
83 maximal.
84 This procedure has been deprecated - use max_bound_1d instead
86 begin - Start of the interval
88 end - End of the interval
90 func - Name of the function to be maximized (a procedure taking
92 one argument).
93 maxerr - Maximum relative error (defaults to 1.0e-4)
95 ::math::optimize::min_bound_1d func begin end ?-relerror reltol? ?-ab‐
97 serror abstol? ?-maxiter maxiter? ?-trace traceflag?
98 Miminizes a function of one variable in the given interval. The
99 procedure uses Brent's method of parabolic interpolation, pro‐
100 tected by golden-section subdivisions if the interpolation is
101 not converging. No guarantee is made that a global minimum is
102 found. The function to evaluate, func, must be a single Tcl
103 command; it will be evaluated with an abscissa appended as the
104 last argument.
105 x1 and x2 are the two bounds of the interval in which the mini‐
107 mum is to be found. They need not be in increasing order.
108 reltol, if specified, is the desired upper bound on the relative
110 error of the result; default is 1.0e-7. The given value should
111 never be smaller than the square root of the machine's floating
112 point precision, or else convergence is not guaranteed. abstol,
113 if specified, is the desired upper bound on the absolute error
114 of the result; default is 1.0e-10. Caution must be used with
115 small values of abstol to avoid overflow/underflow conditions;
116 if the minimum is expected to lie about a small but non-zero ab‐
117 scissa, you consider either shifting the function or changing
118 its length scale.
119 maxiter may be used to constrain the number of function evalua‐
121 tions to be performed; default is 100. If the command evaluates
122 the function more than maxiter times, it returns an error to the
123 caller.
124 traceFlag is a Boolean value. If true, it causes the command to
126 print a message on the standard output giving the abscissa and
127 ordinate at each function evaluation, together with an indica‐
128 tion of what type of interpolation was chosen. Default is 0 (no
129 trace).
130 ::math::optimize::min_unbound_1d func begin end ?-relerror reltol?
132 ?-abserror abstol? ?-maxiter maxiter? ?-trace traceflag?
133 Miminizes a function of one variable over the entire real number
134 line. The procedure uses parabolic extrapolation combined with
135 golden-section dilatation to search for a region where a minimum
136 exists, followed by Brent's method of parabolic interpolation,
137 protected by golden-section subdivisions if the interpolation is
138 not converging. No guarantee is made that a global minimum is
139 found. The function to evaluate, func, must be a single Tcl
140 command; it will be evaluated with an abscissa appended as the
141 last argument.
142 x1 and x2 are two initial guesses at where the minimum may lie.
144 x1 is the starting point for the minimization, and the differ‐
145 ence between x2 and x1 is used as a hint at the characteristic
146 length scale of the problem.
147 reltol, if specified, is the desired upper bound on the relative
149 error of the result; default is 1.0e-7. The given value should
150 never be smaller than the square root of the machine's floating
151 point precision, or else convergence is not guaranteed. abstol,
152 if specified, is the desired upper bound on the absolute error
153 of the result; default is 1.0e-10. Caution must be used with
154 small values of abstol to avoid overflow/underflow conditions;
155 if the minimum is expected to lie about a small but non-zero ab‐
156 scissa, you consider either shifting the function or changing
157 its length scale.
158 maxiter may be used to constrain the number of function evalua‐
160 tions to be performed; default is 100. If the command evaluates
161 the function more than maxiter times, it returns an error to the
162 caller.
163 traceFlag is a Boolean value. If true, it causes the command to
165 print a message on the standard output giving the abscissa and
166 ordinate at each function evaluation, together with an indica‐
167 tion of what type of interpolation was chosen. Default is 0 (no
168 trace).
169 ::math::optimize::solveLinearProgram objective constraints
171 Solve a linear program in standard form using a straightforward
172 implementation of the Simplex algorithm. (In the explanation be‐
173 low: The linear program has N constraints and M variables).
174 The procedure returns a list of M values, the values for which
176 the objective function is maximal or a single keyword if the
177 linear program is not feasible or unbounded (either "unfeasible"
178 or "unbounded")
179 objective - The M coefficients of the objective function
181 constraints - Matrix of coefficients plus maximum values that
183 implement the linear constraints. It is expected to be a list of
184 N lists of M+1 numbers each, M coefficients and the maximum
185 value.
186 ::math::optimize::linearProgramMaximum objective result
188 Convenience function to return the maximum for the solution
189 found by the solveLinearProgram procedure.
190 objective - The M coefficients of the objective function
192 result - The result as returned by solveLinearProgram
194 ::math::optimize::nelderMead objective xVector ?-scale xScaleVector?
196 ?-ftol epsilon? ?-maxiter count? ??-trace? flag?
197 Minimizes, in unconstrained fashion, a function of several vari‐
198 able over all of space. The function to evaluate, objective,
199 must be a single Tcl command. To it will be appended as many el‐
200 ements as appear in the initial guess at the location of the
201 minimum, passed in as a Tcl list, xVector.
202 xScaleVector is an initial guess at the problem scale; the first
204 function evaluations will be made by varying the co-ordinates in
205 xVector by the amounts in xScaleVector. If xScaleVector is not
206 supplied, the co-ordinates will be varied by a factor of 1.0001
207 (if the co-ordinate is non-zero) or by a constant 0.0001 (if the
208 co-ordinate is zero).
209 epsilon is the desired relative error in the value of the func‐
211 tion evaluated at the minimum. The default is 1.0e-7, which usu‐
212 ally gives three significant digits of accuracy in the values of
213 the x's.
214 pp count is a limit on the number of trips through the main loop
216 of the optimizer. The number of function evaluations may be
217 several times this number. If the optimizer fails to find a
218 minimum to within ftol in maxiter iterations, it returns its
219 current best guess and an error status. Default is to allow 500
220 iterations.
221 flag is a flag that, if true, causes a line to be written to the
223 standard output for each evaluation of the objective function,
224 giving the arguments presented to the function and the value re‐
225 turned. Default is false.
226 The nelderMead procedure returns a list of alternating keywords
228 and values suitable for use with array set. The meaning of the
229 keywords is:
230 x is the approximate location of the minimum.
232 y is the value of the function at x.
234 yvec is a vector of the best N+1 function values achieved, where
236 N is the dimension of x
237 vertices is a list of vectors giving the function arguments cor‐
239 responding to the values in yvec.
240 nIter is the number of iterations required to achieve conver‐
242 gence or fail.
243 status is 'ok' if the operation succeeded, or 'too-many-itera‐
245 tions' if the maximum iteration count was exceeded.
246 nelderMead minimizes the given function using the downhill sim‐
248 plex method of Nelder and Mead. This method is quite slow -
249 much faster methods for minimization are known - but has the ad‐
250 vantage of being extremely robust in the face of problems where
251 the minimum lies in a valley of complex topology.
252 nelderMead can occasionally find itself "stuck" at a point where
254 it can make no further progress; it is recommended that the
255 caller run it at least a second time, passing as the initial
256 guess the result found by the previous call. The second run is
257 usually very fast.
258 nelderMead can be used in some cases for constrained optimiza‐
260 tion. To do this, add a large value to the objective function
261 if the parameters are outside the feasible region. To work ef‐
262 fectively in this mode, nelderMead requires that the initial
263 guess be feasible and usually requires that the feasible region
264 be convex.
265
267 Several of the above procedures take the names of procedures as argu‐
268 ments. To avoid problems with the visibility of these procedures, the
269 fully-qualified name of these procedures is determined inside the opti‐
270 mize routines. For the user this has only one consequence: the named
271 procedure must be visible in the calling procedure. For instance:
272 namespace eval ::mySpace {
275 namespace export calcfunc
276 proc calcfunc { x } { return $x }
277 }
278 #
279 # Use a fully-qualified name
280 #
281 namespace eval ::myCalc {
282 puts [min_bound_1d ::myCalc::calcfunc $begin $end]
283 }
284 #
285 # Import the name
286 #
287 namespace eval ::myCalc {
288 namespace import ::mySpace::calcfunc
289 puts [min_bound_1d calcfunc $begin $end]
290 }
291 The simple procedures minimum and maximum have been deprecated: the al‐
293 ternatives are much more flexible, robust and require less function
294 evaluations.
295
297 Let us take a few simple examples:
298 Determine the maximum of f(x) = x^3 exp(-3x), on the interval (0,10):
300 proc efunc { x } { expr {$x*$x*$x * exp(-3.0*$x)} }
303 puts "Maximum at: [::math::optimize::max_bound_1d efunc 0.0 10.0]"
304 The maximum allowed error determines the number of steps taken (with
307 each step in the iteration the interval is reduced with a factor 1/2).
308 Hence, a maximum error of 0.0001 is achieved in approximately 14 steps.
309 An example of a linear program is:
311 Optimise the expression 3x+2y, where:
313 x >= 0 and y >= 0 (implicit constraints, part of the
316 definition of linear programs)
317 x + y <= 1 (constraints specific to the problem)
319 2x + 5y <= 10
320 This problem can be solved as follows:
323 set solution [::math::optimize::solveLinearProgram { 3.0 2.0 } { { 1.0 1.0 1.0 }
327 { 2.0 5.0 10.0 } } ]
328 Note, that a constraint like:
331 x + y >= 1
334 can be turned into standard form using:
336 -x -y <= -1
339 The theory of linear programming is the subject of many a text book and
342 the Simplex algorithm that is implemented here is the best-known method
343 to solve this type of problems, but it is not the only one.
344
346 This document, and the package it describes, will undoubtedly contain
347 bugs and other problems. Please report such in the category math ::
348 optimize of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist].
349 Please also report any ideas for enhancements you may have for either
350 package and/or documentation.
351 When proposing code changes, please provide unified diffs, i.e the out‐
353 put of diff -u.
354 Note further that attachments are strongly preferred over inlined
356 patches. Attachments can be made by going to the Edit form of the
357 ticket immediately after its creation, and then using the left-most
358 button in the secondary navigation bar.
359
361 linear program, math, maximum, minimum, optimization
362
364 Mathematics
365
367 Copyright (c) 2004 Arjen Markus <arjenmarkus@users.sourceforge.net>
368 Copyright (c) 2004,2005 Kevn B. Kenny <kennykb@users.sourceforge.net>
369tcllib 1.0 math::optimize(n)