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
110
111
112
113
114
115
116
117
118
|
<!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>cdiff (optim_doc)</title>
<meta name="description" content="cdiff (optim_doc)">
<meta name="keywords" content="cdiff (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="Gradient-functions.html#Gradient-functions" rel="up" title="Gradient functions">
<link href="jacobs.html#jacobs" rel="next" title="jacobs">
<link href="numhessian.html#numhessian" rel="prev" title="numhessian">
<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="cdiff"></a>
<div class="header">
<p>
Next: <a href="jacobs.html#jacobs" accesskey="n" rel="next">jacobs</a>, Previous: <a href="numhessian.html#numhessian" accesskey="p" rel="prev">numhessian</a>, Up: <a href="Gradient-functions.html#Gradient-functions" accesskey="u" rel="up">Gradient functions</a> [<a href="Function-index.html#Function-index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="A-string_002c-yielding-the-numerical-gradient-if-evaluated"></a>
<h3 class="section">4.5 A string, yielding the numerical gradient if evaluated</h3>
<a name="index-cdiff"></a>
<a name="Helptext_003a-14"></a>
<h4 class="subheading">Helptext:</h4>
<a name="XREFcdiff"></a><pre class="verbatim">c = cdiff (func,wrt,N,dfunc,stack,dx) - Code for num. differentiation
= "function df = dfunc (var1,..,dvar,..,varN) .. endfunction
Returns a string of octave code that defines a function 'dfunc' that
returns the derivative of 'func' with respect to it's 'wrt'th
argument.
The derivatives are obtained by symmetric finite difference.
dfunc()'s return value is in the same format as that of ndiff()
func : string : name of the function to differentiate
wrt : int : position, in argument list, of the differentiation
variable. Default:1
N : int : total number of arguments taken by 'func'.
If N=inf, dfunc will take variable argument list.
Default:wrt
dfunc : string : Name of the octave function that returns the
derivatives. Default:['d',func]
stack : string : Indicates whether 'func' accepts vertically
(stack="rstack") or horizontally (stack="cstack")
arguments. Any other string indicates that 'func'
does not allow stacking. Default:''
dx : real : Step used in the symmetric difference scheme.
Default:10*sqrt(eps)
See also : ndiff, eval, todisk
</pre>
</body>
</html>
|
