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