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