File: Structure_002dbased-configuration-settings.html

package info (click to toggle)
octave-optim 1.6.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 2,460 kB
  • sloc: cpp: 1,047; makefile: 216; perl: 169; xml: 29; sh: 3
file content (109 lines) | stat: -rw-r--r-- 4,828 bytes parent folder | download
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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/>. -->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Structure-based configuration settings (optim_doc)</title>

<meta name="description" content="Structure-based configuration settings (optim_doc)">
<meta name="keywords" content="Structure-based configuration settings (optim_doc)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-index.html#Function-index" rel="index" title="Function index">
<link href="Parameter-structures.html#Parameter-structures" rel="up" title="Parameter structures">
<link href="Non_002dscalar-parameters.html#Non_002dscalar-parameters" rel="next" title="Non-scalar parameters">
<link href="Structure_002dbased-linear-constraints.html#Structure_002dbased-linear-constraints" rel="prev" title="Structure-based linear constraints">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Structure_002dbased-configuration-settings"></a>
<div class="header">
<p>
Next: <a href="Non_002dscalar-parameters.html#Non_002dscalar-parameters" accesskey="n" rel="next">Non-scalar parameters</a>, Previous: <a href="Structure_002dbased-linear-constraints.html#Structure_002dbased-linear-constraints" accesskey="p" rel="prev">Structure-based linear constraints</a>, Up: <a href="Parameter-structures.html#Parameter-structures" accesskey="u" rel="up">Parameter structures</a> &nbsp; [<a href="Function-index.html#Function-index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Parameter_002drelated-configuration-settings-in-structure-form"></a>
<h3 class="section">10.4 Parameter-related configuration settings in structure form</h3>
<a name="index-structure_002dbased-configuration-settings"></a>

<p>The vector-based settings <code>lbound</code>, <code>ubound</code>, <code>fixed</code>,
<code>diffp</code>, <code>diff_onesided</code>, <code>fract_prec</code>, and
<code>max_fract_change</code> can be replaced by the setting
<code>param_config</code>.  It is a structure that can contain fields
corresponding to parameter names.  For each such field, there may be
subfields with the same names as the above vector-based settings, but
containing a scalar value for the respective parameter.
</p>
<p>For example, if the parameters are named <code>a</code> and <code>b</code>, instead
of specifying
</p>
<div class="example">
<pre class="example">settings = optimset (&quot;lbound&quot;, [-Inf; 0],
                     &quot;diff_onesided&quot;, [true; true]);
</pre></div>

<p>one can specify
</p>
<div class="example">
<pre class="example">pconf.b.lbound = 0;
pconf.a.diff_onesided = true;
pconf.b.diff_onesided = true;
settings = optimset (&quot;param_config&quot;, pconf);
</pre></div>

<p>If <code>param_config</code> is specified, none of the above vector-based
settings may be used.
</p>




</body>
</html>