1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
<html lang="en">
<head>
<title>Common frontend options - optim_doc</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="optim_doc">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Documentation.html#Documentation" title="Documentation">
<link rel="next" href="Common-optimization-options.html#Common-optimization-options" title="Common optimization options">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Additional documentation for the optim package for Octave.
Copyright (C) <Olaf Till <i7tiol@t-online.de>>
You can redistribute this documentation and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any
later version.
This documentation is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along
with this documentation; if not, see <http://www.gnu.org/licenses/>.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Common-frontend-options"></a>
<p>
Next: <a rel="next" accesskey="n" href="Common-optimization-options.html#Common-optimization-options">Common optimization options</a>,
Previous: <a rel="previous" accesskey="p" href="Documentation.html#Documentation">Documentation</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">7 Options common to all frontends</h2>
<p><a name="index-common-options-93"></a>
All frontends for optimization and for result statistics
(<a href="nonlin_005fmin.html#nonlin_005fmin">nonlin_min</a>, <a href="nonlin_005fresidmin.html#nonlin_005fresidmin">nonlin_residmin</a>, <a href="nonlin_005fcurvefit.html#nonlin_005fcurvefit">nonlin_curvefit</a>,
<a href="residmin_005fstat.html#residmin_005fstat">residmin_stat</a>, <a href="curvefit_005fstat.html#curvefit_005fstat">curvefit_stat</a>)accept the following options,
settable with <a href="../octave/XREFoptimset.html#XREFoptimset">optimset</a>.
<p>These options are handled within the frontend.
<dl>
<dt><code>diffp</code><dd>Column vector of fractional intervals (doubled for central intervals)
supposed to be used by gradient or Jacobian functions performing finite
differencing. Default: <code>.001 * ones (size (parameters))</code>. The
default function for finite differencing will use these as absolute
intervals for parameters with value zero.
<br><dt><code>diff_onesided</code><dd>Logical column vector indicating the parameters for which one-sided
intervals should be used by gradient or Jacobian functions performing
finite differencing. Default: <code>false (size (parameters))</code>.
<br><dt><code>cstep</code><dd>Scalar step size for complex step derivative approximation of gradients
or Jacobians. Default: 1e-20.
<br><dt><code>parallel_local</code><dd>Logical scalar, default: <code>false</code>. If the <code>parallel</code> package,
<code>version >= 2.0.5</code>, is loaded, estimate gradients of objective
function and Jacobians of model function and of constraints in parallel
processes. Works for default (real) finite differences and for complex
step derivatives. Due to overhead, a speed advantage can only be
expected if objective function, model function or constraint functions
are time consuming enough. Additionally, this setting is also passed to
the individual optimization backends, which may also consider this
option (see documentation of backends). If this option is set to
<code>true</code>, a warning (ID: <code>optim:parallel_local</code>) will be issued
if no <code>parallel</code> package of a correct version is loaded.
<br><dt><code>fixed</code><dd>Logical column vector indicating which parameters are not optimized, but
kept to their inital value.
</dl>
<!-- -->
</body></html>
|
