Mercurial > hg > octave-lyh
annotate doc/interpreter/eval.txi @ 11997:5530fe42c83b release-3-2-x
update coding tips
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Thu, 18 Jun 2009 07:09:17 +0200 |
| parents | 923c7cb7f13f |
| children | 322f43e0e170 |
| rev | line source |
|---|---|
| 8920 | 1 @c Copyright (C) 1996, 1997, 2007, 2008, 2009 John W. Eaton |
| 7018 | 2 @c |
| 3 @c This file is part of Octave. | |
| 4 @c | |
| 5 @c Octave is free software; you can redistribute it and/or modify it | |
| 6 @c under the terms of the GNU General Public License as published by the | |
| 7 @c Free Software Foundation; either version 3 of the License, or (at | |
| 8 @c your option) any later version. | |
| 9 @c | |
| 10 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 @c for more details. | |
| 14 @c | |
| 15 @c You should have received a copy of the GNU General Public License | |
| 16 @c along with Octave; see the file COPYING. If not, see | |
| 17 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 18 |
| 4167 | 19 @node Evaluation |
| 3294 | 20 @chapter Evaluation |
| 21 | |
| 22 Normally, you evaluate expressions simply by typing them at the Octave | |
| 23 prompt, or by asking Octave to interpret commands that you have saved in | |
| 24 a file. | |
| 25 | |
| 26 Sometimes, you may find it necessary to evaluate an expression that has | |
| 6641 | 27 been computed and stored in a string, which is exactly what the |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
7018
diff
changeset
|
28 @code{eval} function lets you do. |
| 3294 | 29 |
| 3371 | 30 @DOCSTRING(eval) |
| 3294 | 31 |
| 6641 | 32 @menu |
| 33 * Calling a Function by its Name:: | |
| 34 * Evaluation in a Different Context:: | |
| 35 @end menu | |
| 36 | |
| 37 @node Calling a Function by its Name | |
| 38 @section Calling a Function by its Name | |
| 3294 | 39 |
| 7001 | 40 The @code{feval} function allows you to call a function from a string |
|
9037
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
41 containing its name. This is useful when writing a function that needs to |
|
4cb9f994dcec
Documentation cleanup of var.texi, expr.texi, eval.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
42 call user-supplied functions. The @code{feval} function takes the name |
| 6641 | 43 of the function to call as its first argument, and the remaining |
| 44 arguments are given to the function. | |
| 45 | |
| 46 The following example is a simple-minded function using @code{feval} | |
| 47 that finds the root of a user-supplied function of one variable using | |
| 48 Newton's method. | |
| 3294 | 49 |
| 50 @example | |
| 51 @cindex Fordyce, A. P. | |
| 52 @findex newtroot | |
| 53 function result = newtroot (fname, x) | |
| 54 | |
| 55 # usage: newtroot (fname, x) | |
| 56 # | |
| 57 # fname : a string naming a function f(x). | |
| 58 # x : initial guess | |
| 59 | |
| 60 delta = tol = sqrt (eps); | |
| 61 maxit = 200; | |
| 62 fx = feval (fname, x); | |
| 63 for i = 1:maxit | |
| 64 if (abs (fx) < tol) | |
| 65 result = x; | |
| 66 return; | |
| 67 else | |
| 68 fx_new = feval (fname, x + delta); | |
| 69 deriv = (fx_new - fx) / delta; | |
| 70 x = x - fx / deriv; | |
| 71 fx = fx_new; | |
| 72 endif | |
| 73 endfor | |
| 74 | |
| 75 result = x; | |
| 76 | |
| 77 endfunction | |
| 78 @end example | |
| 79 | |
| 80 Note that this is only meant to be an example of calling user-supplied | |
| 81 functions and should not be taken too seriously. In addition to using a | |
| 82 more robust algorithm, any serious code would check the number and type | |
| 83 of all the arguments, ensure that the supplied function really was a | |
| 6641 | 84 function, etc. @xref{Predicates for Numeric Objects}, for example, |
| 85 for a list of predicates for numeric objects, and see @ref{Status of | |
| 3294 | 86 Variables}, for a description of the @code{exist} function. |
| 6549 | 87 |
| 6641 | 88 @DOCSTRING(feval) |
| 89 | |
| 6863 | 90 A similar function @code{run} exists for calling user script files, that |
| 91 are not necessarily on the user path | |
| 92 | |
| 93 @DOCSTRING(run) | |
| 94 | |
| 6641 | 95 @node Evaluation in a Different Context |
| 96 @section Evaluation in a Different Context | |
| 97 | |
| 98 Before you evaluate an expression you need to substitute | |
| 99 the values of the variables used in the expression. These | |
| 100 are stored in the symbol table. Whenever the interpreter | |
| 101 starts a new function it saves the current symbol table | |
| 102 and creates a new one, initializing it with the list of | |
| 103 function parameters and a couple of predefined variables | |
| 104 such as @code{nargin}. Expressions inside the function use the | |
| 105 new symbol table. | |
| 106 | |
| 107 Sometimes you want to write a function so that when you | |
| 108 call it, it modifies variables in your own context. This | |
| 109 allows you to use a pass-by-name style of function, | |
| 110 which is similar to using a pointer in programming languages such | |
| 111 as C. | |
| 112 | |
| 113 Consider how you might write @code{save} and @code{load} as | |
| 114 m-files. For example, | |
| 115 | |
| 116 @example | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
117 @group |
| 6641 | 118 function create_data |
| 119 x = linspace (0, 10, 10); | |
| 120 y = sin (x); | |
| 121 save mydata x y | |
| 122 endfunction | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
123 @end group |
| 6641 | 124 @end example |
| 125 | |
| 8828 | 126 With @code{evalin}, you could write @code{save} as follows: |
| 6641 | 127 |
| 128 @example | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
129 @group |
| 6641 | 130 function save (file, name1, name2) |
| 131 f = open_save_file (file); | |
| 132 save_var(f, name1, evalin ("caller", name1)); | |
| 133 save_var(f, name2, evalin ("caller", name2)); | |
| 134 endfunction | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
135 @end group |
| 6641 | 136 @end example |
| 137 | |
| 138 @noindent | |
| 139 Here, @samp{caller} is the @code{create_data} function and @code{name1} | |
| 140 is the string @code{"x"}, which evaluates simply as the value of @code{x}. | |
| 141 | |
| 142 You later want to load the values back from @code{mydata} | |
| 143 in a different context: | |
| 144 | |
| 145 @example | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
146 @group |
| 6641 | 147 function process_data |
| 148 load mydata | |
| 149 @dots{} do work @dots{} | |
| 150 endfunction | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
151 @end group |
| 6641 | 152 @end example |
| 153 | |
| 154 @noindent | |
| 155 With @code{assignin}, you could write @code{load} as follows: | |
| 156 | |
| 157 @example | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
158 @group |
| 6641 | 159 function load (file) |
| 160 f = open_load_file (file); | |
| 161 [name, val] = load_var (f); | |
| 162 assignin ("caller", name, val); | |
| 163 [name, val] = load_var (f); | |
| 164 assignin ("caller", name, val); | |
| 165 endfunction | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9037
diff
changeset
|
166 @end group |
| 6641 | 167 @end example |
| 168 | |
| 169 @noindent | |
| 170 Here, @samp{caller} is the @code{process_data} function. | |
| 171 | |
| 172 You can set and use variables at the command prompt | |
| 173 using the context @samp{base} rather than @samp{caller}. | |
| 174 | |
| 175 These functions are rarely used in practice. One | |
| 176 example is the @code{fail (@samp{code}, @samp{pattern})} function | |
| 177 which evaluates @samp{code} in the caller's context and | |
| 178 checks that the error message it produces matches | |
| 179 the given pattern. Other examples such as @code{save} and @code{load} | |
|
8481
00df69d7e698
[docs] capitalize Octave consistently
Brian Gough <bjg@gnu.org>
parents:
8347
diff
changeset
|
180 are written in C++ where all Octave variables |
| 6641 | 181 are in the @samp{caller} context and @code{evalin} is not needed. |
| 182 | |
| 6549 | 183 @DOCSTRING(evalin) |
| 184 | |
| 185 @DOCSTRING(assignin) |