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
|
<!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 user functions (optim_doc)</title>
<meta name="description" content="Structure-based user functions (optim_doc)">
<meta name="keywords" content="Structure-based user functions (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="Structure_002dbased-gradients-and-Hessians.html#Structure_002dbased-gradients-and-Hessians" rel="next" title="Structure-based gradients and Hessians">
<link href="Parameter-structures.html#Parameter-structures" rel="prev" title="Parameter structures">
<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-user-functions"></a>
<div class="header">
<p>
Next: <a href="Structure_002dbased-gradients-and-Hessians.html#Structure_002dbased-gradients-and-Hessians" accesskey="n" rel="next">Structure-based gradients and Hessians</a>, Up: <a href="Parameter-structures.html#Parameter-structures" accesskey="u" rel="up">Parameter structures</a> [<a href="Function-index.html#Function-index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Specify-which-user-functions-accept-parameter-structures"></a>
<h3 class="section">10.1 Specify which user functions accept parameter structures</h3>
<a name="index-structure_002dbased-user-functions"></a>
<p>The frontend must be told which user functions accept parameter
structures by setting corresponding settings to <code>true</code>. The names
of these settings depend on which user functions are applicable to the
respective frontend and are shown in the following table.
</p>
<table>
<thead><tr><th>User function</th><th>Setting</th><th>Frontends</th></tr></thead>
<tr><td>Objective function</td><td><code>objf_pstruct</code></td><td><code>nonlin_min</code></td></tr>
<tr><td>Gradient</td><td><code>grad_objf_pstruct</code></td><td><code>nonlin_min</code></td></tr>
<tr><td>Hessian</td><td><code>hessian_objf_pstruct</code></td><td><code>nonlin_min</code></td></tr>
<tr><td>Model function</td><td><code>f_pstruct</code></td><td><code>nonlin_residmin</code>, <code>nonlin_curvefit</code>, <code>residmin_stat</code>, <code>curvefit_stat</code></td></tr>
<tr><td>Jacobian</td><td><code>df_pstruct</code></td><td><code>nonlin_residmin</code>, <code>nonlin_curvefit</code>, <code>residmin_stat</code>, <code>curvefit_stat</code></td></tr>
<tr><td>General inequality constraints</td><td><code>f_inequc_pstruct</code></td><td><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code></td></tr>
<tr><td>Jacobian of general inequality constraints</td><td><code>df_inequc_pstruct</code></td><td><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code></td></tr>
<tr><td>General equality constraints</td><td><code>f_equc_pstruct</code></td><td><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code></td></tr>
<tr><td>Jacobian of general equality constraints</td><td><code>df_equc_pstruct</code></td><td><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code></td></tr>
</table>
</body>
</html>
|
