File: vfzero.html

package info (click to toggle)
octave-optim 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 2,064 kB
  • ctags: 374
  • sloc: cpp: 1,126; perl: 158; makefile: 79
file content (108 lines) | stat: -rw-r--r-- 4,446 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
<html lang="en">
<head>
<title>vfzero - 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="Zero-finders.html#Zero-finders" title="Zero finders">
<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="vfzero"></a>
<p>
Up:&nbsp;<a rel="up" accesskey="u" href="Zero-finders.html#Zero-finders">Zero finders</a>
<hr>
</div>

<h3 class="section">3.1 A vectorized version of fzero</h3>

<p><a name="index-vfzero-70"></a>
<!-- vfzero ../inst/vfzero.m -->
<a name="XREFvfzero"></a>

<div class="defun">
&mdash; Function File:  <b>vfzero</b> (<var>fun, x0</var>)<var><a name="index-vfzero-71"></a></var><br>
&mdash; Function File:  <b>vfzero</b> (<var>fun, x0, options</var>)<var><a name="index-vfzero-72"></a></var><br>
&mdash; Function File: [<var>x</var>, <var>fval</var>, <var>info</var>, <var>output</var>] = <b>vfzero</b> (<var><small class="dots">...</small></var>)<var><a name="index-vfzero-73"></a></var><br>
<blockquote><p>A variant of <code>fzero</code>. Finds a zero of a vector-valued
multivariate function where each output element only depends on the
input element with the same index (so the Jacobian is diagonal).

        <p><var>fun</var> should be a handle or name of a function returning a column
vector.  <var>x0</var> should be a two-column matrix, each row specifying
two points which bracket a zero of the respective output element of
<var>fun</var>.

        <p>If <var>x0</var> is a single-column matrix then several nearby and distant
values are probed in an attempt to obtain a valid bracketing.  If
this is not successful, the function fails. <var>options</var> is a
structure specifying additional options. Currently, <code>vfzero</code>
recognizes these options: <code>"FunValCheck"</code>, <code>"OutputFcn"</code>,
<code>"TolX"</code>, <code>"MaxIter"</code>, <code>"MaxFunEvals"</code>. For a
description of these options, see optimset.

        <p>On exit, the function returns <var>x</var>, the approximate zero and
<var>fval</var>, the function value thereof. <var>info</var> is a column vector
of exit flags  that can have these values:

          <ul>
<li>1 The algorithm converged to a solution.

          <li>0 Maximum number of iterations or function evaluations has been
reached.

          <li>-1 The algorithm has been terminated from user output function.

          <li>-5 The algorithm may have converged to a singular point. 
</ul>

        <p><var>output</var> is a structure containing runtime information about the
<code>fzero</code> algorithm.  Fields in the structure are:

          <ul>
<li>iterations Number of iterations through loop.

          <li>nfev Number of function evaluations.

          <li>bracketx A two-column matrix with the final bracketing of the
zero along the x-axis.

          <li>brackety A two-column matrix with the final bracketing of the
zero along the y-axis. 
</ul>
        </p></blockquote></div>

<!--  -->
   </body></html>