Mercurial > octave-nkf
annotate doc/interpreter/func.txi @ 14116:951eacaf9381 stable
Initial documentation for broadcasting and general vectorization guidelines
* vectorize.txi: New file.
* NEWS: Update with location of broadcasting documentation.
* Makefile.am: Add vectorize.texi
* arith.txi: Move accumarray and accumdim docstring to vectorize.txi
* container.txi: Move structfun docstring to vectorize.txi
* expr.txi: Mention broadcasting where relevant.
* func.txi: Move vectorize docstring to vectorize.txi
* matrix.txi: Move function application section to vectorize.txi
* octave.texi: Add vectorize.txi and its menu options
* sparse.txi: Move spfun to vectorize.txi
* tips.txi: Move and rewrite coding tips section in vectorize.txi
* bsxfun.h (is_valid_bsxfun, is_valid_inplace_bsxfun): Rename warning
to "Octave:broadcast"
* accumdim.m: Reformat to use @example in lieu of @smallexample
* warning_ids.m: Add Octave:broadcast
* bsxfun.cc: Reword docstring to mention broadcasting
* cellfun.cc: Move comment about efficiency from tips.txi
* version.h.in: Add a big startup warning about broadcasting
author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
---|---|
date | Tue, 27 Dec 2011 15:15:41 -0500 |
parents | b0cdd60db5e5 |
children | b25559bd5aaa |
rev | line source |
---|---|
11523 | 1 @c Copyright (C) 1996-2011 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 Functions and Scripts |
9032
349616d9c38e
Cleanup top-level documentation menu in octave.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
20 @chapter Functions and Scripts |
3294 | 21 @cindex defining functions |
22 @cindex user-defined functions | |
23 @cindex functions, user-defined | |
24 @cindex script files | |
25 | |
26 Complicated Octave programs can often be simplified by defining | |
27 functions. Functions can be defined directly on the command line during | |
28 interactive Octave sessions, or in external files, and can be called just | |
29 like built-in functions. | |
30 | |
31 @menu | |
32 * Defining Functions:: | |
33 * Multiple Return Values:: | |
34 * Variable-length Argument Lists:: | |
10209
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
35 * Ignoring Arguments:: |
3294 | 36 * Variable-length Return Lists:: |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
37 * Returning from a Function:: |
6510 | 38 * Default Arguments:: |
3294 | 39 * Function Files:: |
40 * Script Files:: | |
6638 | 41 * Function Handles Inline Functions and Anonymous Functions:: |
6549 | 42 * Commands:: |
3294 | 43 * Organization of Functions:: |
44 @end menu | |
45 | |
4167 | 46 @node Defining Functions |
3294 | 47 @section Defining Functions |
48 @cindex @code{function} statement | |
49 @cindex @code{endfunction} statement | |
50 | |
51 In its simplest form, the definition of a function named @var{name} | |
52 looks like this: | |
53 | |
54 @example | |
55 @group | |
56 function @var{name} | |
57 @var{body} | |
58 endfunction | |
59 @end group | |
60 @end example | |
61 | |
62 @noindent | |
63 A valid function name is like a valid variable name: a sequence of | |
64 letters, digits and underscores, not starting with a digit. Functions | |
65 share the same pool of names as variables. | |
66 | |
67 The function @var{body} consists of Octave statements. It is the | |
68 most important part of the definition, because it says what the function | |
69 should actually @emph{do}. | |
70 | |
71 For example, here is a function that, when executed, will ring the bell | |
72 on your terminal (assuming that it is possible to do so): | |
73 | |
74 @example | |
75 @group | |
76 function wakeup | |
77 printf ("\a"); | |
78 endfunction | |
79 @end group | |
80 @end example | |
81 | |
82 The @code{printf} statement (@pxref{Input and Output}) simply tells | |
83 Octave to print the string @code{"\a"}. The special character @samp{\a} | |
84 stands for the alert character (ASCII 7). @xref{Strings}. | |
85 | |
86 Once this function is defined, you can ask Octave to evaluate it by | |
87 typing the name of the function. | |
88 | |
89 Normally, you will want to pass some information to the functions you | |
90 define. The syntax for passing parameters to a function in Octave is | |
91 | |
92 @example | |
93 @group | |
94 function @var{name} (@var{arg-list}) | |
95 @var{body} | |
96 endfunction | |
97 @end group | |
98 @end example | |
99 | |
100 @noindent | |
101 where @var{arg-list} is a comma-separated list of the function's | |
102 arguments. When the function is called, the argument names are used to | |
103 hold the argument values given in the call. The list of arguments may | |
104 be empty, in which case this form is equivalent to the one shown above. | |
105 | |
106 To print a message along with ringing the bell, you might modify the | |
6510 | 107 @code{wakeup} to look like this: |
3294 | 108 |
109 @example | |
110 @group | |
111 function wakeup (message) | |
112 printf ("\a%s\n", message); | |
113 endfunction | |
114 @end group | |
115 @end example | |
116 | |
117 Calling this function using a statement like this | |
118 | |
119 @example | |
120 wakeup ("Rise and shine!"); | |
121 @end example | |
122 | |
123 @noindent | |
124 will cause Octave to ring your terminal's bell and print the message | |
125 @samp{Rise and shine!}, followed by a newline character (the @samp{\n} | |
126 in the first argument to the @code{printf} statement). | |
127 | |
128 In most cases, you will also want to get some information back from the | |
129 functions you define. Here is the syntax for writing a function that | |
130 returns a single value: | |
131 | |
132 @example | |
133 @group | |
134 function @var{ret-var} = @var{name} (@var{arg-list}) | |
135 @var{body} | |
136 endfunction | |
137 @end group | |
138 @end example | |
139 | |
140 @noindent | |
141 The symbol @var{ret-var} is the name of the variable that will hold the | |
142 value to be returned by the function. This variable must be defined | |
143 before the end of the function body in order for the function to return | |
144 a value. | |
145 | |
146 Variables used in the body of a function are local to the | |
147 function. Variables named in @var{arg-list} and @var{ret-var} are also | |
148 local to the function. @xref{Global Variables}, for information about | |
149 how to access global variables inside a function. | |
150 | |
151 For example, here is a function that computes the average of the | |
152 elements of a vector: | |
153 | |
154 @example | |
155 @group | |
156 function retval = avg (v) | |
157 retval = sum (v) / length (v); | |
158 endfunction | |
159 @end group | |
160 @end example | |
161 | |
162 If we had written @code{avg} like this instead, | |
163 | |
164 @example | |
165 @group | |
166 function retval = avg (v) | |
4029 | 167 if (isvector (v)) |
3294 | 168 retval = sum (v) / length (v); |
169 endif | |
170 endfunction | |
171 @end group | |
172 @end example | |
173 | |
174 @noindent | |
175 and then called the function with a matrix instead of a vector as the | |
176 argument, Octave would have printed an error message like this: | |
177 | |
178 @example | |
179 @group | |
8015
30629059b72d
Update the manual to reflect the changes in error output
sh@sh-laptop
parents:
7984
diff
changeset
|
180 error: value on right hand side of assignment is undefined |
3294 | 181 @end group |
182 @end example | |
183 | |
184 @noindent | |
185 because the body of the @code{if} statement was never executed, and | |
186 @code{retval} was never defined. To prevent obscure errors like this, | |
187 it is a good idea to always make sure that the return variables will | |
188 always have values, and to produce meaningful error messages when | |
189 problems are encountered. For example, @code{avg} could have been | |
190 written like this: | |
191 | |
192 @example | |
193 @group | |
194 function retval = avg (v) | |
195 retval = 0; | |
4029 | 196 if (isvector (v)) |
3294 | 197 retval = sum (v) / length (v); |
198 else | |
199 error ("avg: expecting vector argument"); | |
200 endif | |
201 endfunction | |
202 @end group | |
203 @end example | |
204 | |
205 There is still one additional problem with this function. What if it is | |
206 called without an argument? Without additional error checking, Octave | |
207 will probably print an error message that won't really help you track | |
208 down the source of the error. To allow you to catch errors like this, | |
209 Octave provides each function with an automatic variable called | |
210 @code{nargin}. Each time a function is called, @code{nargin} is | |
211 automatically initialized to the number of arguments that have actually | |
212 been passed to the function. For example, we might rewrite the | |
213 @code{avg} function like this: | |
214 | |
215 @example | |
216 @group | |
217 function retval = avg (v) | |
218 retval = 0; | |
219 if (nargin != 1) | |
220 usage ("avg (vector)"); | |
221 endif | |
4029 | 222 if (isvector (v)) |
3294 | 223 retval = sum (v) / length (v); |
224 else | |
225 error ("avg: expecting vector argument"); | |
226 endif | |
227 endfunction | |
228 @end group | |
229 @end example | |
230 | |
231 Although Octave does not automatically report an error if you call a | |
232 function with more arguments than expected, doing so probably indicates | |
233 that something is wrong. Octave also does not automatically report an | |
234 error if a function is called with too few arguments, but any attempt to | |
235 use a variable that has not been given a value will result in an error. | |
236 To avoid such problems and to provide useful messages, we check for both | |
237 possibilities and issue our own error message. | |
238 | |
4700 | 239 @DOCSTRING(nargin) |
3294 | 240 |
6558 | 241 @DOCSTRING(inputname) |
242 | |
3371 | 243 @DOCSTRING(silent_functions) |
3294 | 244 |
4167 | 245 @node Multiple Return Values |
3294 | 246 @section Multiple Return Values |
247 | |
248 Unlike many other computer languages, Octave allows you to define | |
249 functions that return more than one value. The syntax for defining | |
250 functions that return multiple values is | |
251 | |
252 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
253 @group |
3294 | 254 function [@var{ret-list}] = @var{name} (@var{arg-list}) |
255 @var{body} | |
256 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
257 @end group |
3294 | 258 @end example |
259 | |
260 @noindent | |
261 where @var{name}, @var{arg-list}, and @var{body} have the same meaning | |
262 as before, and @var{ret-list} is a comma-separated list of variable | |
263 names that will hold the values returned from the function. The list of | |
264 return values must have at least one element. If @var{ret-list} has | |
265 only one element, this form of the @code{function} statement is | |
266 equivalent to the form described in the previous section. | |
267 | |
268 Here is an example of a function that returns two values, the maximum | |
269 element of a vector and the index of its first occurrence in the vector. | |
270 | |
271 @example | |
272 @group | |
273 function [max, idx] = vmax (v) | |
274 idx = 1; | |
275 max = v (idx); | |
276 for i = 2:length (v) | |
277 if (v (i) > max) | |
278 max = v (i); | |
279 idx = i; | |
280 endif | |
281 endfor | |
282 endfunction | |
283 @end group | |
284 @end example | |
285 | |
286 In this particular case, the two values could have been returned as | |
287 elements of a single array, but that is not always possible or | |
288 convenient. The values to be returned may not have compatible | |
289 dimensions, and it is often desirable to give the individual return | |
290 values distinct names. | |
291 | |
13749
62d1f56b0be7
New nthargout function
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12642
diff
changeset
|
292 It is possible to use the @code{nthargout} function to obtain only some |
14038
b0cdd60db5e5
doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
13852
diff
changeset
|
293 of the return values or several at once in a cell array. |
b0cdd60db5e5
doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
13852
diff
changeset
|
294 @ref{Cell Array Objects} |
13749
62d1f56b0be7
New nthargout function
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12642
diff
changeset
|
295 |
62d1f56b0be7
New nthargout function
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12642
diff
changeset
|
296 @DOCSTRING(nthargout) |
62d1f56b0be7
New nthargout function
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12642
diff
changeset
|
297 |
3294 | 298 In addition to setting @code{nargin} each time a function is called, |
299 Octave also automatically initializes @code{nargout} to the number of | |
300 values that are expected to be returned. This allows you to write | |
301 functions that behave differently depending on the number of values that | |
302 the user of the function has requested. The implicit assignment to the | |
303 built-in variable @code{ans} does not figure in the count of output | |
304 arguments, so the value of @code{nargout} may be zero. | |
305 | |
306 The @code{svd} and @code{lu} functions are examples of built-in | |
307 functions that behave differently depending on the value of | |
308 @code{nargout}. | |
309 | |
310 It is possible to write functions that only set some return values. For | |
311 example, calling the function | |
312 | |
313 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
314 @group |
3294 | 315 function [x, y, z] = f () |
316 x = 1; | |
317 z = 2; | |
318 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
319 @end group |
3294 | 320 @end example |
321 | |
322 @noindent | |
323 as | |
324 | |
325 @example | |
326 [a, b, c] = f () | |
327 @end example | |
328 | |
329 @noindent | |
330 produces: | |
331 | |
332 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
333 @group |
3294 | 334 a = 1 |
335 | |
336 b = [](0x0) | |
337 | |
338 c = 2 | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
339 @end group |
3294 | 340 @end example |
341 | |
342 @noindent | |
6501 | 343 along with a warning. |
3294 | 344 |
4700 | 345 @DOCSTRING(nargout) |
3294 | 346 |
12629
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
347 It is good practice at the head of a function to verify that it has been called |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
348 correctly. In Octave the following idiom is seen frequently |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
349 |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
350 @example |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
351 @group |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
352 if (nargin < min_#_inputs || nargin > max_#_inputs) |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
353 print_usage (); |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
354 endif |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
355 @end group |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
356 @end example |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
357 |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
358 @noindent |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
359 which stops the function execution and prints a message about the correct |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
360 way to call the function whenever the number of inputs is wrong. |
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
361 |
13852
e36817e2ee60
New function narginchk
Carnë Draug <carandraug+dev@gmail.com>
parents:
13749
diff
changeset
|
362 For compatibility with @sc{matlab}, @code{nargchk}, @code{narginchk} and |
e36817e2ee60
New function narginchk
Carnë Draug <carandraug+dev@gmail.com>
parents:
13749
diff
changeset
|
363 @code{nargoutchk} are available which provide similar error checking. |
12629
8c25df502846
func.txi: document use of nargin checking at head of function.
Rik <octave@nomad.inbox5.com>
parents:
12592
diff
changeset
|
364 |
3371 | 365 @DOCSTRING(nargchk) |
3294 | 366 |
13852
e36817e2ee60
New function narginchk
Carnë Draug <carandraug+dev@gmail.com>
parents:
13749
diff
changeset
|
367 @DOCSTRING(narginchk) |
e36817e2ee60
New function narginchk
Carnë Draug <carandraug+dev@gmail.com>
parents:
13749
diff
changeset
|
368 |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
369 @DOCSTRING(nargoutchk) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
370 |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8276
diff
changeset
|
371 @anchor{doc-varargin} @anchor{doc-varargout} |
4167 | 372 @node Variable-length Argument Lists |
3294 | 373 @section Variable-length Argument Lists |
4933 | 374 @cindex variable-length argument lists |
8567 | 375 @cindex @code{varargin} |
8072 | 376 |
6510 | 377 Sometimes the number of input arguments is not known when the function |
378 is defined. As an example think of a function that returns the smallest | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
379 of all its input arguments. For example: |
6510 | 380 |
381 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
382 @group |
6510 | 383 a = smallest (1, 2, 3); |
384 b = smallest (1, 2, 3, 4); | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
385 @end group |
6510 | 386 @end example |
387 | |
388 @noindent | |
389 In this example both @code{a} and @code{b} would be 1. One way to write | |
390 the @code{smallest} function is | |
391 | |
392 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
393 @group |
6510 | 394 function val = smallest (arg1, arg2, arg3, arg4, arg5) |
395 @var{body} | |
396 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
397 @end group |
6510 | 398 @end example |
399 | |
400 @noindent | |
401 and then use the value of @code{nargin} to determine which of the input | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
402 arguments should be considered. The problem with this approach is |
6510 | 403 that it can only handle a limited number of input arguments. |
404 | |
7588
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
405 If the special parameter name @code{varargin} appears at the end of a |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
406 function parameter list it indicates that the function takes a variable |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
407 number of input arguments. Using @code{varargin} the function |
6510 | 408 looks like this |
409 | |
410 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
411 @group |
6510 | 412 function val = smallest (varargin) |
413 @var{body} | |
414 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
415 @end group |
6510 | 416 @end example |
417 | |
418 @noindent | |
419 In the function body the input arguments can be accessed through the | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
420 variable @code{varargin}. This variable is a cell array containing |
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
421 all the input arguments. @xref{Cell Arrays}, for details on working |
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
422 with cell arrays. The @code{smallest} function can now be defined |
6510 | 423 like this |
424 | |
425 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
426 @group |
6510 | 427 function val = smallest (varargin) |
428 val = min ([varargin@{:@}]); | |
429 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
430 @end group |
6510 | 431 @end example |
432 | |
433 @noindent | |
434 This implementation handles any number of input arguments, but it's also | |
435 a very simple solution to the problem. | |
436 | |
437 A slightly more complex example of @code{varargin} is a function | |
438 @code{print_arguments} that prints all input arguments. Such a function | |
439 can be defined like this | |
440 | |
441 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
442 @group |
6510 | 443 function print_arguments (varargin) |
444 for i = 1:length (varargin) | |
445 printf ("Input argument %d: ", i); | |
446 disp (varargin@{i@}); | |
447 endfor | |
448 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
449 @end group |
6510 | 450 @end example |
451 | |
452 @noindent | |
453 This function produces output like this | |
454 | |
455 @example | |
456 @group | |
457 print_arguments (1, "two", 3); | |
458 @print{} Input argument 1: 1 | |
459 @print{} Input argument 2: two | |
460 @print{} Input argument 3: 3 | |
461 @end group | |
462 @end example | |
3294 | 463 |
6558 | 464 @DOCSTRING(parseparams) |
465 | |
10209
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
466 @node Ignoring Arguments |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
467 @section Ignoring Arguments |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
468 |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
469 In the formal argument list, it is possible to use the dummy placeholder |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
470 @code{~} instead of a name. This indicates that the corresponding argument |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
471 value should be ignored and not stored to any variable. |
10209
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
472 |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
473 @example |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
474 @group |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
475 function val = pick2nd (~, arg2) |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
476 val = arg2; |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
477 endfunction |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
478 @end group |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
479 @end example |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
480 |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
481 The value of @code{nargin} is not affected by using this declaration. |
ea0d83b4470b
document use of ~ placeholders in the manual
Jaroslav Hajek <highegg@gmail.com>
parents:
9209
diff
changeset
|
482 |
12592
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
483 Return arguments can also be ignored using the same syntax. Functions may |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
484 take advantage of ignored outputs to reduce the number of calculations |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
485 performed. To do so, use the @code{isargout} function to query whether the |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
486 output argument is wanted. For example: |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
487 |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
488 @example |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
489 @group |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
490 function [out1, out2] = long_function (x, y, z) |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
491 if (isargout (1)) |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
492 ## Long calculation |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
493 @dots{} |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
494 out1 = result; |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
495 endif |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
496 @dots{} |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
497 endfunction |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
498 @end group |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
499 @end example |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
500 |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
501 @DOCSTRING(isargout) |
732a568bf694
Modify func.txi discussion of output arguments to include discussion of isargout.
Rik <octave@nomad.inbox5.com>
parents:
11573
diff
changeset
|
502 |
4167 | 503 @node Variable-length Return Lists |
3294 | 504 @section Variable-length Return Lists |
4933 | 505 @cindex variable-length return lists |
8567 | 506 @cindex @code{varargout} |
8072 | 507 |
6510 | 508 It is possible to return a variable number of output arguments from a |
509 function using a syntax that's similar to the one used with the | |
7588
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
510 special @code{varargin} parameter name. To let a function return a |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
511 variable number of output arguments the special output parameter name |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
512 @code{varargout} is used. As with @code{varargin}, @code{varargout} is |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
513 a cell array that will contain the requested output arguments. |
6510 | 514 |
515 As an example the following function sets the first output argument to | |
516 1, the second to 2, and so on. | |
517 | |
518 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
519 @group |
6510 | 520 function varargout = one_to_n () |
521 for i = 1:nargout | |
522 varargout@{i@} = i; | |
523 endfor | |
524 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
525 @end group |
6510 | 526 @end example |
527 | |
528 @noindent | |
529 When called this function returns values like this | |
530 | |
531 @example | |
532 @group | |
533 [a, b, c] = one_to_n () | |
534 @result{} a = 1 | |
535 @result{} b = 2 | |
536 @result{} c = 3 | |
537 @end group | |
538 @end example | |
3294 | 539 |
7588
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
540 If @code{varargin} (@code{varargout}) does not appear as the last |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
541 element of the input (output) parameter list, then it is not special, |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
542 and is handled the same as any other parameter name. |
cbedf652a752
doc fix for varargin and varargout change
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
543 |
6558 | 544 @DOCSTRING(deal) |
545 | |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
546 @node Returning from a Function |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
547 @section Returning from a Function |
3294 | 548 |
549 The body of a user-defined function can contain a @code{return} statement. | |
550 This statement returns control to the rest of the Octave program. It | |
551 looks like this: | |
552 | |
553 @example | |
554 return | |
555 @end example | |
556 | |
557 Unlike the @code{return} statement in C, Octave's @code{return} | |
558 statement cannot be used to return a value from a function. Instead, | |
559 you must assign values to the list of return variables that are part of | |
560 the @code{function} statement. The @code{return} statement simply makes | |
561 it easier to exit a function from a deeply nested loop or conditional | |
562 statement. | |
563 | |
564 Here is an example of a function that checks to see if any elements of a | |
565 vector are nonzero. | |
566 | |
567 @example | |
568 @group | |
569 function retval = any_nonzero (v) | |
570 retval = 0; | |
571 for i = 1:length (v) | |
572 if (v (i) != 0) | |
573 retval = 1; | |
574 return; | |
575 endif | |
576 endfor | |
577 printf ("no nonzero elements found\n"); | |
578 endfunction | |
579 @end group | |
580 @end example | |
581 | |
582 Note that this function could not have been written using the | |
583 @code{break} statement to exit the loop once a nonzero value is found | |
584 without adding extra logic to avoid printing the message if the vector | |
585 does contain a nonzero element. | |
586 | |
11547 | 587 @deftypefn {Keyword} {} return |
3294 | 588 When Octave encounters the keyword @code{return} inside a function or |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
589 script, it returns control to the caller immediately. At the top level, |
3294 | 590 the return statement is ignored. A @code{return} statement is assumed |
591 at the end of every function definition. | |
11547 | 592 @end deftypefn |
3294 | 593 |
6510 | 594 @node Default Arguments |
595 @section Default Arguments | |
596 @cindex default arguments | |
597 | |
598 Since Octave supports variable number of input arguments, it is very useful | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
599 to assign default values to some input arguments. When an input argument |
6510 | 600 is declared in the argument list it is possible to assign a default |
601 value to the argument like this | |
602 | |
603 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
604 @group |
6510 | 605 function @var{name} (@var{arg1} = @var{val1}, @dots{}) |
606 @var{body} | |
607 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
608 @end group |
6510 | 609 @end example |
610 | |
611 @noindent | |
612 If no value is assigned to @var{arg1} by the user, it will have the | |
613 value @var{val1}. | |
614 | |
615 As an example, the following function implements a variant of the classic | |
616 ``Hello, World'' program. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
617 |
6510 | 618 @example |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
619 @group |
6510 | 620 function hello (who = "World") |
621 printf ("Hello, %s!\n", who); | |
622 endfunction | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
623 @end group |
6510 | 624 @end example |
625 | |
626 @noindent | |
627 When called without an input argument the function prints the following | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
628 |
6510 | 629 @example |
630 @group | |
631 hello (); | |
632 @print{} Hello, World! | |
633 @end group | |
634 @end example | |
635 | |
636 @noindent | |
637 and when it's called with an input argument it prints the following | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
638 |
6510 | 639 @example |
640 @group | |
641 hello ("Beautiful World of Free Software"); | |
642 @print{} Hello, Beautiful World of Free Software! | |
643 @end group | |
644 @end example | |
645 | |
646 Sometimes it is useful to explicitly tell Octave to use the default value | |
647 of an input argument. This can be done writing a @samp{:} as the value | |
648 of the input argument when calling the function. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
649 |
6510 | 650 @example |
651 @group | |
652 hello (:); | |
653 @print{} Hello, World! | |
654 @end group | |
655 @end example | |
656 | |
4167 | 657 @node Function Files |
3294 | 658 @section Function Files |
659 @cindex function file | |
660 | |
661 Except for simple one-shot programs, it is not practical to have to | |
662 define all the functions you need each time you need them. Instead, you | |
663 will normally want to save them in a file so that you can easily edit | |
664 them, and save them for use at a later time. | |
665 | |
666 Octave does not require you to load function definitions from files | |
667 before using them. You simply need to put the function definitions in a | |
668 place where Octave can find them. | |
669 | |
670 When Octave encounters an identifier that is undefined, it first looks | |
671 for variables or functions that are already compiled and currently | |
672 listed in its symbol table. If it fails to find a definition there, it | |
6556 | 673 searches a list of directories (the @dfn{path}) for files ending in |
6554 | 674 @file{.m} that have the same base name as the undefined |
675 identifier.@footnote{The @samp{.m} suffix was chosen for compatibility | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
676 with @sc{matlab}.} Once Octave finds a file with a name that matches, |
6554 | 677 the contents of the file are read. If it defines a @emph{single} |
678 function, it is compiled and executed. @xref{Script Files}, for more | |
679 information about how you can define more than one function in a single | |
680 file. | |
3294 | 681 |
682 When Octave defines a function from a function file, it saves the full | |
6554 | 683 name of the file it read and the time stamp on the file. If the time |
684 stamp on the file changes, Octave may reload the file. When Octave is | |
685 running interactively, time stamp checking normally happens at most once | |
686 each time Octave prints the prompt. Searching for new function | |
687 definitions also occurs if the current working directory changes. | |
3294 | 688 |
689 Checking the time stamp allows you to edit the definition of a function | |
690 while Octave is running, and automatically use the new function | |
6554 | 691 definition without having to restart your Octave session. |
3294 | 692 |
693 To avoid degrading performance unnecessarily by checking the time stamps | |
694 on functions that are not likely to change, Octave assumes that function | |
695 files in the directory tree | |
696 @file{@var{octave-home}/share/octave/@var{version}/m} | |
697 will not change, so it doesn't have to check their time stamps every time the | |
698 functions defined in those files are used. This is normally a very good | |
699 assumption and provides a significant improvement in performance for the | |
700 function files that are distributed with Octave. | |
701 | |
702 If you know that your own function files will not change while you are | |
6554 | 703 running Octave, you can improve performance by calling |
704 @code{ignore_function_time_stamp ("all")}, so that Octave will | |
705 ignore the time stamps for all function files. Passing | |
706 @code{"system"} to this function resets the default behavior. | |
3294 | 707 |
5775 | 708 @c FIXME -- note about time stamps on files in NFS environments? |
3294 | 709 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
710 @DOCSTRING(edit) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
711 |
6549 | 712 @DOCSTRING(mfilename) |
713 | |
6638 | 714 @DOCSTRING(ignore_function_time_stamp) |
715 | |
716 @menu | |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
717 * Manipulating the Load Path:: |
6638 | 718 * Subfunctions:: |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
719 * Private Functions:: |
6638 | 720 * Overloading and Autoloading:: |
721 * Function Locking:: | |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
722 * Function Precedence:: |
6638 | 723 @end menu |
724 | |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
725 @node Manipulating the Load Path |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
726 @subsection Manipulating the Load Path |
6638 | 727 |
8828 | 728 When a function is called, Octave searches a list of directories for |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
729 a file that contains the function declaration. This list of directories |
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
730 is known as the load path. By default the load path contains |
6638 | 731 a list of directories distributed with Octave plus the current |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
732 working directory. To see your current load path call the @code{path} |
6638 | 733 function without any input or output arguments. |
734 | |
735 It is possible to add or remove directories to or from the load path | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
736 using @code{addpath} and @code{rmpath}. As an example, the following |
6638 | 737 code adds @samp{~/Octave} to the load path. |
738 | |
739 @example | |
740 addpath("~/Octave") | |
741 @end example | |
742 | |
743 @noindent | |
744 After this the directory @samp{~/Octave} will be searched for functions. | |
745 | |
6502 | 746 @DOCSTRING(addpath) |
747 | |
748 @DOCSTRING(genpath) | |
749 | |
750 @DOCSTRING(rmpath) | |
751 | |
752 @DOCSTRING(savepath) | |
753 | |
6477 | 754 @DOCSTRING(path) |
3294 | 755 |
6502 | 756 @DOCSTRING(pathdef) |
757 | |
758 @DOCSTRING(pathsep) | |
759 | |
3428 | 760 @DOCSTRING(rehash) |
761 | |
762 @DOCSTRING(file_in_loadpath) | |
763 | |
7638
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7588
diff
changeset
|
764 @DOCSTRING(restoredefaultpath) |
2df457529cfa
implement expm1 and log1p functions
Jaroslav Hajek <highegg@gmail.com>
parents:
7588
diff
changeset
|
765 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
766 @DOCSTRING(command_line_path) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
767 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
768 @DOCSTRING(find_dir_in_path) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8567
diff
changeset
|
769 |
6556 | 770 @node Subfunctions |
771 @subsection Subfunctions | |
772 | |
773 A function file may contain secondary functions called | |
774 @dfn{subfunctions}. These secondary functions are only visible to the | |
775 other functions in the same function file. For example, a file | |
776 @file{f.m} containing | |
777 | |
778 @example | |
779 @group | |
780 function f () | |
781 printf ("in f, calling g\n"); | |
782 g () | |
783 endfunction | |
784 function g () | |
785 printf ("in g, calling h\n"); | |
6638 | 786 h () |
6556 | 787 endfunction |
788 function h () | |
789 printf ("in h\n") | |
790 endfunction | |
791 @end group | |
792 @end example | |
793 | |
794 @noindent | |
795 defines a main function @code{f} and two subfunctions. The | |
796 subfunctions @code{g} and @code{h} may only be called from the main | |
797 function @code{f} or from the other subfunctions, but not from outside | |
798 the file @file{f.m}. | |
799 | |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
800 @node Private Functions |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
801 @subsection Private Functions |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
802 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
803 In many cases one function needs to access one or more helper |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
804 functions. If the helper function is limited to the scope of a single |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
805 function, then subfunctions as discussed above might be used. However, |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
806 if a single helper function is used by more than one function, then |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
807 this is no longer possible. In this case the helper functions might |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
808 be placed in a subdirectory, called "private", of the directory in which |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
809 the functions needing access to this helper function are found. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
810 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
811 As a simple example, consider a function @code{func1}, that calls a helper |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
812 function @code{func2} to do much of the work. For example: |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
813 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
814 @example |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
815 @group |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
816 function y = func1 (x) |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
817 y = func2 (x); |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
818 endfunction |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
819 @end group |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
820 @end example |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
821 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
822 @noindent |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
823 Then if the path to @code{func1} is @code{<directory>/func1.m}, and if |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
824 @code{func2} is found in the directory @code{<directory>/private/func2.m}, |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
825 then @code{func2} is only available for use of the functions, like |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
826 @code{func1}, that are found in @code{<directory>}. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
827 |
6635 | 828 @node Overloading and Autoloading |
829 @subsection Overloading and Autoloading | |
830 | |
11396
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
831 Functions can be overloaded to work with different input arguments. For |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
832 example, the operator '+' has been overloaded in Octave to work with single, |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
833 double, uint8, int32, and many other arguments. The preferred way to overload |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
834 functions is through classes and object oriented programming |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
835 (@pxref{Function Overloading}). Occasionally, however, one needs to undo |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
836 user overloading and call the default function associated with a specific |
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
837 type. The @code{builtin} function exists for this purpose. |
6635 | 838 |
839 @DOCSTRING(builtin) | |
840 | |
841 A single dynamically linked file might define several | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
842 functions. However, as Octave searches for functions based on the |
6635 | 843 functions filename, Octave needs a manner in which to find each of the |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
844 functions in the dynamically linked file. On operating systems that |
6635 | 845 support symbolic links, it is possible to create a symbolic link to the |
846 original file for each of the functions which it contains. | |
847 | |
848 However, there is at least one well known operating system that doesn't | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
849 support symbolic links. Making copies of the original file for each of |
8828 | 850 the functions is undesirable as it increases the |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
851 amount of disk space used by Octave. Instead Octave supplies the |
6635 | 852 @code{autoload} function, that permits the user to define in which |
853 file a certain function will be found. | |
854 | |
855 @DOCSTRING(autoload) | |
856 | |
857 @node Function Locking | |
858 @subsection Function Locking | |
859 | |
860 It is sometime desirable to lock a function into memory with the | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
861 @code{mlock} function. This is typically used for dynamically linked |
6899 | 862 functions in Oct-files or mex-files that contain some initialization, |
863 and it is desirable that calling @code{clear} does not remove this | |
6635 | 864 initialization. |
865 | |
6899 | 866 As an example, |
867 | |
868 @example | |
869 mlock ("my_function"); | |
870 @end example | |
871 | |
872 @noindent | |
873 prevents @code{my_function} from being removed from memory, even if | |
874 @code{clear} is called. It is possible to determine if a function is | |
875 locked into memory with the @code{mislocked}, and to unlock a function | |
876 with @code{munlock}, which the following illustrates. | |
877 | |
878 @example | |
879 @group | |
880 mlock ("my_function"); | |
881 mislocked ("my_function") | |
882 @result{} ans = 1 | |
883 munlock ("my_function"); | |
884 mislocked ("my_function") | |
885 @result{} ans = 0 | |
886 @end group | |
887 @end example | |
888 | |
889 A common use of @code{mlock} is to prevent persistent variables from | |
8828 | 890 being removed from memory, as the following example shows: |
6899 | 891 |
892 @example | |
893 @group | |
894 function count_calls() | |
895 persistent calls = 0; | |
7031 | 896 printf ("'count_calls' has been called %d times\n", |
897 ++calls); | |
6899 | 898 endfunction |
899 mlock ("count_calls"); | |
900 | |
901 count_calls (); | |
902 @print{} 'count_calls' has been called 1 times | |
903 | |
904 clear count_calls | |
905 count_calls (); | |
906 @print{} 'count_calls' has been called 2 times | |
907 @end group | |
908 @end example | |
909 | |
910 @noindent | |
911 It is, however, often inconvenient to lock a function from the prompt, | |
912 so it is also possible to lock a function from within its body. This | |
913 is simply done by calling @code{mlock} from within the function. | |
914 | |
915 @example | |
916 @group | |
917 function count_calls () | |
918 mlock (); | |
919 persistent calls = 0; | |
7031 | 920 printf ("'count_calls' has been called %d times\n", |
921 ++calls); | |
6899 | 922 endfunction |
923 @end group | |
924 @end example | |
925 | |
926 @code{mlock} might equally be used to prevent changes to a function from having | |
6635 | 927 effect in Octave, though a similar effect can be had with the |
928 @code{ignore_function_time_stamp} function. | |
929 | |
930 @DOCSTRING(mlock) | |
931 | |
932 @DOCSTRING(munlock) | |
933 | |
934 @DOCSTRING(mislocked) | |
935 | |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
936 @node Function Precedence |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
937 @subsection Function Precedence |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
938 |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
939 Given the numerous different ways that Octave can define a function, it |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
940 is possible and even likely that multiple versions of a function, might be |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
941 defined within a particular scope. The precedence of which function will be |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
942 used within a particular scope is given by |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
943 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
944 @enumerate 1 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
945 @item Subfunction |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
946 A subfunction with the required function name in the given scope. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
947 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
948 @item Private function |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
949 A function defined within a private directory of the directory |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
950 which contains the current function. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
951 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
952 @item Class constructor |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
953 A function that constuctors a user class as defined in chapter |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
954 @ref{Object Oriented Programming}. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
955 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
956 @item Class method |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
957 An overloaded function of a class as in chapter |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
958 @ref{Object Oriented Programming}. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
959 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
960 @item Legacy Dispatch |
11396
7b563cf94d8d
Remove documentation on deprecated function dispatch
Rik <octave@nomad.inbox5.com>
parents:
11392
diff
changeset
|
961 An overloaded function as defined by @code{dispatch}. |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
962 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
963 @item Command-line Function |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
964 A function that has been defined on the command-line. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
965 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
966 @item Autoload function |
8235 | 967 A function that is marked as autoloaded with @xref{doc-autoload}. |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
968 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
969 @item A Function on the Path |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
970 A function that can be found on the users load-path. There can also be |
8221
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
971 Oct-file, mex-file or m-file versions of this function and the precedence |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
972 between these versions are in that order. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
973 |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
974 @item Built-in function |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
975 A function that is builtin to Octave itself such as @code{numel}, |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
976 @code{size}, etc. |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
977 @end enumerate |
06094fa570a3
Add some documentation for the OOP code of Octave
David Bateman <dbateman@free.fr>
parents:
8074
diff
changeset
|
978 |
4167 | 979 @node Script Files |
3294 | 980 @section Script Files |
981 | |
982 A script file is a file containing (almost) any sequence of Octave | |
983 commands. It is read and evaluated just as if you had typed each | |
984 command at the Octave prompt, and provides a convenient way to perform a | |
985 sequence of commands that do not logically belong inside a function. | |
986 | |
987 Unlike a function file, a script file must @emph{not} begin with the | |
988 keyword @code{function}. If it does, Octave will assume that it is a | |
989 function file, and that it defines a single function that should be | |
990 evaluated as soon as it is defined. | |
991 | |
992 A script file also differs from a function file in that the variables | |
993 named in a script file are not local variables, but are in the same | |
994 scope as the other variables that are visible on the command line. | |
995 | |
996 Even though a script file may not begin with the @code{function} | |
997 keyword, it is possible to define more than one function in a single | |
998 script file and load (but not execute) all of them at once. To do | |
999 this, the first token in the file (ignoring comments and other white | |
1000 space) must be something other than @code{function}. If you have no | |
1001 other statements to evaluate, you can use a statement that has no | |
1002 effect, like this: | |
1003 | |
1004 @example | |
1005 @group | |
1006 # Prevent Octave from thinking that this | |
1007 # is a function file: | |
1008 | |
1009 1; | |
1010 | |
1011 # Define function one: | |
1012 | |
1013 function one () | |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1014 @dots{} |
3294 | 1015 @end group |
1016 @end example | |
1017 | |
1018 To have Octave read and compile these functions into an internal form, | |
6638 | 1019 you need to make sure that the file is in Octave's load path |
6477 | 1020 (accessible through the @code{path} function), then simply type the |
1021 base name of the file that contains the commands. (Octave uses the | |
1022 same rules to search for script files as it does to search for | |
1023 function files.) | |
3294 | 1024 |
1025 If the first token in a file (ignoring comments) is @code{function}, | |
1026 Octave will compile the function and try to execute it, printing a | |
1027 message warning about any non-whitespace characters that appear after | |
1028 the function definition. | |
1029 | |
1030 Note that Octave does not try to look up the definition of any identifier | |
1031 until it needs to evaluate it. This means that Octave will compile the | |
1032 following statements if they appear in a script file, or are typed at | |
1033 the command line, | |
1034 | |
1035 @example | |
1036 @group | |
1037 # not a function file: | |
1038 1; | |
1039 function foo () | |
1040 do_something (); | |
1041 endfunction | |
1042 function do_something () | |
1043 do_something_else (); | |
1044 endfunction | |
1045 @end group | |
1046 @end example | |
1047 | |
1048 @noindent | |
1049 even though the function @code{do_something} is not defined before it is | |
1050 referenced in the function @code{foo}. This is not an error because | |
1051 Octave does not need to resolve all symbols that are referenced by a | |
1052 function until the function is actually evaluated. | |
1053 | |
1054 Since Octave doesn't look for definitions until they are needed, the | |
1055 following code will always print @samp{bar = 3} whether it is typed | |
1056 directly on the command line, read from a script file, or is part of a | |
1057 function body, even if there is a function or script file called | |
6477 | 1058 @file{bar.m} in Octave's path. |
3294 | 1059 |
1060 @example | |
1061 @group | |
1062 eval ("bar = 3"); | |
1063 bar | |
1064 @end group | |
1065 @end example | |
1066 | |
1067 Code like this appearing within a function body could fool Octave if | |
1068 definitions were resolved as the function was being compiled. It would | |
1069 be virtually impossible to make Octave clever enough to evaluate this | |
1070 code in a consistent fashion. The parser would have to be able to | |
1071 perform the call to @code{eval} at compile time, and that would be | |
1072 impossible unless all the references in the string to be evaluated could | |
1073 also be resolved, and requiring that would be too restrictive (the | |
1074 string might come from user input, or depend on things that are not | |
1075 known until the function is evaluated). | |
1076 | |
1077 Although Octave normally executes commands from script files that have | |
1078 the name @file{@var{file}.m}, you can use the function @code{source} to | |
1079 execute commands from any file. | |
1080 | |
3371 | 1081 @DOCSTRING(source) |
3294 | 1082 |
6638 | 1083 @node Function Handles Inline Functions and Anonymous Functions |
1084 @section Function Handles, Inline Functions, and Anonymous Functions | |
4933 | 1085 @cindex handle, function handles |
1086 @cindex inline, inline functions | |
6638 | 1087 @cindex anonymous functions |
4933 | 1088 |
6638 | 1089 It can be very convenient store a function in a variable so that it |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1090 can be passed to a different function. For example, a function that |
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1091 performs numerical minimization needs access to the function that |
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1092 should be minimized. |
4933 | 1093 |
1094 @menu | |
1095 * Function Handles:: | |
6554 | 1096 * Anonymous Functions:: |
4933 | 1097 * Inline Functions:: |
1098 @end menu | |
1099 | |
1100 @node Function Handles | |
1101 @subsection Function Handles | |
1102 | |
6554 | 1103 A function handle is a pointer to another function and is defined with |
1104 the syntax | |
1105 | |
1106 @example | |
1107 @@@var{function-name} | |
1108 @end example | |
1109 | |
1110 @noindent | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1111 For example, |
6554 | 1112 |
1113 @example | |
6556 | 1114 f = @@sin; |
6554 | 1115 @end example |
1116 | |
1117 @noindent | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1118 creates a function handle called @code{f} that refers to the |
6554 | 1119 function @code{sin}. |
1120 | |
1121 Function handles are used to call other functions indirectly, or to pass | |
1122 a function as an argument to another function like @code{quad} or | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1123 @code{fsolve}. For example: |
6554 | 1124 |
1125 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1126 @group |
6556 | 1127 f = @@sin; |
6554 | 1128 quad (f, 0, pi) |
6929 | 1129 @result{} 2 |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1130 @end group |
6554 | 1131 @end example |
1132 | |
1133 You may use @code{feval} to call a function using function handle, or | |
6570 | 1134 simply write the name of the function handle followed by an argument |
6554 | 1135 list. If there are no arguments, you must use an empty argument list |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1136 @samp{()}. For example: |
6554 | 1137 |
1138 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1139 @group |
6556 | 1140 f = @@sin; |
6554 | 1141 feval (f, pi/4) |
6570 | 1142 @result{} 0.70711 |
6554 | 1143 f (pi/4) |
6570 | 1144 @result{} 0.70711 |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1145 @end group |
6554 | 1146 @end example |
1147 | |
4933 | 1148 @DOCSTRING(functions) |
1149 | |
1150 @DOCSTRING(func2str) | |
1151 | |
1152 @DOCSTRING(str2func) | |
1153 | |
6570 | 1154 @node Anonymous Functions |
6554 | 1155 @subsection Anonymous Functions |
1156 | |
1157 Anonymous functions are defined using the syntax | |
1158 | |
1159 @example | |
1160 @@(@var{argument-list}) @var{expression} | |
1161 @end example | |
1162 | |
1163 @noindent | |
1164 Any variables that are not found in the argument list are inherited from | |
1165 the enclosing scope. Anonymous functions are useful for creating simple | |
1166 unnamed functions from expressions or for wrapping calls to other | |
1167 functions to adapt them for use by functions like @code{quad}. For | |
1168 example, | |
1169 | |
1170 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1171 @group |
6554 | 1172 f = @@(x) x.^2; |
1173 quad (f, 0, 10) | |
6570 | 1174 @result{} 333.33 |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1175 @end group |
6554 | 1176 @end example |
1177 | |
1178 @noindent | |
1179 creates a simple unnamed function from the expression @code{x.^2} and | |
1180 passes it to @code{quad}, | |
1181 | |
1182 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1183 @group |
6554 | 1184 quad (@@(x) sin (x), 0, pi) |
6933 | 1185 @result{} 2 |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1186 @end group |
6554 | 1187 @end example |
1188 | |
1189 @noindent | |
1190 wraps another function, and | |
1191 | |
1192 @example | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1193 @group |
6554 | 1194 a = 1; |
1195 b = 2; | |
1196 quad (@@(x) betainc (x, a, b), 0, 0.4) | |
6929 | 1197 @result{} 0.13867 |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
1198 @end group |
6554 | 1199 @end example |
1200 | |
1201 @noindent | |
1202 adapts a function with several parameters to the form required by | |
1203 @code{quad}. In this example, the values of @var{a} and @var{b} that | |
1204 are passed to @code{betainc} are inherited from the current | |
1205 environment. | |
1206 | |
4933 | 1207 @node Inline Functions |
1208 @subsection Inline Functions | |
1209 | |
6638 | 1210 An inline function is created from a string containing the function |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1211 body using the @code{inline} function. The following code defines the |
6638 | 1212 function @math{f(x) = x^2 + 2}. |
1213 | |
1214 @example | |
1215 f = inline("x^2 + 2"); | |
1216 @end example | |
1217 | |
1218 @noindent | |
1219 After this it is possible to evaluate @math{f} at any @math{x} by | |
1220 writing @code{f(x)}. | |
1221 | |
4933 | 1222 @DOCSTRING(inline) |
1223 | |
1224 @DOCSTRING(argnames) | |
1225 | |
1226 @DOCSTRING(formula) | |
1227 | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
1228 @DOCSTRING(symvar) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7638
diff
changeset
|
1229 |
6549 | 1230 @node Commands |
1231 @section Commands | |
1232 | |
6638 | 1233 Commands are a special class of functions that only accept string |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1234 input arguments. A command can be called as an ordinary function, but |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1235 it can also be called without the parentheses. For example, |
6638 | 1236 |
1237 @example | |
1238 my_command hello world | |
1239 @end example | |
1240 | |
1241 @noindent | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1242 is equivalent to |
6638 | 1243 |
1244 @example | |
1245 my_command("hello", "world") | |
1246 @end example | |
1247 | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1248 @noindent |
6638 | 1249 The general form of a command call is |
1250 | |
1251 @example | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1252 @var{cmdname} @var{arg1} @var{arg2} @dots{} |
6638 | 1253 @end example |
1254 | |
1255 @noindent | |
1256 which translates directly to | |
1257 | |
1258 @example | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1259 @var{cmdname} ("@var{arg1}", "@var{arg2}", @dots{}) |
6638 | 1260 @end example |
1261 | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1262 Any regular function can be used as a command if it accepts string input |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1263 arguments. For example: |
11573
6f8ffe2c6f76
Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11547
diff
changeset
|
1264 |
6638 | 1265 @example |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1266 @group |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1267 toupper lower_case_arg |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1268 @result{} ans = LOWER_CASE_ARG |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1269 @end group |
6638 | 1270 @end example |
1271 | |
1272 One difficulty of commands occurs when one of the string input arguments | |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1273 is stored in a variable. Because Octave can't tell the difference between |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1274 a variable name and an ordinary string, it is not possible to pass a |
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1275 variable as input to a command. In such a situation a command must be |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1276 called as a function. For example: |
6549 | 1277 |
11392
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1278 @example |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1279 @group |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1280 strvar = "hello world"; |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1281 toupper strvar |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1282 @result{} ans = STRVAR |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1283 toupper (strvar) |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1284 @result{} ans = HELLO WORLD |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1285 @end group |
757efa1d7e2a
Remove deprecated functions from manual.
Rik <octave@nomad.inbox5.com>
parents:
11257
diff
changeset
|
1286 @end example |
6549 | 1287 |
1288 | |
4167 | 1289 @node Organization of Functions |
3294 | 1290 @section Organization of Functions Distributed with Octave |
1291 | |
1292 Many of Octave's standard functions are distributed as function files. | |
1293 They are loosely organized by topic, in subdirectories of | |
1294 @file{@var{octave-home}/lib/octave/@var{version}/m}, to make it easier | |
1295 to find them. | |
1296 | |
1297 The following is a list of all the function file subdirectories, and the | |
1298 types of functions you will find there. | |
1299 | |
1300 @table @file | |
1301 @item audio | |
1302 Functions for playing and recording sounds. | |
1303 | |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1304 @item deprecated |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1305 Out-of-date functions which will eventually be removed from Octave. |
3294 | 1306 |
1307 @item elfun | |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1308 Elementary functions, principally trigonometric. |
3294 | 1309 |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1310 @item @@ftp |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1311 Class functions for the FTP object. |
6554 | 1312 |
3294 | 1313 @item general |
1314 Miscellaneous matrix manipulations, like @code{flipud}, @code{rot90}, | |
1315 and @code{triu}, as well as other basic functions, like | |
4029 | 1316 @code{ismatrix}, @code{nargchk}, etc. |
3294 | 1317 |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1318 @item geometry |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1319 Functions related to Delaunay triangulation. |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1320 |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1321 @item help |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1322 Functions for Octave's built-in help system. |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1323 |
3294 | 1324 @item image |
1325 Image processing tools. These functions require the X Window System. | |
1326 | |
1327 @item io | |
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
8286
diff
changeset
|
1328 Input-output functions. |
3294 | 1329 |
1330 @item linear-algebra | |
1331 Functions for linear algebra. | |
1332 | |
1333 @item miscellaneous | |
1334 Functions that don't really belong anywhere else. | |
1335 | |
6554 | 1336 @item optimization |
12642
f96b9b9f141b
doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
12632
diff
changeset
|
1337 Functions related to minimization, optimization, and root finding. |
6554 | 1338 |
1339 @item path | |
1340 Functions to manage the directory path Octave uses to find functions. | |
1341 | |
1342 @item pkg | |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1343 Package manager for installing external packages of functions in Octave. |
6554 | 1344 |
3294 | 1345 @item plot |
6556 | 1346 Functions for displaying and printing two- and three-dimensional graphs. |
3294 | 1347 |
1348 @item polynomial | |
1349 Functions for manipulating polynomials. | |
1350 | |
1351 @item set | |
1352 Functions for creating and manipulating sets of unique values. | |
1353 | |
1354 @item signal | |
1355 Functions for signal processing applications. | |
1356 | |
6554 | 1357 @item sparse |
1358 Functions for handling sparse matrices. | |
1359 | |
3294 | 1360 @item specfun |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1361 Special functions such as @code{bessel} or @code{factor}. |
3294 | 1362 |
1363 @item special-matrix | |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1364 Functions that create special matrix forms such as Hilbert or Vandermonde |
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1365 matrices. |
3294 | 1366 |
1367 @item startup | |
1368 Octave's system-wide startup file. | |
1369 | |
1370 @item statistics | |
1371 Statistical functions. | |
1372 | |
1373 @item strings | |
1374 Miscellaneous string-handling functions. | |
1375 | |
6554 | 1376 @item testfun |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1377 Functions for performing unit tests on other functions. |
6554 | 1378 |
3294 | 1379 @item time |
12632
2dbac27e0e40
doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents:
12629
diff
changeset
|
1380 Functions related to time and date processing. |
3294 | 1381 @end table |