Next: Script Files, Previous: Returning From a Function, Up: Functions and Scripts
Except for simple one-shot programs, it is not practical to have to define all the functions you need each time you need them. Instead, you will normally want to save them in a file so that you can easily edit them, and save them for use at a later time.
Octave does not require you to load function definitions from files before using them. You simply need to put the function definitions in a place where Octave can find them.
When Octave encounters an identifier that is undefined, it first looks
for variables or functions that are already compiled and currently
listed in its symbol table. If it fails to find a definition there, it
searches the list of directories specified by the built-in variable
LOADPATH for files ending in .m that have the same base
name as the undefined identifier.1 Once Octave finds a file
with a name that matches, the contents of the file are read. If it
defines a single function, it is compiled and executed.
See Script Files, for more information about how you can define more
than one function in a single file.
When Octave defines a function from a function file, it saves the full name of the file it read and the time stamp on the file. After that, it checks the time stamp on the file every time it needs the function. If the time stamp indicates that the file has changed since the last time it was read, Octave reads it again.
Checking the time stamp allows you to edit the definition of a function while Octave is running, and automatically use the new function definition without having to restart your Octave session. Checking the time stamp every time a function is used is rather inefficient, but it has to be done to ensure that the correct function definition is used.
To avoid degrading performance unnecessarily by checking the time stamps on functions that are not likely to change, Octave assumes that function files in the directory tree octave-home/share/octave/version/m will not change, so it doesn't have to check their time stamps every time the functions defined in those files are used. This is normally a very good assumption and provides a significant improvement in performance for the function files that are distributed with Octave.
If you know that your own function files will not change while you are
running Octave, you can improve performance by setting the variable
ignore_function_time_stamp to "all", so that Octave will
ignore the time stamps for all function files. Setting it to
"system" gives the default behavior. If you set it to anything
else, Octave will check the time stamps on all function files.
Return the absolute name of file if it can be found in the list of directories specified by
path. If no file is found, return an empty matrix.If the first argument is a cell array of strings, search each directory of the loadpath for element of the cell array and return the first that matches.
If the second optional argument
"all"is supplied, return a cell array containing the list of all files that have the same name in the path. If no files are found, return an empty cell array.See also: file_in_path, path.
Query or set the internal variable that controls whether Octave checks the time stamp on files each time it looks up functions defined in function files. If the internal variable is set to
"system", Octave will not automatically recompile function files in subdirectories of octave-home/lib/version if they have changed since they were last compiled, but will recompile other function files in the search path if they change. If set to"all", Octave will not recompile any function files unless their definitions are removed withclear. If set to "none", Octave will always check time stamps on files to determine whether functions defined in function files need to recompiled.