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
|
<html lang="en">
<head>
<title>Structure-based user functions - 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="up" href="Parameter-structures.html#Parameter-structures" title="Parameter structures">
<link rel="next" href="Structure_002dbased-gradients-and-Hessians.html#Structure_002dbased-gradients-and-Hessians" title="Structure-based gradients and Hessians">
<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="Structure-based-user-functions"></a>
<a name="Structure_002dbased-user-functions"></a>
<p>
Next: <a rel="next" accesskey="n" href="Structure_002dbased-gradients-and-Hessians.html#Structure_002dbased-gradients-and-Hessians">Structure-based gradients and Hessians</a>,
Up: <a rel="up" accesskey="u" href="Parameter-structures.html#Parameter-structures">Parameter structures</a>
<hr>
</div>
<h3 class="section">9.1 Specify which user functions accept parameter structures</h3>
<p><a name="index-structure_002dbased-user-functions-96"></a>
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 summary=""><tr align="left"><th valign="top">User function </th><th valign="top">Setting </th><th valign="top">Frontends
<br></th></tr><tr align="left"><td valign="top">Objective function
</td><td valign="top"><code>objf_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>
<br></td></tr><tr align="left"><td valign="top">Gradient
</td><td valign="top"><code>grad_objf_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>
<br></td></tr><tr align="left"><td valign="top">Hessian
</td><td valign="top"><code>hessian_objf_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>
<br></td></tr><tr align="left"><td valign="top">Model function
</td><td valign="top"><code>f_pstruct</code>
</td><td valign="top"><code>nonlin_residmin</code>, <code>nonlin_curvefit</code>, <code>residmin_stat</code>, <code>curvefit_stat</code>
<br></td></tr><tr align="left"><td valign="top">Jacobian
</td><td valign="top"><code>df_pstruct</code>
</td><td valign="top"><code>nonlin_residmin</code>, <code>nonlin_curvefit</code>, <code>residmin_stat</code>, <code>curvefit_stat</code>
<br></td></tr><tr align="left"><td valign="top">General inequality constraints
</td><td valign="top"><code>f_inequc_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code>
<br></td></tr><tr align="left"><td valign="top">Jacobian of general inequality constraints
</td><td valign="top"><code>df_inequc_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code>
<br></td></tr><tr align="left"><td valign="top">General equality constraints
</td><td valign="top"><code>f_equc_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code>
<br></td></tr><tr align="left"><td valign="top">Jacobian of general equality constraints
</td><td valign="top"><code>df_equc_pstruct</code>
</td><td valign="top"><code>nonlin_min</code>, <code>nonlin_residmin</code>, <code>nonlin_curvefit</code>
<br></td></tr></table>
<!-- -->
</body></html>
|
