Difference between revisions of "FAQ"

From Octave
Jump to navigation Jump to search
(Lots of reordering.)
Line 1: Line 1:
 
This is a list of frequently asked questions (FAQ) for GNU Octave users.
 
This is a list of frequently asked questions (FAQ) for GNU Octave users.
  
We are always looking for new questions (with answers), better answers, or both. Feel free to edit this page with your changes. If you have general questions about GNU Octave, or need help for something that is not covered by the Octave manual or the FAQ, please use the [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org mailing list].
+
We are always looking for new questions (with answers), better answers, or both. Feel free to edit this page with your changes.
  
This FAQ is intended to supplement, not replace, the GNU Octave manual ([https://www.gnu.org/software/octave/doc/interpreter/ HTML], [https://www.gnu.org/software/octave/octave.pdf PDF]). Before posting a question to the [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org mailing list], you should first check to see if the topic is covered in the manual.
+
=Where do I get additional help?=
 +
 
 +
If you can't find an answer to your question in this FAQ, wiki, or in the [http://www.octave.org/doc/interpreter manual] ([http://www.octave.org/octave.pdf PDF]) you can:
 +
 
 +
* Search for an answer in our [https://lists.gnu.org/archive/html/help-octave/ mailing list archives]
 +
* Contact our user community using our [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org mailing list] (feel free to subscribe to this mailing list)
 +
* Contact our user community using our [https://webchat.freenode.net/?channels=octave IRC chat room <code>#octave</code> in Freenode]
  
 
<div class="tocinline">__TOC__</div>
 
<div class="tocinline">__TOC__</div>
Line 40: Line 46:
 
Octave became GNU Octave in 1997 (beginning with [[Release History|version 2.0.6]]).  This meant agreeing to consider Octave a part of the GNU Project and support the efforts of the FSF.  A big part of this effort is to adhere to the [https://www.gnu.org/prep/standards/standards.html GNU coding standards] and to benefit from GNU's infrastructure (e.g. [https://hg.savannah.gnu.org/hgweb/octave/ code hosting] and [http://bugs.octave.org bug tracking]).  Additionally, Octave receives [https://my.fsf.org/donate/working-together/octave sponsorship] from the FSF's Working Together fund.  However, Octave is not and has never been developed by the FSF.
 
Octave became GNU Octave in 1997 (beginning with [[Release History|version 2.0.6]]).  This meant agreeing to consider Octave a part of the GNU Project and support the efforts of the FSF.  A big part of this effort is to adhere to the [https://www.gnu.org/prep/standards/standards.html GNU coding standards] and to benefit from GNU's infrastructure (e.g. [https://hg.savannah.gnu.org/hgweb/octave/ code hosting] and [http://bugs.octave.org bug tracking]).  Additionally, Octave receives [https://my.fsf.org/donate/working-together/octave sponsorship] from the FSF's Working Together fund.  However, Octave is not and has never been developed by the FSF.
  
==What version should I use?==
+
==How can I cite Octave?==
 
 
For general use, it is recommended to use the latest stable version of Octave (currently {{Release}}), available from http://www.octave.org/download.html.  For development and bleeding-edge features one can obtain the development source code from the Mercurial repository https://hg.savannah.gnu.org/hgweb/octave/graph/.
 
 
 
The used version of Octave is available via the <code>ver</code> command and a list of user-visible changes since the last release is available via the <code>news</code> command at the GNU Octave prompt.
 
 
 
==On what platforms does Octave run?==
 
 
 
Octave runs on any platform you can compile it on.  Binary distributions exist for [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].  To work fully functional, Octave requires the used platform to support the underlying numerical libraries like [https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms BLAS], [https://en.wikipedia.org/wiki/LAPACK LAPACK], [http://www.suitesparse.com SuiteSparse], etc., and for plotting [https://www.opengl.org/ OpenGL] or [http://www.gnuplot.info/ gnuplot].
 
 
 
== How can I cite Octave? ==
 
  
 
Octave is free software and does not legally bind you to cite it.  However, we have invested a lot of time and effort in creating GNU Octave, and we would appreciate if you would cite if you used.  To cite GNU Octave in publications use:
 
Octave is free software and does not legally bind you to cite it.  However, we have invested a lot of time and effort in creating GNU Octave, and we would appreciate if you would cite if you used.  To cite GNU Octave in publications use:
Line 71: Line 67:
 
Note that there are two reasons for citing the software used.  One is giving recognition to the work done by others which we already addressed.  The other is giving details on the system used so that experiments can be replicated.  For this, you should cite the version of Octave and all packages used (you can get this information using the <code>ver</code> command), as well as any details of your setup as part of your Methods.  In addition, you should make your source available.  See [http://software.ac.uk/so-exactly-what-software-did-you-use How to cite and describe software] for more details and an in depth discussion.
 
Note that there are two reasons for citing the software used.  One is giving recognition to the work done by others which we already addressed.  The other is giving details on the system used so that experiments can be replicated.  For this, you should cite the version of Octave and all packages used (you can get this information using the <code>ver</code> command), as well as any details of your setup as part of your Methods.  In addition, you should make your source available.  See [http://software.ac.uk/so-exactly-what-software-did-you-use How to cite and describe software] for more details and an in depth discussion.
  
==When will feature X be released or implemented?==
+
==What documentation exists for Octave?==
 
 
When it's ready, sooner [http://www.octave.org/get-involved.html if you help].  You can [https://savannah.gnu.org/patch/?group=octave send us patches] if you can implement feature X yourself.  If you can't, some [http://www.octave.org/commercial-support.html developers may be convinced to work on your specific problem for some money].
 
 
 
==How can I get involved in Octave development?==
 
 
 
Be around.  Be social.  Participate in our mailing lists [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org] and [https://lists.gnu.org/mailman/listinfo/octave-maintainers maintainers@octave.org].  Find things about Octave you don't like, and start thinking about how to fix them.  Many people who now contribute to Octave first spent several years helping in the mailing list before they started to delve into the code.  A good way to learn Octave is to understand the problems other people are having with it, so being helpful in the mailing lists not only helps Octave as a whole, but it also prepares you to be a better Octave contributor.
 
  
If you feel ready to dive right into the code, read the [[Developers]] wiki page or [http://www.octave.org/get-involved.html start here].  But do not send an email to the mailing lists listing your skills and offering to helpWe won't just suggest things for you to do.  We lack volunteers and we do need your help, but because of that, we also lack the time to provide good guidance and mentoring.  If there is a specific short-term project you would like to work on, say so, and just do it.  Then ask for help or advice when you're doing it.  It is a lot more important that you do something that you're actually interested on than something we suggested because it only matches your skills.
+
Besides this wiki, the GNU Octave distribution includes a [http://www.octave.org/doc/interpreter 1000+ page Texinfo manual] ([http://www.octave.org/octave.pdf PDF])Access to the complete text of the manual is available via the <code>doc</code> command at the GNU Octave promptIf you have problems using this manual, or find that some topic is not adequately explained, indexed, or cross-referenced, please report it on http://bugs.octave.org.
 
 
We also need help with this wiki and the [http://www.octave.org/doc/interpreter/ manual].  These are also important tasks.  The documentation is easy to patch, and the help text for individual functions even more so.  Editing this wiki is even easier.
 
  
Accurate bug reporting is also very useful.  Find and report [http://bugs.octave.org/ bugs], making an attempt to diagnose them.  Eventually, you will also know how to fix them.  If you want to help with bug reports or patches, subscribe to the [https://lists.gnu.org/mailman/listinfo/octave-bug-tracker bug tracker mailing list].  You'll get updates on all bug activity, and you can jump in when you see
+
==How can I report a bug in Octave?==
something you can help with.
 
  
Look at our [[projects]], [[short projects]], and [[Summer of Code Project Ideas]] if you need specific inspiration for coding tasks that we would like to get done.
+
Please read our website http://www.octave.org/bugs.html.
  
 
=Licensing issues=
 
=Licensing issues=
Line 121: Line 108:
 
That does not apply to GNU Octave, therefore the usage is in general prohibited.  It should suffice — although interpretations of this vary — to contact the author directly to send you the code personally (maybe released under a free license), or download the code from the author's own website, if available. [[Asking_for_package_to_be_released_under_GPL:_examples|Some examples of letters/email sent to authors for that purpose]].
 
That does not apply to GNU Octave, therefore the usage is in general prohibited.  It should suffice — although interpretations of this vary — to contact the author directly to send you the code personally (maybe released under a free license), or download the code from the author's own website, if available. [[Asking_for_package_to_be_released_under_GPL:_examples|Some examples of letters/email sent to authors for that purpose]].
  
=What's new in Octave=
+
=Installation=
 +
 
 +
==How can I install Octave on Windows?==
 +
 
 +
:''See: [[Octave for Microsoft Windows]]''
 +
 
 +
==How can I install Octave on macOS?==
 +
 
 +
:''See: [[Octave for macOS]]''
 +
 
 +
==How can I install Octave on GNU/Linux?==
 +
 
 +
:''See: [[Octave for GNU/Linux]]''
 +
 
 +
==How can I install Octave on Android / what is this Octave app in the Google Play store?==
 +
 
 +
There is an '''unofficial''' Octave app available for Android in the Google Play store.  This Octave app is no longer freely available and has become [https://en.wikipedia.org/wiki/Shareware#Nagware "nagware"].  This is a sad turn of events.  Please see [[Android]] for more information.
 +
 
 +
==How can I install Octave on platform X?==
 +
 
 +
Octave currently runs on [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].  It should be possible to make Octave work on other systems as well.  If you are interested in porting Octave to other systems, please contact the maintainers development mailing list [https://lists.gnu.org/mailman/listinfo/octave-maintainers maintainers@octave.org].
 +
 
 +
==What Octave version should I use?==
 +
 
 +
For general use, it is recommended to use the latest stable version of Octave (currently {{Release}}), available from http://www.octave.org/download.html.  For development and bleeding-edge features one can obtain the development source code from the Mercurial repository https://hg.savannah.gnu.org/hgweb/octave/graph/.
 +
 
 +
The used version of Octave is available via the <code>ver</code> command and a list of user-visible changes since the last release is available via the <code>news</code> command at the GNU Octave prompt.
 +
 
 +
==On what platforms does Octave run?==
 +
 
 +
Octave runs on any platform you can compile it on.  Binary distributions exist for [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].  To work fully functional, Octave requires the used platform to support the underlying numerical libraries like [https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms BLAS], [https://en.wikipedia.org/wiki/LAPACK LAPACK], [http://www.suitesparse.com SuiteSparse], etc., and for plotting [https://www.opengl.org/ OpenGL] or [http://www.gnuplot.info/ gnuplot].
 +
 
 +
==How can I obtain Octave's source code?==
 +
 
 +
The latest version of the Octave source code (and older versions) is available from:
 +
 
 +
* http://www.octave.org/download.html
 +
* https://ftp.gnu.org/gnu/octave/
 +
 
 +
Since Octave is distributed under the terms of the GPL, you can get Octave from a friend who has a copy.
 +
 
 +
==How can I build Octave from the source code?==
 +
 
 +
To use Octave it is usually not required to build it from it's source code.  Binary distributions exist for [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].
 +
 
 +
If you have reasons to build Octave from the source code, see [[Building]] for more information.
 +
 
 +
==What do I need to build Octave from the source code?==
 +
 
 +
For a list of build dependencies see [[Building]].
 +
 
 +
==Do I need GCC to build Octave from the source code?==
 +
 
 +
No. The development is done primarily with [https://gcc.gnu.org/ GCC], so you may hit some incompatibilities.  Octave is intended to be portable to any standard conforming compiler (for example [https://clang.llvm.org/ clang] is know to work as well).  If you have difficulties that you think are bugs, please report them to the [http://bugs.octave.org bug tracker], or ask for help on the [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org mailing list].
 +
 
 +
=What's new in Octave?=
  
Each new Octave release introduces many new features.  A complete list of user visible changes can be seen by running {{codeline|news}} at the Octave prompt.  The following changes are a distilled list of the major changes:
+
Each new Octave release introduces many new features.  A complete list of user visible changes can be seen by running <code>news</code> at the Octave prompt.  The following changes are a distilled list of the major changes:
  
==Coming in a future release==
+
==What's new in the next version of Octave?==
  
 
See the [http://hg.savannah.gnu.org/hgweb/octave/file/tip/NEWS NEWS file] on the development branch.
 
See the [http://hg.savannah.gnu.org/hgweb/octave/file/tip/NEWS NEWS file] on the development branch.
Line 164: Line 206:
 
* Many improvements to native OpenGL plotting
 
* Many improvements to native OpenGL plotting
 
* ARPACK now distributed with Octave
 
* ARPACK now distributed with Octave
* Indexing optimisations
+
* Indexing optimizations
 
* FTP objects
 
* FTP objects
 
* Function handles aware of overloaded functions
 
* Function handles aware of overloaded functions
* bsxfun optimised for basic arithmetic functions
+
* bsxfun optimized for basic arithmetic functions
 
* Matlab-style ignoring of output arguments using {{Codeline|~}}
 
* Matlab-style ignoring of output arguments using {{Codeline|~}}
* Many optimisations of the accumarray function
+
* Many optimizations of the accumarray function
 
* Sparse matrix indexing has been rewritten for speed
 
* Sparse matrix indexing has been rewritten for speed
 
* The pkg command now accepts a -forge option to pull packages directly from Octave-forge
 
* The pkg command now accepts a -forge option to pull packages directly from Octave-forge
Line 184: Line 226:
 
* a fully compatible MEX interface
 
* a fully compatible MEX interface
 
* imwrite and imread (based on the GraphicsMagick library)
 
* imwrite and imread (based on the GraphicsMagick library)
* Lazy transpose <br/> Special treatment in the parser of things like "a' * b", where the transpose is never explicitly formed but a flag is rather passed to the underlying LAPACK code.
+
* Lazy transpose: Special treatment in the parser of things like "a' * b", where the transpose is never explicitly formed but a flag is rather passed to the underlying LAPACK code.
  
== Older releases ==
+
==Older releases==
  
 
For full details on older releases, see:
 
For full details on older releases, see:
Line 194: Line 236:
 
* [http://hg.savannah.gnu.org/hgweb/octave/file/83792dd9bcc1/etc/NEWS.3 NEWS.3] for the 3.X.Y series
 
* [http://hg.savannah.gnu.org/hgweb/octave/file/83792dd9bcc1/etc/NEWS.3 NEWS.3] for the 3.X.Y series
  
=What documentation exists for Octave?=
+
=Octave-Forge=
 
 
Besides this wiki, the GNU Octave distribution includes a [http://www.octave.org/octave.pdf 1000+ page Texinfo manual].  Access to the complete text of the manual is available via the <code>doc</code> command at the GNU Octave prompt.  If you have problems using this manual, or find that some topic is not adequately explained, indexed, or cross-referenced, please report it on http://bugs.octave.org.
 
 
 
==Getting additional help==
 
 
 
If you can't find an answer to your question, the help@octave.org mailing list is available for questions related to using, installing, and porting Octave that are not adequately answered by the Octave manual or by this document.
 
 
 
==User community==
 
 
 
To subscribe to the list, go to http://www.octave.org/archive.html and follow the link to the subscription page for the list.
 
 
 
Please do not send requests to be added or removed from the mailing list, or other administrative trivia to the list itself.
 
 
 
An archive of old postings to the help-octave mailing list is maintained on http://www.octave.org/archive.html.
 
 
 
You will also find some user advice and code spread over the web. Good starting points are the Octave Wiki http://wiki.octave.org and Octave-Forge http://octave.sourceforge.net
 
 
 
We also have [http://webchat.freenode.net?channels=octave&uio=d4 an IRC chat room], <code>#octave</code> in Freenode.
 
 
 
==I think I have found a bug in Octave.==
 
 
 
“I think I have found a bug in Octave, but I'm not sure. How do I know, and who should I tell?”
 
 
 
First, see the section [http://www.octave.org/bugs.html on bugs and bug reports in the Octave manual]. When you report a bug, make sure to describe the type of computer you are using, the version of the operating system it is running, and the version of Octave that you are using. Also provide enough code and configuration details of your operating system so that the Octave maintainers can duplicate your bug.
 
 
 
=How can I obtain Octave?=
 
 
 
==Source code==
 
 
 
Source code is available on the Octave development site, where you are sure to get the latest version.
 
 
 
* http://www.octave.org/download.html
 
* https://ftp.gnu.org/gnu/octave/
 
 
 
Since Octave is distributed under the terms of the GPL, you can get Octave from a friend who has a copy, or from the Octave website.
 
 
 
==Pre-compiled binaries ==
 
:''See also: [[Build from source]]''
 
 
 
The Octave project does not normally distribute its own binaries, but other projects do.
 
For example, Linux and BSD distributions provide by their respective Octave binaries.
 
Windows is a recent exception, in that binaries are available directly from the Octave project (starting from version 4.0).
 
For an up-to-date listing, see:
 
 
 
* http://www.octave.org/download.html
 
  
As of today, Octave binaries are available at least on Debian, Ubuntu, RedHat, Suse, and Fedora GNU/Linux; Mac OS X; and Windows (versions 98, 2000, XP, Vista, 7, 8, and 10).
+
== How do install or load all Octave-Forge packages? ==
 
 
==How do I get a copy of Octave for (some other platform)?==
 
 
 
Octave currently runs on Unix-like systems, Mac OS X, and Windows. It should be possible to make Octave work on other systems as well. If you are interested in porting Octave to other systems, please contact [mailto:maintainers@octave.org the maintainers' mailing list]
 
.
 
==How can I install Octave on Android? What is this Octave app in the Google Play store?==
 
 
 
There is an unofficial Octave app available for Android in the Google Play store. Please see [[Android]] for more information.
 
 
 
This version of Octave is no longer freely available and has become 'nagware'. This is a sad turn of events.
 
 
 
=Installation issues and problems=
 
 
 
Octave 3.4 requires approximately 1.3 GB of disk storage to unpack and compile from source (considerably less if you don't compile with debugging symbols). Once installed, Octave requires approximately 355 MB of disk space (again, considerably less if you don't compile with debugging symbols, approximately 50 MB).
 
 
 
Check out the page [[Installation]] for more detailed information about installing Octave.
 
 
 
==What else do I need?==
 
 
 
To compile Octave, you will need a recent version of GNU Make. You will also need GCC 4.3 or later, although GCC 4.4 or later is recommended.
 
 
 
'''You must have GNU Make to compile octave'''. Octave's Makefiles use features of GNU Make that are not present in other versions of make. GNU Make is very portable and easy to install.
 
 
 
==Can I compile Octave with another C++ compiler?==
 
 
 
Yes, but development is done primarily with GCC, so you may hit some incompatibilities. Octave is intended to be portable to any standard conforming compiler. If you have difficulties that you think are bugs, please report them to the http://bugs.octave.org bug tracker, or ask for help on the [mailto:help@octave.org mailing list].
 
 
 
== How do install or load all Octave packages? ==
 
  
 
Do not do it!  Really, there is no reason to do this.  Octave has many
 
Do not do it!  Really, there is no reason to do this.  Octave has many
Line 305: Line 274:
 
remember that your programs still need to load the packages they require.
 
remember that your programs still need to load the packages they require.
  
=Coding=
+
=Octave usage=
 
 
==What features are unique to Octave?==
 
 
 
Although most of the Octave language will be familiar to Matlab users, it has some unique features of its own.
 
 
 
=== Functions defined on the command-line===
 
Functions can be defined by entering code on the command line, a feature not supported by Matlab. For example, you may type:
 
 
 
    octave:1> function s = hello_string (to_who)
 
    > ## Say hello
 
    > if nargin<1, to_who = "World"; end
 
    > s = ["Hello ",\
 
    >      to_who];
 
    > endfunction
 
    octave:2> hello_string ("Moon")
 
    ans = Hello Moon
 
 
 
As a natural extension of this, functions can also be defined in script files (m-files whose first non-comment line isn't {{Codeline|function out &#61; foo (...)}})
 
 
 
Note: MATLAB R2016b added the ability to [http://www.mathworks.com/help/matlab/matlab_prog/local-functions-in-scripts.html define functions in script files].
 
 
 
===Comments with #===
 
 
 
The pound character, {{Codeline|#}}, may be used to start comments, in addition to {{Codeline|%}}. See the previous example. The major advantage of this is that as {{Codeline|#}} is also a comment character for unix script files, any file that starts with a string like {{Codeline|#! /usr/bin/octave -q}} will be treated as an octave script and be executed by octave.
 
 
 
===Strings delimited by double quotes "===
 
 
 
The double quote, {{Codeline|"}}, may be used to delimit strings, in addition to the single quote {{Codeline|'}}. See the previous example. Also, double-quoted strings include backslash interpretation (like C++, C, and Perl) while single quoted are uninterpreted (like Matlab and Perl).
 
 
 
===Line continuation by backslash===
 
 
 
Lines can be continued with a backslash, {{Codeline|\}}, in addition to three points {{Codeline|...}}. See the previous example.
 
 
 
===Informative block closing===
 
 
 
You may close function, for, while, if, ... blocks with endfunction, endfor, endwhile, ... keywords in addition to using end. As with Matlab, the end (or endfunction) keyword that marks the end of a function defined in a .m file is optional.
 
 
 
===Coherent syntax===
 
 
 
Indexing other things than variables is possible, as in:
 
 
 
    octave:1> [3 1 4 1 5 9](3)
 
    ans = 4
 
    octave:2> cos([0 pi pi/4 7])(3)
 
    ans = 0.70711
 
 
 
In Matlab, it is for example necessary to assign the intermediate result {{Codeline|cos([0 pi pi/4 7])}} to a variable before it can be indexed again.
 
 
 
===Exclamation mark as not operator===
 
 
 
The exclamation mark {{Codeline|!}} (aka “Bang!”) is a negation operator, just like the tilde {{Codeline|~}}:
 
 
 
    octave:1> if ! strcmp (program_name, "octave"),
 
    >  "It's an error"
 
    > else
 
    >  "It works!"
 
    > end
 
    ans = It works!
 
Note however that Matlab uses the {{Codeline|!}} operator for shell escapes, for which Octave requires using the system command.
 
 
 
===Increment and decrement operators===
 
 
 
If you like the {{Codeline|++}}, {{Codeline|+&#61;}} etc operators, rejoice! Octave includes the C-like increment and decrement operators {{Codeline|++}} and {{Codeline|--}} in both their prefix and postfix forms, in addition to {{Codeline|+&#61;}}, {{Codeline|-&#61;}}, {{Codeline|*&#61;}}, {{Codeline|/&#61;}}, {{Codeline|^&#61;}},{{Codeline|.+&#61;}},{{Codeline|.-&#61;}},{{Codeline|.*&#61;}}, {{Codeline|./&#61;}} and {{Codeline|.^&#61;}}.
 
 
 
For example, to pre-increment the variable x, you would write {{Codeline|++x}}. This would add one to x and then return the new value of x as the result of the expression. It is exactly the same as the expression {{Codeline|x &#61; x + 1}}.
 
 
 
To post-increment a variable x, you would write {{Codeline|x++}}. This adds one to the variable x, but returns the value that x had prior to incrementing it. For example, if x is equal to 2, the result of the expression x++ is 2, and the new value of x is 3.
 
 
 
For matrix and vector arguments, the increment and decrement operators work on each element of the operand.
 
 
 
===Unwind-protect===
 
 
 
In addition to try-catch blocks, Octave supports an alternative form of exception handling modeled after the unwind-protect form of Lisp. The general form of an unwind_protect block looks like this:
 
 
 
    unwind_protect
 
      body
 
    unwind_protect_cleanup
 
      cleanup
 
    end_unwind_protect
 
 
 
Where body and cleanup are both optional and may contain any Octave expressions or commands. The statements in cleanup are guaranteed to be executed regardless of how control exits body.
 
 
 
The unwind_protect statement is often used to reliably restore the values of global variables that need to be temporarily changed.
 
 
 
Matlab can be made to do something similar with their {{Codeline|onCleanup}} function that was introduced in 2008a. Octave also has {{Codeline|onCleanup}} since version 3.4.0.
 
 
 
===Built-in ODE and DAE solvers===
 
 
 
Octave includes LSODE, DASSL and DASPK for solving systems of stiff ordinary differential and differential-algebraic equations. These functions are built in to the interpreter.
 
 
 
===Do-Until loop structure===
 
 
 
Similar to the do-while loop in C and C++, Octave allows a do-until loop which does not exist in Matlab
 
 
 
  x = 0
 
  do
 
    x += 1;
 
  until (x == 10)
 
 
 
===Broadcasting===
 
 
 
Borrowed from [http://stackoverflow.com/q/26948776/3565696 other languages], [http://www.gnu.org/software/octave/doc/v4.0.1/Broadcasting.html octave broadcasting] allows easy and readable vectorization.
 
 
 
  f = (1:0.1:2);
 
  # put angular frequencies on the first dimension to prepare broadcasting
 
  omega = 2 * pi * f(:);
 
  # time is already on the second dimension (row vector)
 
  t = 0:0.02:2;
 
  # the resulting s will be a 2-dimensional array
 
  s = sin(omega .* t);
 
  # which can be displayed as
 
  pcolor(t, f, s)
 
  xlabel("t (s)")
 
  ylabel("f (Hz)")
 
 
 
Note: [https://www.mathworks.com/help/matlab/matlab_prog/compatible-array-sizes-for-basic-operations.html Automatic expansion of dimensions] was added to MATLAB R2016b.
 
 
 
===Documentation strings===
 
Octave allows extensive formatting of the help string of functions using Texinfo. The effect on the online documentation is relatively small, but makes the help string of functions conform to the help of Octave’s own functions. However, the effect on the appearance of printed or online documentation will be greatly improved.
 
 
 
===Test functions===
 
Octave allows to add self-tests to user defined functions. Tests are put after function definition in specially commented block.
 
 
 
  function mult = a(val)
 
          mult = val.*2;
 
  endfunction
 
  %!test
 
  %! assert (a(3), 6);
 
 
 
Such a function can be tested for valid outputs by following code:
 
 
 
  octave:1> test a
 
  PASSES 1 out of 1 test
 
 
 
===Demonstration Functions===
 
 
 
Example code block can be part of function file in a similar manner as test functions. For example to run demo for function multinom of package specfun, use:
 
 
 
  demo multinom
 
 
 
===Powerfull assert===
 
Function assert have extended input possibilities.
 
 
 
==How does Octave solve linear systems?==
 
 
 
In addition to consulting Octave's source for the precise details, you can read the Octave manual for a complete high-level description of the algorithm that Octave uses to decide how to solve a particular linear system, e.g. how the backslash operator {{Codeline|A\x}} will be interpreted. Sections [http://www.gnu.org/software/octave/doc/interpreter/Techniques-Used-for-Linear-Algebra.html#Techniques-Used-for-Linear-Algebra Techniques Used for Linear Algebra] and [http://www.gnu.org/software/octave/doc/interpreter/Sparse-Linear-Algebra.html Linear Algebra on Sparse Matrices] from the manual describe this procedure.
 
 
 
=How do I...?=
 
  
 
==How do I execute an Octave script?==
 
==How do I execute an Octave script?==
Line 475: Line 296:
  
 
If you call the script from the shell and it's plotting, please note [[#When I try plotting from a script, why am I not seeing anything?|how to plot when running a script from the shell]].
 
If you call the script from the shell and it's plotting, please note [[#When I try plotting from a script, why am I not seeing anything?|how to plot when running a script from the shell]].
 
==do xxxx?==
 
 
You are probably looking for the function ''lookfor''. This function searches the help text of all functions for a specific string and returns a list of functions. Note that by default it will only search the first line of the help text (check ''help lookfor'' at the octave prompt for more). The following example helps to find the function to calculate correlation coefficient in a matrix:
 
 
  octave> lookfor correlation
 
  corr2              Returns the correlation coefficient between I and J.
 
  cor                Compute correlation.
 
  corrcoef            Compute correlation.
 
  spearman            Compute Spearman's rank correlation coefficient RHO for each of the variables sp
 
  autocor            Return the autocorrelations from lag 0 to H of vector X.
 
 
Also, there's a high chance that the function name has a suggestive name, and so you can try auto-completion to get some hints. For the previous example, typing ''corr'' at the octave promp followed by pressing [Tab] twice would suggest the following:
 
 
  octave> corr
 
  corr2    corrcoef
 
  
 
==How do I erase a figure?==  
 
==How do I erase a figure?==  
Line 508: Line 313:
 
==How do I call an octave function from C++?==
 
==How do I call an octave function from C++?==
  
*Here is an untested code snippet for calling rand([9000,1]), modified from a post by HerberFarnsworth? to help-octave on 2003-05-01:
+
* Here is an untested code snippet for calling rand([9000,1]), modified from a post by Herber Farnsworth? to help-octave on 2003-05-01:
  
 
  #include <octave/oct.h>
 
  #include <octave/oct.h>
Line 520: Line 325:
 
  Matrix unis(f_ret(0).matrix_value());
 
  Matrix unis(f_ret(0).matrix_value());
  
==How do I change colour/line definition in gnuplot postscript?==
+
==How do I change color/line definition in gnuplot postscript?==
Here is a awk script to get a rainbow colour map
+
 
 +
Here is a awk script to get a rainbow color map
  
 
  #!/bin/awk -f
 
  #!/bin/awk -f
Line 561: Line 367:
 
Look at functions like exist, file_in_path.. and the other functions that their descriptions point to.
 
Look at functions like exist, file_in_path.. and the other functions that their descriptions point to.
  
 
+
==How do I create a plot without a window popping up (plot to a file directly)?==
==How do I create a plot without a window popping up (ie, a plot to a file)?==
 
  
 
'''This only works with gnuplot as graphics_toolkit, NOT with fltk. See [https://savannah.gnu.org/bugs/?33180 Bug#33180]'''
 
'''This only works with gnuplot as graphics_toolkit, NOT with fltk. See [https://savannah.gnu.org/bugs/?33180 Bug#33180]'''
Line 574: Line 379:
 
   set(0, 'defaultfigurevisible', 'off');
 
   set(0, 'defaultfigurevisible', 'off');
  
== How do I make Octave use more precision? ==
+
==How do I make Octave use more precision?==
  
 
Octave's default numerical type is IEEE 754 doubles, a.k.a. hardware floats. This type has 52 bits of precision or about 16 decimal digits. It's implemented in your computer's hardware, in your CPU, so it's '''fast'''. This type is assumed throughout for Octave's calculations.
 
Octave's default numerical type is IEEE 754 doubles, a.k.a. hardware floats. This type has 52 bits of precision or about 16 decimal digits. It's implemented in your computer's hardware, in your CPU, so it's '''fast'''. This type is assumed throughout for Octave's calculations.
Line 582: Line 387:
 
<syntaxhighlight lang="Octave">uint64(18446744073709551610);</syntaxhighlight>
 
<syntaxhighlight lang="Octave">uint64(18446744073709551610);</syntaxhighlight>
  
the literal "18446744073709551610" first gets converted to a double precision type, so <code>uint64</code>'s additional precision is lost. Instead, initialise the <code>uint64</code> with smaller numbers and perform a computation to get the larger number you want. E.g.,  
+
the literal "18446744073709551610" first gets converted to a double precision type, so <code>uint64</code>'s additional precision is lost. Instead, initialize the <code>uint64</code> with smaller numbers and perform a computation to get the larger number you want. E.g.,  
  
 
<syntaxhighlight lang="Octave">uint64(999999999999999) * 10000</syntaxhighlight>
 
<syntaxhighlight lang="Octave">uint64(999999999999999) * 10000</syntaxhighlight>
Line 597: Line 402:
  
 
There are no plans to support running P-files produced by Matlab in Octave.
 
There are no plans to support running P-files produced by Matlab in Octave.
 +
 +
==How does Octave solve linear systems?==
 +
 +
In addition to consulting Octave's source for the precise details, you can read the Octave manual for a complete high-level description of the algorithm that Octave uses to decide how to solve a particular linear system, e.g. how the backslash operator {{Codeline|A\x}} will be interpreted.  Sections [http://www.octave.org/doc/interpreter/Techniques-Used-for-Linear-Algebra.html Techniques Used for Linear Algebra] and [http://www.octave.org/doc/interpreter/Sparse-Linear-Algebra.html Linear Algebra on Sparse Matrices] from the manual describe this procedure.
 +
 +
==How do I do X?==
 +
 +
You are probably looking for the function ''lookfor''. This function searches the help text of all functions for a specific string and returns a list of functions. Note that by default it will only search the first line of the help text (check ''help lookfor'' at the octave prompt for more). The following example helps to find the function to calculate correlation coefficient in a matrix:
 +
 +
  octave> lookfor correlation
 +
  corr2              Returns the correlation coefficient between I and J.
 +
  cor                Compute correlation.
 +
  corrcoef            Compute correlation.
 +
  spearman            Compute Spearman's rank correlation coefficient RHO for each of the variables sp
 +
  autocor            Return the autocorrelations from lag 0 to H of vector X.
 +
 +
Also, there's a high chance that the function name has a suggestive name, and so you can try auto-completion to get some hints. For the previous example, typing ''corr'' at the octave promp followed by pressing [Tab] twice would suggest the following:
 +
 +
  octave> corr
 +
  corr2    corrcoef
  
 
=Common problems=
 
=Common problems=
Line 604: Line 429:
 
By default Octave is set to pass its screen output through a pager (usually the default pager is "less") which allows
 
By default Octave is set to pass its screen output through a pager (usually the default pager is "less") which allows
 
things such as navigating through the output with arrow keys or searching for text or regular expressions within the output.
 
things such as navigating through the output with arrow keys or searching for text or regular expressions within the output.
The pager only displays the output after it's finished receiving it, so when it is active you'll not be able to see anything until your script has terminated. To change this behavior temporarily or permanently you may want to use one of the options described [http://www.gnu.org/software/octave/doc/interpreter/Paging-Screen-Output.html here].
+
The pager only displays the output after it's finished receiving it, so when it is active you'll not be able to see anything until your script has terminated. To change this behavior temporarily or permanently you may want to use one of the options described [http://www.octave.org/doc/interpreter/Paging-Screen-Output.html here].
  
 
==When I try plotting from a script, why am I not seeing anything?==
 
==When I try plotting from a script, why am I not seeing anything?==
Line 625: Line 450:
 
* Fedora: {{Codeline|octave-devel}}
 
* Fedora: {{Codeline|octave-devel}}
  
== I'm having problem XXX using the latest Octave version ==
+
==I'm having problem X using the latest Octave version==
  
 
Please be more specific. What is the latest version, according to you? If you mean the latest released version, be aware that you may still have an older version due to whatever distribution method you're using. There may be a newer version available that you're not aware of due to the distribution method you're using to get Octave, and in most cases, there is a way to get a newer version via your distribution method (see other wiki pages for [[Octave_for_GNU/Linux|GNU/Linux]], [[Octave_for_MacOS_X|Mac OSX]], and [[Octave_for_Windows|Windows]]).
 
Please be more specific. What is the latest version, according to you? If you mean the latest released version, be aware that you may still have an older version due to whatever distribution method you're using. There may be a newer version available that you're not aware of due to the distribution method you're using to get Octave, and in most cases, there is a way to get a newer version via your distribution method (see other wiki pages for [[Octave_for_GNU/Linux|GNU/Linux]], [[Octave_for_MacOS_X|Mac OSX]], and [[Octave_for_Windows|Windows]]).
Line 635: Line 460:
 
If your problem truly persists with the latest version, as indicated [http://www.gnu.org/software/octave/download.html here], then by all means report a bug or ask for help, but don't be surprised if volunteers are less inclined to help you with a problem that only exists in an older version of Octave.
 
If your problem truly persists with the latest version, as indicated [http://www.gnu.org/software/octave/download.html here], then by all means report a bug or ask for help, but don't be surprised if volunteers are less inclined to help you with a problem that only exists in an older version of Octave.
  
== Why is this floating point computation wrong? ==
+
==Why is Octave's floating-point computation wrong?==
  
 
Floating point arithmetic is an approximation '''in binary''' to arithmetic on real or complex numbers. Just like you cannot represent 1/3 exactly in decimal arithmetic (0.333333 is only a rough approximation to 1/3), you cannot represent some fractions like <math>1/10</math> exactly in base 2. In binary, the representation to one tenth is <math>0.0\overline{0011}_b</math> where the bar indicates that it repeats infinitely (like how <math>1/6 = 0.1\overline{6}_d</math> in decimal). Because this infinite repetition cannot be represented exactly with a finite number of digits, rounding errors occur for values that appear to be exact in decimal but are in fact approximations in binary, such as for example how 0.3 - 0.2 - 0.1 is not equal to zero.
 
Floating point arithmetic is an approximation '''in binary''' to arithmetic on real or complex numbers. Just like you cannot represent 1/3 exactly in decimal arithmetic (0.333333 is only a rough approximation to 1/3), you cannot represent some fractions like <math>1/10</math> exactly in base 2. In binary, the representation to one tenth is <math>0.0\overline{0011}_b</math> where the bar indicates that it repeats infinitely (like how <math>1/6 = 0.1\overline{6}_d</math> in decimal). Because this infinite repetition cannot be represented exactly with a finite number of digits, rounding errors occur for values that appear to be exact in decimal but are in fact approximations in binary, such as for example how 0.3 - 0.2 - 0.1 is not equal to zero.
Line 649: Line 474:
 
To learn more about floating point arithmetic, consult [http://en.wikipedia.org/wiki/Floating_point_arithmetic its Wikipedia article] or the classical reference [http://floating-point-gui.de/ What Every Computer Scientist Should Know About Floating Point Arithmetic].
 
To learn more about floating point arithmetic, consult [http://en.wikipedia.org/wiki/Floating_point_arithmetic its Wikipedia article] or the classical reference [http://floating-point-gui.de/ What Every Computer Scientist Should Know About Floating Point Arithmetic].
  
== I have installed a package but still get a "foo undefined" error ==
+
==I have installed a package but still get a "foo undefined" error?==
  
 
You have probably forgotten to load the package. Use {{Codeline|pkg load package-name}} to load it. Most packages are no longer loaded automatically to avoid surprises. See reasoning on related FAQ [[FAQ#How_do_I_install_all_Octave_packages.3F|how do I install all Octave packages]]. If you want a specific package to be loaded by default at startup, consider adding the {{Codeline|pkg load}} command on your {{path|[[.octaverc]]}} file.
 
You have probably forgotten to load the package. Use {{Codeline|pkg load package-name}} to load it. Most packages are no longer loaded automatically to avoid surprises. See reasoning on related FAQ [[FAQ#How_do_I_install_all_Octave_packages.3F|how do I install all Octave packages]]. If you want a specific package to be loaded by default at startup, consider adding the {{Codeline|pkg load}} command on your {{path|[[.octaverc]]}} file.
  
== Missing lines when printing under Windows with OpenGL toolkit and Intel integrated GPU ==
+
==Missing lines when printing under Windows with OpenGL toolkit and Intel integrated GPU==
  
 
Some windows users with integrated Intel GPUs have reported missing lines when printing with an OpenGL toolkit like FLTK or Qt. {{bug|42534}}
 
Some windows users with integrated Intel GPUs have reported missing lines when printing with an OpenGL toolkit like FLTK or Qt. {{bug|42534}}
Line 661: Line 486:
 
See also https://www.opengl.org/wiki/FAQ#Why_is_my_GL_version_only_1.4_or_lower.3F
 
See also https://www.opengl.org/wiki/FAQ#Why_is_my_GL_version_only_1.4_or_lower.3F
  
== Plot hangs and makes the GUI unresponsive ==
+
==Plot hangs and makes the GUI unresponsive==
  
 
If the Qt graphics toolkit is used and "plot" is used for the first time, the fontconfig scanner searches the font directory to build a font cache. This can take up to 3min on slow CPUs. See {{bug|45458}}
 
If the Qt graphics toolkit is used and "plot" is used for the first time, the fontconfig scanner searches the font directory to build a font cache. This can take up to 3min on slow CPUs. See {{bug|45458}}
  
= Differences between Octave and Matlab =
+
=Differences between Octave and Matlab=
  
 
People often ask
 
People often ask
  
 
<blockquote>
 
<blockquote>
I wrote some code for Matlab, and I want to get it running under Octave. Is there anything I should watch out for?
+
I wrote some code for Matlab, and I want to get it running under Octave. Is there anything I should watch out for?
 
</blockquote>
 
</blockquote>
  
Line 676: Line 501:
  
 
<blockquote>
 
<blockquote>
I wrote some code in Octave, and want to share it with Matlab users. Is there anything I should watch out for?
+
I wrote some code in Octave, and want to share it with Matlab users. Is there anything I should watch out for?
 
</blockquote>
 
</blockquote>
  
Line 687: Line 512:
 
You should also look at the pages http://octave.sourceforge.net/packages.php and http://octave.sourceforge.net/docs.html that have a function reference that is up to date. You can use this function reference to see the number of octave functions that are available and their Matlab compatibility.
 
You should also look at the pages http://octave.sourceforge.net/packages.php and http://octave.sourceforge.net/docs.html that have a function reference that is up to date. You can use this function reference to see the number of octave functions that are available and their Matlab compatibility.
  
== Nested Functions ==
+
==Nested Functions==
 +
 
 
Octave has limited support for nested functions. That is
 
Octave has limited support for nested functions. That is
  
Line 710: Line 536:
 
The authors of Octave consider the nested function scoping rules of Matlab to be more problems than they are worth as they introduce difficult to find bugs as inadvertently modifying a variable in a nested function that is also used in the parent is particularly easy for those not attentive to detail.
 
The authors of Octave consider the nested function scoping rules of Matlab to be more problems than they are worth as they introduce difficult to find bugs as inadvertently modifying a variable in a nested function that is also used in the parent is particularly easy for those not attentive to detail.
  
== Differences in core syntax ==
+
==Differences in core syntax==
  
 
There are a few core Matlab syntaxes that are not accepted by Octave, these being
 
There are a few core Matlab syntaxes that are not accepted by Octave, these being
Line 720: Line 546:
 
* Matlab classdef object oriented programming is not yet supported, though work is underway in a branch of the development tree.
 
* Matlab classdef object oriented programming is not yet supported, though work is underway in a branch of the development tree.
  
== Differences in core functions ==
+
==Differences in core functions==
  
 
A large number of the Matlab core functions (ie those that are in the core and not a toolbox) are implemented, and certainly all of the commonly used ones. There are a few functions that aren't implemented, usually to do with specific missing Octave functionality (GUI, DLL, Java, ActiveX, DDE, web, and serial functions). Some of the core functions have limitations that aren't in the Matlab version. For example the sprandn function can not force a particular condition number for the matrix like Matlab can. Another example is that testing and the runtests function work differently in Matlab and Octave.
 
A large number of the Matlab core functions (ie those that are in the core and not a toolbox) are implemented, and certainly all of the commonly used ones. There are a few functions that aren't implemented, usually to do with specific missing Octave functionality (GUI, DLL, Java, ActiveX, DDE, web, and serial functions). Some of the core functions have limitations that aren't in the Matlab version. For example the sprandn function can not force a particular condition number for the matrix like Matlab can. Another example is that testing and the runtests function work differently in Matlab and Octave.
  
== Just-In-Time compiler ==
+
==Just-In-Time compiler==
  
 
Matlab includes a "Just-In-Time" compiler. This compiler allows the acceleration of for-loops in Matlab to almost native performance with certain restrictions. The JIT must know the return type of all functions called in the loops and so you can't include user functions in the loop of JIT optimized loops. Octave doesn't have a JIT and so to some might seem slower than Matlab. For this reason you must vectorize your code as much as possible. The MathWorks themselves have a good document discussing vectorization at http://www.mathworks.com/support/tech-notes/1100/1109.html.
 
Matlab includes a "Just-In-Time" compiler. This compiler allows the acceleration of for-loops in Matlab to almost native performance with certain restrictions. The JIT must know the return type of all functions called in the loops and so you can't include user functions in the loop of JIT optimized loops. Octave doesn't have a JIT and so to some might seem slower than Matlab. For this reason you must vectorize your code as much as possible. The MathWorks themselves have a good document discussing vectorization at http://www.mathworks.com/support/tech-notes/1100/1109.html.
  
== Compiler ==
+
==Compiler==
  
 
On a related point, there is no Octave compiler, and so you can't convert your Octave code into a binary for additional speed or distribution. There have been several aborted attempts at creating an Octave compiler. Should the JIT compiler above ever be implemented, an Octave compiler should be more feasible.
 
On a related point, there is no Octave compiler, and so you can't convert your Octave code into a binary for additional speed or distribution. There have been several aborted attempts at creating an Octave compiler. Should the JIT compiler above ever be implemented, an Octave compiler should be more feasible.
  
== Graphic handles ==
+
==Graphic handles==
  
 
Up to Octave 2.9.9 there was no support for graphic handles in Octave itself. In the 3.2.N versions of Octave and beyond, the support for graphics handles is converging towards full compatibility. The patch function is currently limited to 2-D patches, due to an underlying limitation in gnuplot, but the experimental OpenGL backend is starting to see an implementation of 3-D patches.
 
Up to Octave 2.9.9 there was no support for graphic handles in Octave itself. In the 3.2.N versions of Octave and beyond, the support for graphics handles is converging towards full compatibility. The patch function is currently limited to 2-D patches, due to an underlying limitation in gnuplot, but the experimental OpenGL backend is starting to see an implementation of 3-D patches.
  
== GUI functions ==
+
==GUI functions==
  
 
There are no Matlab compatible GUI functions yet.  This might be an issue if you intend to exchange Octave code with Matlab users. There are a number of bindings from Octave to {{Forge|tcl-octave|Tcl/Tk}}, [http://octaviz.sourceforge.net/index.php? VTK] and {{Forge|zenity}} for example, that can be used for a GUI, but these are not Matlab compatible. Work on a Matlab compatible GUI is in an alpha stage in the QtHandles project, which may form part of a future release of Octave.
 
There are no Matlab compatible GUI functions yet.  This might be an issue if you intend to exchange Octave code with Matlab users. There are a number of bindings from Octave to {{Forge|tcl-octave|Tcl/Tk}}, [http://octaviz.sourceforge.net/index.php? VTK] and {{Forge|zenity}} for example, that can be used for a GUI, but these are not Matlab compatible. Work on a Matlab compatible GUI is in an alpha stage in the QtHandles project, which may form part of a future release of Octave.
  
== Simulink ==
+
==Simulink==
  
 
Octave itself includes no Simulink support. Typically the simulink models lag research and are less flexible, so shouldn't really be used in a research environment. However, some Matlab users that try to use Octave complain about this lack.
 
Octave itself includes no Simulink support. Typically the simulink models lag research and are less flexible, so shouldn't really be used in a research environment. However, some Matlab users that try to use Octave complain about this lack.
  
== MEX-Files ==
+
==MEX-Files==
  
 
Octave includes an API to the Matlab MEX interface. However, as MEX is an API to the internals of Matlab and the internals of Octave differ from Matlab, there is necessarily a manipulation of the data to convert from a MEX interface to the Octave equivalent. This is notable for all complex matrices, where Matlab stores complex arrays as real and imaginary parts, whereas Octave respects the C99/C++ standards of co-locating the real/imag parts in memory. Also due to the way Matlab allows access to the arrays passed through a pointer, the MEX interface might require copies of arrays (even non complex ones).
 
Octave includes an API to the Matlab MEX interface. However, as MEX is an API to the internals of Matlab and the internals of Octave differ from Matlab, there is necessarily a manipulation of the data to convert from a MEX interface to the Octave equivalent. This is notable for all complex matrices, where Matlab stores complex arrays as real and imaginary parts, whereas Octave respects the C99/C++ standards of co-locating the real/imag parts in memory. Also due to the way Matlab allows access to the arrays passed through a pointer, the MEX interface might require copies of arrays (even non complex ones).
  
== Block comments ==
+
==Block comments==
  
 
Block comments denoted by {{Codeline|#{}} and {{Codeline|#&#125;}}  markers (or {{Codeline|%{}} and {{Codeline|%&#125;}}) are supported by Octave with some limitations. The major limitation is that block comments are not supported within [] or {}.
 
Block comments denoted by {{Codeline|#{}} and {{Codeline|#&#125;}}  markers (or {{Codeline|%{}} and {{Codeline|%&#125;}}) are supported by Octave with some limitations. The major limitation is that block comments are not supported within [] or {}.
  
== Mat-File format ==
+
==Mat-File format==
  
 
There are some differences in the mat v5 file format accepted by Octave. Matlab recently introduced the "-V7.3" save option which is an HDF5 format which is particularly useful for 64-bit platforms where the standard Matlab format can not correctly save variables. Octave accepts HDF5 files, but is not yet compatible with the "-v7.3" versions produced by Matlab.
 
There are some differences in the mat v5 file format accepted by Octave. Matlab recently introduced the "-V7.3" save option which is an HDF5 format which is particularly useful for 64-bit platforms where the standard Matlab format can not correctly save variables. Octave accepts HDF5 files, but is not yet compatible with the "-v7.3" versions produced by Matlab.
Line 760: Line 586:
 
Finally, some multi-byte Unicode characters aren't yet treated in mat-files.
 
Finally, some multi-byte Unicode characters aren't yet treated in mat-files.
  
== Profiler ==
+
==Profiler==
  
 
Thanks to Daniel Kraft's 2011 Google Summer of Code project, Octave has a profiler since version 3.6.0. However, at the moment it only produces text output and has its own makeshift interface for hierarchical profiling.
 
Thanks to Daniel Kraft's 2011 Google Summer of Code project, Octave has a profiler since version 3.6.0. However, at the moment it only produces text output and has its own makeshift interface for hierarchical profiling.
  
== Toolboxes ==
+
==Toolboxes==
  
 
Octave is a community project and so the toolboxes that exist are donated by those interested in them through [[Octave Forge]]. These might be lacking in certain functionality relative to the Matlab toolboxes, and might not exactly duplicate the Matlab functionality or interface.
 
Octave is a community project and so the toolboxes that exist are donated by those interested in them through [[Octave Forge]]. These might be lacking in certain functionality relative to the Matlab toolboxes, and might not exactly duplicate the Matlab functionality or interface.
  
== Short-circuit {{Codeline|&}} and {{Codeline|&#124;}} operators ==
+
==Short-circuit {{Codeline|&}} and {{Codeline|&#124;}} operators==
  
 
The {{Codeline|&}} and {{Codeline|&#124;}} operators in Matlab short-circuit when included in a condition (e.g. an {{Codeline|if}} or {{Codeline|while}} statement) and not otherwise. In Octave only the {{Codeline|&&}} and {{Codeline|&#124;&#124;}} short circuit. Note that this means that
 
The {{Codeline|&}} and {{Codeline|&#124;}} operators in Matlab short-circuit when included in a condition (e.g. an {{Codeline|if}} or {{Codeline|while}} statement) and not otherwise. In Octave only the {{Codeline|&&}} and {{Codeline|&#124;&#124;}} short circuit. Note that this means that
Line 783: Line 609:
 
             end
 
             end
  
have different semantics in Matlab. This is really a Matlab bug, but there is too much code out there that relies on this behaviour to change it. Prefer the {{Codeline|&#124;&#124;}} and {{Codeline|&&}} operators in {{Codeline|if}} statements if possible. If you need to use code written for Matlab that depends on this buggy behaviour, you can enable it since Octave 3.4.0 with the following command:
+
have different semantics in Matlab. This is really a Matlab bug, but there is too much code out there that relies on this behavior to change it. Prefer the {{Codeline|&#124;&#124;}} and {{Codeline|&&}} operators in {{Codeline|if}} statements if possible. If you need to use code written for Matlab that depends on this buggy behavior, you can enable it since Octave 3.4.0 with the following command:
  
 
             do_braindead_shortcircuit_evaluation(1)
 
             do_braindead_shortcircuit_evaluation(1)
Line 818: Line 644:
 
because, despite the name, the {{Codeline|all}} is really returning true if none of the elements of the matrix are zero, and since there are no elements, well, none of them are zero. This is an example of [http://en.wikipedia.org/wiki/Vacuous_truth vacuous truth]. But, somewhere along the line, someone decided that {{Codeline|if ([])}} should be false. Mathworks probably thought it just looks wrong to have {{Codeline|[]}} be true in this context even if you can use logical gymnastics to convince yourself that "all" the elements of an empty matrix are nonzero. Octave however duplicates this behavior for {{Codeline|if}} statements containing empty matrices.
 
because, despite the name, the {{Codeline|all}} is really returning true if none of the elements of the matrix are zero, and since there are no elements, well, none of them are zero. This is an example of [http://en.wikipedia.org/wiki/Vacuous_truth vacuous truth]. But, somewhere along the line, someone decided that {{Codeline|if ([])}} should be false. Mathworks probably thought it just looks wrong to have {{Codeline|[]}} be true in this context even if you can use logical gymnastics to convince yourself that "all" the elements of an empty matrix are nonzero. Octave however duplicates this behavior for {{Codeline|if}} statements containing empty matrices.
  
== Solvers for singular, under- and over-determined matrices ==
+
==Solvers for singular, under- and over-determined matrices==
  
 
Matlab's solvers as used by the operators mldivide (\) and mrdivide (/), use a different approach than Octave's in the case of singular, under-, or over-determined matrices. In the case of a singular matrix, Matlab returns the result given by the LU decomposition, even though the underlying solver has flagged the result as erroneous. Octave has made the choice of falling back to a minimum norm solution of matrices that have been flagged as singular which arguably is a better result for these cases.
 
Matlab's solvers as used by the operators mldivide (\) and mrdivide (/), use a different approach than Octave's in the case of singular, under-, or over-determined matrices. In the case of a singular matrix, Matlab returns the result given by the LU decomposition, even though the underlying solver has flagged the result as erroneous. Octave has made the choice of falling back to a minimum norm solution of matrices that have been flagged as singular which arguably is a better result for these cases.
Line 857: Line 683:
 
Since the mldivide (\) and mrdivide (/) operators are often part of a more complex expression, where there is no room to react to warnings or flags, it should prefer intelligence (robustness) to speed, and so the Octave developers are firmly of the opinion that Octave's approach for singular, under- and over-determined matrices is a better choice than Matlab's.
 
Since the mldivide (\) and mrdivide (/) operators are often part of a more complex expression, where there is no room to react to warnings or flags, it should prefer intelligence (robustness) to speed, and so the Octave developers are firmly of the opinion that Octave's approach for singular, under- and over-determined matrices is a better choice than Matlab's.
  
== Octave extensions ==
+
==Octave extensions==
  
 
The extensions in Octave over MATLAB syntax are very useful, but might cause issues when sharing with Matlab users. A list of the major extensions that should be avoided to be compatible with Matlab are:
 
The extensions in Octave over MATLAB syntax are very useful, but might cause issues when sharing with Matlab users. A list of the major extensions that should be avoided to be compatible with Matlab are:
Line 903: Line 729:
  
 
Character strings in Octave can be denoted with double or single quotes. There is a subtle difference between the two in that escaped characters like {{Codeline|\n}} (newline), {{Codeline|\t}} (tab), etc are interpreted in double quoted strings but not single quoted strings. This difference is important on Windows platforms where the {{Codeline|\}} character is used in path names, and so single quoted strings should be used in paths. MATLAB doesn't have double quoted strings and so they should be avoided if the code will be transferred to a MATLAB user.
 
Character strings in Octave can be denoted with double or single quotes. There is a subtle difference between the two in that escaped characters like {{Codeline|\n}} (newline), {{Codeline|\t}} (tab), etc are interpreted in double quoted strings but not single quoted strings. This difference is important on Windows platforms where the {{Codeline|\}} character is used in path names, and so single quoted strings should be used in paths. MATLAB doesn't have double quoted strings and so they should be avoided if the code will be transferred to a MATLAB user.
 +
 +
==What features are unique to Octave?==
 +
 +
Although most of the Octave language will be familiar to Matlab users, it has some unique features of its own.
 +
 +
=== Functions defined on the command-line===
 +
Functions can be defined by entering code on the command line, a feature not supported by Matlab. For example, you may type:
 +
 +
    octave:1> function s = hello_string (to_who)
 +
    > ## Say hello
 +
    > if nargin<1, to_who = "World"; end
 +
    > s = ["Hello ",\
 +
    >      to_who];
 +
    > endfunction
 +
    octave:2> hello_string ("Moon")
 +
    ans = Hello Moon
 +
 +
As a natural extension of this, functions can also be defined in script files (m-files whose first non-comment line isn't {{Codeline|function out &#61; foo (...)}})
 +
 +
Note: MATLAB R2016b added the ability to [http://www.mathworks.com/help/matlab/matlab_prog/local-functions-in-scripts.html define functions in script files].
 +
 +
===Comments with #===
 +
 +
The pound character, {{Codeline|#}}, may be used to start comments, in addition to {{Codeline|%}}. See the previous example. The major advantage of this is that as {{Codeline|#}} is also a comment character for unix script files, any file that starts with a string like {{Codeline|#! /usr/bin/octave -q}} will be treated as an octave script and be executed by octave.
 +
 +
===Strings delimited by double quotes "===
 +
 +
The double quote, {{Codeline|"}}, may be used to delimit strings, in addition to the single quote {{Codeline|'}}. See the previous example. Also, double-quoted strings include backslash interpretation (like C++, C, and Perl) while single quoted are uninterpreted (like Matlab and Perl).
 +
 +
===Line continuation by backslash===
 +
 +
Lines can be continued with a backslash, {{Codeline|\}}, in addition to three points {{Codeline|...}}. See the previous example.
 +
 +
===Informative block closing===
 +
 +
You may close function, for, while, if, ... blocks with endfunction, endfor, endwhile, ... keywords in addition to using end. As with Matlab, the end (or endfunction) keyword that marks the end of a function defined in a .m file is optional.
 +
 +
===Coherent syntax===
 +
 +
Indexing other things than variables is possible, as in:
 +
 +
    octave:1> [3 1 4 1 5 9](3)
 +
    ans = 4
 +
    octave:2> cos([0 pi pi/4 7])(3)
 +
    ans = 0.70711
 +
 +
In Matlab, it is for example necessary to assign the intermediate result {{Codeline|cos([0 pi pi/4 7])}} to a variable before it can be indexed again.
 +
 +
===Exclamation mark as not operator===
 +
 +
The exclamation mark {{Codeline|!}} (aka “Bang!”) is a negation operator, just like the tilde {{Codeline|~}}:
 +
 +
    octave:1> if ! strcmp (program_name, "octave"),
 +
    >  "It's an error"
 +
    > else
 +
    >  "It works!"
 +
    > end
 +
    ans = It works!
 +
Note however that Matlab uses the {{Codeline|!}} operator for shell escapes, for which Octave requires using the system command.
 +
 +
===Increment and decrement operators===
 +
 +
If you like the {{Codeline|++}}, {{Codeline|+&#61;}} etc operators, rejoice! Octave includes the C-like increment and decrement operators {{Codeline|++}} and {{Codeline|--}} in both their prefix and postfix forms, in addition to {{Codeline|+&#61;}}, {{Codeline|-&#61;}}, {{Codeline|*&#61;}}, {{Codeline|/&#61;}}, {{Codeline|^&#61;}},{{Codeline|.+&#61;}},{{Codeline|.-&#61;}},{{Codeline|.*&#61;}}, {{Codeline|./&#61;}} and {{Codeline|.^&#61;}}.
 +
 +
For example, to pre-increment the variable x, you would write {{Codeline|++x}}. This would add one to x and then return the new value of x as the result of the expression. It is exactly the same as the expression {{Codeline|x &#61; x + 1}}.
 +
 +
To post-increment a variable x, you would write {{Codeline|x++}}. This adds one to the variable x, but returns the value that x had prior to incrementing it. For example, if x is equal to 2, the result of the expression x++ is 2, and the new value of x is 3.
 +
 +
For matrix and vector arguments, the increment and decrement operators work on each element of the operand.
 +
 +
===Unwind-protect===
 +
 +
In addition to try-catch blocks, Octave supports an alternative form of exception handling modeled after the unwind-protect form of Lisp. The general form of an unwind_protect block looks like this:
 +
 +
    unwind_protect
 +
      body
 +
    unwind_protect_cleanup
 +
      cleanup
 +
    end_unwind_protect
 +
 +
Where body and cleanup are both optional and may contain any Octave expressions or commands. The statements in cleanup are guaranteed to be executed regardless of how control exits body.
 +
 +
The unwind_protect statement is often used to reliably restore the values of global variables that need to be temporarily changed.
 +
 +
Matlab can be made to do something similar with their {{Codeline|onCleanup}} function that was introduced in 2008a. Octave also has {{Codeline|onCleanup}} since version 3.4.0.
 +
 +
===Built-in ODE and DAE solvers===
 +
 +
Octave includes LSODE, DASSL and DASPK for solving systems of stiff ordinary differential and differential-algebraic equations. These functions are built in to the interpreter.
 +
 +
===Do-Until loop structure===
 +
 +
Similar to the do-while loop in C and C++, Octave allows a do-until loop which does not exist in Matlab
 +
 +
  x = 0
 +
  do
 +
    x += 1;
 +
  until (x == 10)
 +
 +
===Broadcasting===
 +
 +
Borrowed from [http://stackoverflow.com/q/26948776/3565696 other languages], [http://www.gnu.org/software/octave/doc/v4.0.1/Broadcasting.html octave broadcasting] allows easy and readable vectorization.
 +
 +
  f = (1:0.1:2);
 +
  # put angular frequencies on the first dimension to prepare broadcasting
 +
  omega = 2 * pi * f(:);
 +
  # time is already on the second dimension (row vector)
 +
  t = 0:0.02:2;
 +
  # the resulting s will be a 2-dimensional array
 +
  s = sin(omega .* t);
 +
  # which can be displayed as
 +
  pcolor(t, f, s)
 +
  xlabel("t (s)")
 +
  ylabel("f (Hz)")
 +
 +
Note: [https://www.mathworks.com/help/matlab/matlab_prog/compatible-array-sizes-for-basic-operations.html Automatic expansion of dimensions] was added to MATLAB R2016b.
 +
 +
===Documentation strings===
 +
 +
Octave allows extensive formatting of the help string of functions using Texinfo. The effect on the online documentation is relatively small, but makes the help string of functions conform to the help of Octave’s own functions. However, the effect on the appearance of printed or online documentation will be greatly improved.
 +
 +
===Test functions===
 +
 +
Octave allows to add self-tests to user defined functions. Tests are put after function definition in specially commented block.
 +
 
 +
  function mult = a(val)
 +
          mult = val.*2;
 +
  endfunction
 +
  %!test
 +
  %! assert (a(3), 6);
 +
 +
Such a function can be tested for valid outputs by following code:
 +
 +
  octave:1> test a
 +
  PASSES 1 out of 1 test
 +
 +
===Demonstration Functions===
 +
 +
Example code block can be part of function file in a similar manner as test functions. For example to run demo for function multinom of package specfun, use:
 +
 +
  demo multinom
 +
 +
===Powerfull assert===
 +
 +
Function assert have extended input possibilities.
  
 
=[https://en.wikipedia.org/wiki/Graphical_user_interface GUI]=
 
=[https://en.wikipedia.org/wiki/Graphical_user_interface GUI]=
Line 955: Line 926:
  
 
This is one of those times where the best documentation is to read the existing code.  We have three different toolkits in Octave now, so there are some examples to draw from.
 
This is one of those times where the best documentation is to read the existing code.  We have three different toolkits in Octave now, so there are some examples to draw from.
 +
 +
=Development=
 +
 +
==When will feature X be released or implemented?==
 +
 +
When it's ready, sooner [http://www.octave.org/get-involved.html if you help].  You can [https://savannah.gnu.org/patch/?group=octave send us patches] if you can implement feature X yourself.  If you can't, some [http://www.octave.org/commercial-support.html developers may be convinced to work on your specific problem for some money].
 +
 +
==How can I get involved in Octave development?==
 +
 +
Be around.  Be social.  Participate in our mailing lists [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org] and [https://lists.gnu.org/mailman/listinfo/octave-maintainers maintainers@octave.org].  Find things about Octave you don't like, and start thinking about how to fix them.  Many people who now contribute to Octave first spent several years helping in the mailing list before they started to delve into the code.  A good way to learn Octave is to understand the problems other people are having with it, so being helpful in the mailing lists not only helps Octave as a whole, but it also prepares you to be a better Octave contributor.
 +
 +
If you feel ready to dive right into the code, read the [[Developers]] wiki page or [http://www.octave.org/get-involved.html start here].  But do not send an email to the mailing lists listing your skills and offering to help.  We won't just suggest things for you to do.  We lack volunteers and we do need your help, but because of that, we also lack the time to provide good guidance and mentoring.  If there is a specific short-term project you would like to work on, say so, and just do it.  Then ask for help or advice when you're doing it.  It is a lot more important that you do something that you're actually interested on than something we suggested because it only matches your skills.
 +
 +
We also need help with this wiki and the [http://www.octave.org/doc/interpreter/ manual].  These are also important tasks.  The documentation is easy to patch, and the help text for individual functions even more so.  Editing this wiki is even easier.
 +
 +
Accurate bug reporting is also very useful.  Find and report [http://bugs.octave.org/ bugs], making an attempt to diagnose them.  Eventually, you will also know how to fix them.  If you want to help with bug reports or patches, subscribe to the [https://lists.gnu.org/mailman/listinfo/octave-bug-tracker bug tracker mailing list].  You'll get updates on all bug activity, and you can jump in when you see
 +
something you can help with.
 +
 +
Look at our [[projects]], [[short projects]], and [[Summer of Code Project Ideas]] if you need specific inspiration for coding tasks that we would like to get done.

Revision as of 04:23, 28 July 2017

This is a list of frequently asked questions (FAQ) for GNU Octave users.

We are always looking for new questions (with answers), better answers, or both. Feel free to edit this page with your changes.

Where do I get additional help?

If you can't find an answer to your question in this FAQ, wiki, or in the manual (PDF) you can:

Contents

General

What is Octave?

GNU Octave is a high-level interpreted language, primarily intended for numerical computations. It provides capabilities for the numerical solution of linear and nonlinear problems, and for performing other numerical experiments. It also provides extensive graphics capabilities for data visualization and manipulation. GNU Octave is normally used through its interactive interface (CLI and GUI), but it can also be used to write non-interactive programs.

The GNU Octave language is quite similar to Matlab so that most programs are easily portable.

The GNU Octave distribution includes a 1000+ page Texinfo manual. Access to the complete text of the manual is available via the doc command at the GNU Octave prompt.

What is Octave-Forge?

Octave-Forge is a collection of packages for GNU Octave, something similar to the Matlab toolboxes. When talking about the two projects at the same time, GNU Octave is usually referred to as Octave core (or just "core"). Octave-Forge also serves as a test bed for code that may eventually end up in the core, and distributes binaries for systems with a lack of developers tools (mainly Windows).

Who uses Octave?

Lots of people. Universities use it for research and teaching, companies of all sizes for development, and individuals for whatever private purpose. See Who Uses Octave? for a few answers.

Who develops Octave?

Discussions about writing the software that would eventually become Octave started in about 1988 with James B. Rawlings and John W. Eaton at the University of Texas. John W. Eaton is the original author of Octave, starting full-time development in February 1992. He is still the primary maintainer. The community of users and developers has in addition contributed some code and fuels the discussion on the mailing lists help@octave.org (user forum), maintainers@octave.org (development issues).

Why "Octave"?

Octave's name has nothing to do with music. It is named after Octave Levenspiel, a former professor of John who was famous for his ability to do quick back-of-the-envelope calculations. You can hear John pronounce the name "Octave" a few times in this video. We hope that GNU Octave will help perform computations with the same ease as Dr. Levenspiel.

Why "GNU" Octave?

The GNU Project was launched in 1984 to develop a complete Unix-like operating system which is free software: the GNU system. GNU is a recursive acronym for "GNU's Not Unix"; it is pronounced g'noo.

The Free Software Foundation (FSF) is the principal organizational sponsor of the GNU Project.

Octave became GNU Octave in 1997 (beginning with version 2.0.6). This meant agreeing to consider Octave a part of the GNU Project and support the efforts of the FSF. A big part of this effort is to adhere to the GNU coding standards and to benefit from GNU's infrastructure (e.g. code hosting and bug tracking). Additionally, Octave receives sponsorship from the FSF's Working Together fund. However, Octave is not and has never been developed by the FSF.

How can I cite Octave?

Octave is free software and does not legally bind you to cite it. However, we have invested a lot of time and effort in creating GNU Octave, and we would appreciate if you would cite if you used. To cite GNU Octave in publications use:

 John W. Eaton, David Bateman, Søren Hauberg, Rik Wehbring (2017).
 GNU Octave version 5.1.0 manual: a high-level interactive language for numerical computations.
 URL https://www.gnu.org/software/octave/doc/v5.1.0/

A BibTeX entry for LaTeX users is:

 @manual{,
   title     = {{GNU Octave} version 5.1.0 manual: a high-level interactive language for numerical computations},
   author    = {John W. Eaton and David Bateman and S{\o}ren Hauberg and Rik Wehbring},
   year      = {2017},
   url       = {https://www.gnu.org/software/octave/doc/v5.1.0/},
 }

Run citation at the Octave prompt for details on how to best cite the Octave version you are running. Certain Octave packages also have recommended citations in which case use citation package_name.

Note that there are two reasons for citing the software used. One is giving recognition to the work done by others which we already addressed. The other is giving details on the system used so that experiments can be replicated. For this, you should cite the version of Octave and all packages used (you can get this information using the ver command), as well as any details of your setup as part of your Methods. In addition, you should make your source available. See How to cite and describe software for more details and an in depth discussion.

What documentation exists for Octave?

Besides this wiki, the GNU Octave distribution includes a 1000+ page Texinfo manual (PDF). Access to the complete text of the manual is available via the doc command at the GNU Octave prompt. If you have problems using this manual, or find that some topic is not adequately explained, indexed, or cross-referenced, please report it on http://bugs.octave.org.

How can I report a bug in Octave?

Please read our website http://www.octave.org/bugs.html.

Licensing issues

If I write code using Octave do I have to release it under the GPL?

The answer depends on precisely how the code is written and how it works:

  • Code written entirely in the scripting language of Octave (interpreted code in .m files) may be released under the terms of whatever license you choose.
  • Code written using Octave's native code interface (also known as a .oct file) necessarily links with Octave internals and is considered a derivative work of Octave. Therefore it must be released under terms that are compatible with the GPL.
  1. The MEX file may not use any bindings that are specific to Octave, it has to use the MEX interface only. In other words, it should be possible in principle to use the MEX file with other programs that implement the MEX interface (e.g., Matlab). For example including an Octave header file or calling an Octave function within the MEX file, that is not related with Octave's implementation of the MEX interface make the MEX file a derivative work of Octave and has therefore to be released under terms that are compatible with the GPL.
  2. The MEX file may not be distributed together with Octave in such a way that they effectively create a single work. For example, you should not distribute the MEX file and Octave together in a single package such that Octave automatically loads and runs the MEX file when it starts up. There are other possible ways to effectively create a single work; this is just one example.
  • Code that embeds the Octave interpreter (e.g., by calling the octave_main function), or that calls functions from Octave's libraries (e.g., liboctinterp, liboctave, or libcruft) is considered a derivative work of Octave and therefore must be released under terms that are compatible with the GPL.

Will you change the license of the Octave libraries for me?

No. Instead of asking us to change the licensing terms for Octave, we recommend that you release your program under terms that are compatible with the GPL. This way the free software community can benefit from your work the same as you have benefited from the work of all the people who have contributed to Octave.

Should I favor the MEX interface to avoid the GPL?

No. The original reason for implementing the MEX interface for Octave was to allow Octave to run free software that uses MEX files (the particular goal was to run sundialsTB in Octave). The intent was to liberate that software from Matlab and increase the amount of free software available to Octave users, not to enable people to write proprietary code for Octave. For the good of the community, we strongly encourage users of Octave to release the code they write for Octave under terms that are compatible with the GPL.

Why can't I use code from File Exchange in Octave?

According to the Matlab Central Terms of Use (Last updated: 10-Aug-2016), all submitted code is licensed under the BSD license by default (cf. § 5 Terms of Use), but it is clearly stated that:

Content submitted to File Exchange may only be used with MathWorks products.
—§ 2(a)(iii) Terms of Use

That does not apply to GNU Octave, therefore the usage is in general prohibited. It should suffice — although interpretations of this vary — to contact the author directly to send you the code personally (maybe released under a free license), or download the code from the author's own website, if available. Some examples of letters/email sent to authors for that purpose.

Installation

How can I install Octave on Windows?

See: Octave for Microsoft Windows

How can I install Octave on macOS?

See: Octave for macOS

How can I install Octave on GNU/Linux?

See: Octave for GNU/Linux

How can I install Octave on Android / what is this Octave app in the Google Play store?

There is an unofficial Octave app available for Android in the Google Play store. This Octave app is no longer freely available and has become "nagware". This is a sad turn of events. Please see Android for more information.

How can I install Octave on platform X?

Octave currently runs on GNU/Linux, macOS, and Windows. It should be possible to make Octave work on other systems as well. If you are interested in porting Octave to other systems, please contact the maintainers development mailing list maintainers@octave.org.

What Octave version should I use?

For general use, it is recommended to use the latest stable version of Octave (currently 5.1.0), available from http://www.octave.org/download.html. For development and bleeding-edge features one can obtain the development source code from the Mercurial repository https://hg.savannah.gnu.org/hgweb/octave/graph/.

The used version of Octave is available via the ver command and a list of user-visible changes since the last release is available via the news command at the GNU Octave prompt.

On what platforms does Octave run?

Octave runs on any platform you can compile it on. Binary distributions exist for GNU/Linux, macOS, and Windows. To work fully functional, Octave requires the used platform to support the underlying numerical libraries like BLAS, LAPACK, SuiteSparse, etc., and for plotting OpenGL or gnuplot.

How can I obtain Octave's source code?

The latest version of the Octave source code (and older versions) is available from:

Since Octave is distributed under the terms of the GPL, you can get Octave from a friend who has a copy.

How can I build Octave from the source code?

To use Octave it is usually not required to build it from it's source code. Binary distributions exist for GNU/Linux, macOS, and Windows.

If you have reasons to build Octave from the source code, see Building for more information.

What do I need to build Octave from the source code?

For a list of build dependencies see Building.

Do I need GCC to build Octave from the source code?

No. The development is done primarily with GCC, so you may hit some incompatibilities. Octave is intended to be portable to any standard conforming compiler (for example clang is know to work as well). If you have difficulties that you think are bugs, please report them to the bug tracker, or ask for help on the help@octave.org mailing list.

What's new in Octave?

Each new Octave release introduces many new features. A complete list of user visible changes can be seen by running news at the Octave prompt. The following changes are a distilled list of the major changes:

What's new in the next version of Octave?

See the NEWS file on the development branch.

What's new in version series 4.0.X of Octave

See the complete user-visible changes on the NEWS file.

  • First official release of the GUI.
  • Release of official windows binaries.
  • Experimental support for classdef.
  • OpenGL graphics with Qt widgets.
  • Several functions for reading, writing, and recording of audio.

What's new in version series 3.8.X of Octave

See the complete user-visible changes on the NEWS file.

  • Experimental GUI interface.
  • OpenGL graphics with fltk widgets.
  • Support for nested functions.
  • Support for java packages in Octave core.
  • Reading and writing of image files vastly extended.

What's new in version series 3.6.X of Octave

See the complete user-visible changes on the NEWS file.

  • Perl compatible regular expressions
  • A profiler has been added.
  • Broadcasting enabled for all built-in binary element-wise operators.
  • Performance of all m-file string functions has been improved.

What's new in version series 3.4.X of Octave

See the complete user-visible changes on the NEWS file.

  • Many improvements to native OpenGL plotting
  • ARPACK now distributed with Octave
  • Indexing optimizations
  • FTP objects
  • Function handles aware of overloaded functions
  • bsxfun optimized for basic arithmetic functions
  • Matlab-style ignoring of output arguments using ~
  • Many optimizations of the accumarray function
  • Sparse matrix indexing has been rewritten for speed
  • The pkg command now accepts a -forge option to pull packages directly from Octave-forge

What's new in version series 3.2.X of Octave

See the complete user-visible changes on the NEWS file.

  • Single precision type
  • Experimental OpenGL graphics toolkit to replace gnuplot
  • Object orient programming via @class named directories
  • 64-bit compilation support
  • gzipped files and stream and consequently support of Matlab v7 files
  • a fully compatible MEX interface
  • imwrite and imread (based on the GraphicsMagick library)
  • Lazy transpose: Special treatment in the parser of things like "a' * b", where the transpose is never explicitly formed but a flag is rather passed to the underlying LAPACK code.

Older releases

For full details on older releases, see:

Octave-Forge

How do install or load all Octave-Forge packages?

Do not do it! Really, there is no reason to do this. Octave has many packages for different needs and is unlikely that you need all of them. You either have a small set of required packages, in which case you know them by name; or you want them all "just because", in which case you don't really need them.

The common misconception is that the more packages one has installed and loaded, the more complete and powerful its Octave installation will be. However, in the same way one would never install all perl modules, ruby gems, python packages, and C++ libraries (because it simply makes no sense), one should not install all Octave packages.

Packages should be installed and loaded selectively. Note that some packages are meant to shadow core functions changing the way Octave works, and that different packages can have different functions with the same name leading to unpredictable results.

If you really really really want to do load all packages, you can with the following:

## WARNING: loading all packages is probably not the solution you are looking for.
cellfun (@(x) pkg ("load", x.name), pkg ("list"));


How do I automatically load a package at Octave startup?

When Octave starts, it runs ~/.octaverc. If you want Octave to automatically load a package, simply add a pkg load pkg-name command to it. If the files does not exist, create it.

If you do this, remember that other people may not have Octave configured to load packages at startup. Therefore, if you write code for others, remember that your programs still need to load the packages they require.

Octave usage

How do I execute an Octave script?

First of all, make sure you understand the difference between script files and function files. If you want to execute a function defined in a file, just call the function like any other Octave function: foo(arg1, arg2);

To execute a script from within Octave, just type its name without the .m extension. Thus, if you have a script called foo.m, just type foo from within Octave to execute it. You have to make sure that the script is in your current path. Type path in Octave to see what this path is, and type pwd to print the working directory (where you're currently standing). The current working directory is referred to as "." in the path.

If the script name has characters that are not valid for an Octave identifier, or if you do not want to use addpath to add the script's location to the current path, you can use the run function instead:

  octave> run("Script Name With Spaces.m")
  octave> run("/opt/local/foo.m")

An alternative is to run the script from outside Octave by calling Octave from your operating system shell. Unlike calling the script from inside Octave, this also allows you to pass arguments from the shell into the script, which the script can access using the argv command:

  $ octave the-script.m arg1 arg2

In a Unix environment, if the script has a shebang (e.g. #!/usr/bin/octave) and executable permissions, you can call it like any other Unix program with arguments:

  $ ./the-script arg1 arg2

If you call the script from the shell and it's plotting, please note how to plot when running a script from the shell.

How do I erase a figure?

closeplot(); 
closefig(number)

How do I set the number of displayed decimals?

    octave:1> format long
    octave:2> pi
    pi = 3.14159265358979
    octave:3> format short
    octave:4> pi
    pi = 3.1416

How do I call an octave function from C++?

  • Here is an untested code snippet for calling rand([9000,1]), modified from a post by Herber Farnsworth? to help-octave on 2003-05-01:
#include <octave/oct.h>
...
ColumnVector NumRands(2);
NumRands(0) = 9000;
NumRands(1) = 1;
octave_value_list f_arg, f_ret;
f_arg(0) = octave_value(NumRands);
f_ret = feval("rand",f_arg,1);
Matrix unis(f_ret(0).matrix_value());

How do I change color/line definition in gnuplot postscript?

Here is a awk script to get a rainbow color map

#!/bin/awk -f
 
 BEGIN {
   split("0 4 6 7 5 3 1 2 8", rainbow, " ");
   split("7 3 1 0 2 4 6 5 8", invraim, " ");
 }
 
 $1 ~ /\/LT[0-8]/ {
   n = substr($1, 4, 1);
   if (n == 0)
     lt = "{ PL [] 0.9 0.1 0.1 DL } def";
   else if (n == 1)
     lt = "{ PL [4 dl 2 dl] 0.1 .75 0.1 DL } def";
   else if (n == 2)
     lt = "{ PL [2 dl 3 dl] 0.1 0.1 0.9 DL } def";
   else if (n == 3)
     lt = "{ PL [1 dl 1.5 dl] 0.9 0 0.8 DL } def";
   else if (n == 4)
     lt = "{ PL [5 dl 2 dl 1 dl 2 dl] 0.1 0.8 0.8 DL } def";
   else if (n == 5)
     lt = "{ PL [4 dl 3 dl 1 dl 3 dl] 0.9 0.8 0.2 DL } def";
   else if (n == 6)
     lt = "{ PL [2 dl 2 dl 2 dl 4 dl] 0.5 0.3 0.1 DL } def";
   else if (n == 7)
     lt = "{ PL [2 dl 2 dl 2 dl 2 dl 2 dl 4 dl] 1 0.4 0 DL } def";
   else if (n == 8)
     lt = "{ PL [2 dl 2 dl 2 dl 2 dl 2 dl 2 dl 2 dl 4 dl] 0.5 0.5 0.5 DL } def";
   $0 = sprintf("/LT%d %s", rainbow[n+1], lt);
   ##$0 = sprintf("/LT%x %s", invraim[n+1], lt);
   ##$0 = sprintf("/LT%x %s", n, lt);
 }
 
 { print; }

How do I tell if a file exists?

Look at functions like exist, file_in_path.. and the other functions that their descriptions point to.

How do I create a plot without a window popping up (plot to a file directly)?

This only works with gnuplot as graphics_toolkit, NOT with fltk. See Bug#33180

 figure(1, "visible", "off");
 plot(sin(1:100));
 print -deps "/tmp/sin.eps"

One can set that behaviour as default:

 set(0, 'defaultfigurevisible', 'off');

How do I make Octave use more precision?

Octave's default numerical type is IEEE 754 doubles, a.k.a. hardware floats. This type has 52 bits of precision or about 16 decimal digits. It's implemented in your computer's hardware, in your CPU, so it's fast. This type is assumed throughout for Octave's calculations.

You can use a few other built-in types. The int64 type will have 63 bits of precision. One bit is used for the sign, but if you don't want to lose that bit, uint64 can be used instead. These types, however, cannot represent numbers as large as the default double type, and can only represent integers. Furthermore, there is no way to represent integer literals, so if you do

uint64(18446744073709551610);

the literal "18446744073709551610" first gets converted to a double precision type, so uint64's additional precision is lost. Instead, initialize the uint64 with smaller numbers and perform a computation to get the larger number you want. E.g.,

uint64(999999999999999) * 10000

would produce value 9999999999999990000, which is close to the maximum possible value for the uint64 type, but can't be at the moment input directly, doing uint64(9999999999999990000), due to the mentioned error of rounding.

Alternatively, one may use arbitrary precision arithmetic, which has as much precision as is practical to hold in your computer's memory. The symbolic package has a vpa() function for arbitrary precision arithmetic. Note that arbitrary precision arithmetic must be implemented in software which makes it much slower than hardware floats.

Consider carefully if your problem really needs more precision. Often if you're running out of precision the problem lies fundamentally in your methods being numerically unstable, so more precision will not help you here. If you absolutely must use arbitrary-precision arithmetic, you're at present better off using a CAS instead of Octave. An example of such a CAS is Sage.

How do I run a Matlab P-file in Octave?

You can't. Matlab P-files (files with a .p file extension), also known as P-code, are obfuscated files than cannot be run outside of Matlab itself. The original source Matlab m-files that were used to generate the P-files should be used in Octave instead.

There are no plans to support running P-files produced by Matlab in Octave.

How does Octave solve linear systems?

In addition to consulting Octave's source for the precise details, you can read the Octave manual for a complete high-level description of the algorithm that Octave uses to decide how to solve a particular linear system, e.g. how the backslash operator A\x will be interpreted. Sections Techniques Used for Linear Algebra and Linear Algebra on Sparse Matrices from the manual describe this procedure.

How do I do X?

You are probably looking for the function lookfor. This function searches the help text of all functions for a specific string and returns a list of functions. Note that by default it will only search the first line of the help text (check help lookfor at the octave prompt for more). The following example helps to find the function to calculate correlation coefficient in a matrix:

 octave> lookfor correlation
 corr2               Returns the correlation coefficient between I and J.
 cor                 Compute correlation.
 corrcoef            Compute correlation.
 spearman            Compute Spearman's rank correlation coefficient RHO for each of the variables sp
 autocor             Return the autocorrelations from lag 0 to H of vector X.

Also, there's a high chance that the function name has a suggestive name, and so you can try auto-completion to get some hints. For the previous example, typing corr at the octave promp followed by pressing [Tab] twice would suggest the following:

 octave> corr
 corr2     corrcoef

Common problems

I am running a script that should produce output during execution but I don't see anything until it has finished

By default Octave is set to pass its screen output through a pager (usually the default pager is "less") which allows things such as navigating through the output with arrow keys or searching for text or regular expressions within the output. The pager only displays the output after it's finished receiving it, so when it is active you'll not be able to see anything until your script has terminated. To change this behavior temporarily or permanently you may want to use one of the options described here.

When I try plotting from a script, why am I not seeing anything?

If you are running an Octave script that includes a plotting command, the script and Octave may terminate immediately. So the plot window does show up, but immediately closes when Octave finishes execution. Alternatively, if using fltk, the plot window needs a readline loop to show up (the time when Octave is sitting around doing nothing waiting for interactive input).

A common solution is to put a pause command at the end of your script.

How do I get sound input or output in Windows?

Sound input from a sound card and output to a sound card is fully supported in Octave 4.0.0 and newer in all operating systems. Older versions of Octave had very limited audio support that was essentially Linux-specific. If you have problems with the audio I/O functions using Octave 4.0 or a newer version, please report them on the bug tracker.

I cannot install a package. Octave complains about a missing mkoctfile.

You should normally use your distribution's packages. For Debian and Fedora, Octave package foo will be a deb or rpm called octave-foo, and you should install that instead using apt or yum.

If you really need to build Octave packages from source to install them, you'll need mkoctfile. Most distributions split Octave into several packages. The script mkoctfile is then part of a separate package:

  • Debian/Ubuntu: octave-headers or liboctave-dev
  • Fedora: octave-devel

I'm having problem X using the latest Octave version

Please be more specific. What is the latest version, according to you? If you mean the latest released version, be aware that you may still have an older version due to whatever distribution method you're using. There may be a newer version available that you're not aware of due to the distribution method you're using to get Octave, and in most cases, there is a way to get a newer version via your distribution method (see other wiki pages for GNU/Linux, Mac OSX, and Windows).

If you mean the latest Mercurial revision, please specify which one that is. "Latest tip" is not informative, because from the time you wrote "latest tip" to the time someone reads that message, "latest tip" might have changed meaning. Also, you might be standing on a different commit than what "hg tip" says. The tip may be on a different branch, or you might have updated to a different revision different from what "hg tip" says.

Instead, report the output of "hg summary" or "hg id". Also please use hashes instead or in addition to revision numbers. Revision numbers are just a convenience and only make sense in your local repo, and might not coincide with what someone sees on their own repo. Hashes are globally unique across all repos.

If your problem truly persists with the latest version, as indicated here, then by all means report a bug or ask for help, but don't be surprised if volunteers are less inclined to help you with a problem that only exists in an older version of Octave.

Why is Octave's floating-point computation wrong?

Floating point arithmetic is an approximation in binary to arithmetic on real or complex numbers. Just like you cannot represent 1/3 exactly in decimal arithmetic (0.333333 is only a rough approximation to 1/3), you cannot represent some fractions like exactly in base 2. In binary, the representation to one tenth is where the bar indicates that it repeats infinitely (like how in decimal). Because this infinite repetition cannot be represented exactly with a finite number of digits, rounding errors occur for values that appear to be exact in decimal but are in fact approximations in binary, such as for example how 0.3 - 0.2 - 0.1 is not equal to zero.

In addition, some advanced operations are computed by approximation and are not guaranteed to be accurate, see Table-maker's dilemma. Their results are system-dependent.

This isn't an Octave bug. It happens with any program that uses IEEE 754 floating point arithmetic. To be fair, IEEE 754 also specifies decimal floating point arithmetic, which has never seen wide adoption. The reason why Octave and other programs use IEEE 754 binary floats is that they are fast, because they are implemented in hardware or system libraries. Unless you are using very exotic hardware, Octave will use your computer's processor for basic floating point arithmetic.

Like death and taxes, rounding errors are a fact of life. You cannot avoid them. You can only move a rounding error from one part of a computation to another, or you can use more precision and delay the rounding error. One way to delay the rounding error is to use arbitrary precision arithmetic, which is inevitably slower as it has to be implemented in software instead of hardware. You may use the vpa function from the symbolic package for this purpose.

Another approach to the problem is interval arithmetic with the Interval package. Then, the exact result would always be enclosed by two binary floats. Again, this is slower since only the most basic interval arithmetic operations can be performed in hardware.

To learn more about floating point arithmetic, consult its Wikipedia article or the classical reference What Every Computer Scientist Should Know About Floating Point Arithmetic.

I have installed a package but still get a "foo undefined" error?

You have probably forgotten to load the package. Use pkg load package-name to load it. Most packages are no longer loaded automatically to avoid surprises. See reasoning on related FAQ how do I install all Octave packages. If you want a specific package to be loaded by default at startup, consider adding the pkg load command on your .octaverc file.

Missing lines when printing under Windows with OpenGL toolkit and Intel integrated GPU

Some windows users with integrated Intel GPUs have reported missing lines when printing with an OpenGL toolkit like FLTK or Qt. #42534

Users with this kind of problem should try to install/update their Intel OpenGL drivers for Windows or consider installing Mesa drivers from http://qt-project.org/wiki/Cross-compiling-Mesa-for-Windows

See also https://www.opengl.org/wiki/FAQ#Why_is_my_GL_version_only_1.4_or_lower.3F

Plot hangs and makes the GUI unresponsive

If the Qt graphics toolkit is used and "plot" is used for the first time, the fontconfig scanner searches the font directory to build a font cache. This can take up to 3min on slow CPUs. See #45458

Differences between Octave and Matlab

People often ask

I wrote some code for Matlab, and I want to get it running under Octave. Is there anything I should watch out for?

or alternatively

I wrote some code in Octave, and want to share it with Matlab users. Is there anything I should watch out for?

which is not quite the same thing. There are still a number of differences between Octave and Matlab, however in general differences between the two are considered as bugs. Octave might consider that the bug is in Matlab and do nothing about it, but generally functionality is almost identical. If you find an important functional difference between Octave behavior and Matlab, then you should send a description of this difference (with code illustrating the difference, if possible) to http://bugs.octave.org.

Furthermore, Octave adds a few syntactical extensions to Matlab that might cause some issues when exchanging files between Matlab and Octave users.

As both Octave and Matlab are under constant development, the information in this section is subject to change.

You should also look at the pages http://octave.sourceforge.net/packages.php and http://octave.sourceforge.net/docs.html that have a function reference that is up to date. You can use this function reference to see the number of octave functions that are available and their Matlab compatibility.

Nested Functions

Octave has limited support for nested functions. That is

         function y = foo (x)
           y = bar(x)
           function y = bar (x)
             y = ...;
           end
         end

is equivalent to

         function y = foo (x)
            y = bar(x)
         end
         function y = bar (x)
            y = ...;
         end

The main difference with Matlab is a matter of scope. While nested functions have access to the parent function's scope in Matlab, no such thing is available in Octave, due to how Octave essentially “un-nests” nested functions.

The authors of Octave consider the nested function scoping rules of Matlab to be more problems than they are worth as they introduce difficult to find bugs as inadvertently modifying a variable in a nested function that is also used in the parent is particularly easy for those not attentive to detail.

Differences in core syntax

There are a few core Matlab syntaxes that are not accepted by Octave, these being

  • Some limitations on the use of function handles. The major difference is related to nested function scoping rules (as above) and their use with function handles.
  • Some limitations of variable argument lists on the LHS of an expression, though the most common types are accepted.
  • Matlab classdef object oriented programming is not yet supported, though work is underway in a branch of the development tree.

Differences in core functions

A large number of the Matlab core functions (ie those that are in the core and not a toolbox) are implemented, and certainly all of the commonly used ones. There are a few functions that aren't implemented, usually to do with specific missing Octave functionality (GUI, DLL, Java, ActiveX, DDE, web, and serial functions). Some of the core functions have limitations that aren't in the Matlab version. For example the sprandn function can not force a particular condition number for the matrix like Matlab can. Another example is that testing and the runtests function work differently in Matlab and Octave.

Just-In-Time compiler

Matlab includes a "Just-In-Time" compiler. This compiler allows the acceleration of for-loops in Matlab to almost native performance with certain restrictions. The JIT must know the return type of all functions called in the loops and so you can't include user functions in the loop of JIT optimized loops. Octave doesn't have a JIT and so to some might seem slower than Matlab. For this reason you must vectorize your code as much as possible. The MathWorks themselves have a good document discussing vectorization at http://www.mathworks.com/support/tech-notes/1100/1109.html.

Compiler

On a related point, there is no Octave compiler, and so you can't convert your Octave code into a binary for additional speed or distribution. There have been several aborted attempts at creating an Octave compiler. Should the JIT compiler above ever be implemented, an Octave compiler should be more feasible.

Graphic handles

Up to Octave 2.9.9 there was no support for graphic handles in Octave itself. In the 3.2.N versions of Octave and beyond, the support for graphics handles is converging towards full compatibility. The patch function is currently limited to 2-D patches, due to an underlying limitation in gnuplot, but the experimental OpenGL backend is starting to see an implementation of 3-D patches.

GUI functions

There are no Matlab compatible GUI functions yet. This might be an issue if you intend to exchange Octave code with Matlab users. There are a number of bindings from Octave to Tcl/Tk, VTK and zenity for example, that can be used for a GUI, but these are not Matlab compatible. Work on a Matlab compatible GUI is in an alpha stage in the QtHandles project, which may form part of a future release of Octave.

Simulink

Octave itself includes no Simulink support. Typically the simulink models lag research and are less flexible, so shouldn't really be used in a research environment. However, some Matlab users that try to use Octave complain about this lack.

MEX-Files

Octave includes an API to the Matlab MEX interface. However, as MEX is an API to the internals of Matlab and the internals of Octave differ from Matlab, there is necessarily a manipulation of the data to convert from a MEX interface to the Octave equivalent. This is notable for all complex matrices, where Matlab stores complex arrays as real and imaginary parts, whereas Octave respects the C99/C++ standards of co-locating the real/imag parts in memory. Also due to the way Matlab allows access to the arrays passed through a pointer, the MEX interface might require copies of arrays (even non complex ones).

Block comments

Block comments denoted by #{ and #} markers (or %{ and %}) are supported by Octave with some limitations. The major limitation is that block comments are not supported within [] or {}.

Mat-File format

There are some differences in the mat v5 file format accepted by Octave. Matlab recently introduced the "-V7.3" save option which is an HDF5 format which is particularly useful for 64-bit platforms where the standard Matlab format can not correctly save variables. Octave accepts HDF5 files, but is not yet compatible with the "-v7.3" versions produced by Matlab.

Although Octave can load inline function handles saved by Matlab, it can not yet save them.

Finally, some multi-byte Unicode characters aren't yet treated in mat-files.

Profiler

Thanks to Daniel Kraft's 2011 Google Summer of Code project, Octave has a profiler since version 3.6.0. However, at the moment it only produces text output and has its own makeshift interface for hierarchical profiling.

Toolboxes

Octave is a community project and so the toolboxes that exist are donated by those interested in them through Octave Forge. These might be lacking in certain functionality relative to the Matlab toolboxes, and might not exactly duplicate the Matlab functionality or interface.

Short-circuit & and | operators

The & and | operators in Matlab short-circuit when included in a condition (e.g. an if or while statement) and not otherwise. In Octave only the && and || short circuit. Note that this means that

           if (a | b)
             ...
           end

and

           t = a | b;
           if t
             ...
           end

have different semantics in Matlab. This is really a Matlab bug, but there is too much code out there that relies on this behavior to change it. Prefer the || and && operators in if statements if possible. If you need to use code written for Matlab that depends on this buggy behavior, you can enable it since Octave 3.4.0 with the following command:

           do_braindead_shortcircuit_evaluation(1)

Note that the difference with Matlab is also significant when either argument is a function with side effects or if the first argument is a scalar and the second argument is an empty matrix. For example, note the difference between

           t = 1 | [];          ## results in [], so...
           if (t) 1, end        ## in if ([]), this is false.

and

           if (1 | []) 1, end   ## short circuits so condition is true.

Another case that is documented in the Matlab manuals is that

           t = [1, 1] | [1, 2, 3];          ## error
           if ([1, 1] | [1, 2, 3]) 1, end   ## OK

Also Matlab requires the operands of && and || to be scalar values but Octave does not (it just applies the rule that for an operand to be considered true, every element of the object must be nonzero or logically true).

Finally, note the inconsistence of thinking of the condition of an if statement as being equivalent to all(X(:)) when X is a matrix. This is true for all cases EXCEPT empty matrices:

           if ([0, 1]) == if (all ([0, 1]))   ==>  i.e., condition is false.
           if ([1, 1]) == if (all ([1, 1]))   ==>  i.e., condition is true.

However,

           if ([])

is not the same as

           if (all ([]))

because, despite the name, the all is really returning true if none of the elements of the matrix are zero, and since there are no elements, well, none of them are zero. This is an example of vacuous truth. But, somewhere along the line, someone decided that if ([]) should be false. Mathworks probably thought it just looks wrong to have [] be true in this context even if you can use logical gymnastics to convince yourself that "all" the elements of an empty matrix are nonzero. Octave however duplicates this behavior for if statements containing empty matrices.

Solvers for singular, under- and over-determined matrices

Matlab's solvers as used by the operators mldivide (\) and mrdivide (/), use a different approach than Octave's in the case of singular, under-, or over-determined matrices. In the case of a singular matrix, Matlab returns the result given by the LU decomposition, even though the underlying solver has flagged the result as erroneous. Octave has made the choice of falling back to a minimum norm solution of matrices that have been flagged as singular which arguably is a better result for these cases.

In the case of under- or over-determined matrices, Octave continues to use a minimum norm solution, whereas Matlab uses an approach that is equivalent to

         function x = mldivide (A, b)
           m = rows(A);
           [Q, R, E] = qr(A);
           x = [A \ b, E(:, 1:m) * (R(:, 1:m) \ (Q' * b))]
         end

While this approach is certainly faster and uses less memory than Octave's minimum norm approach, this approach seems to be inferior in other ways.

A numerical question arises: how big can the null space component become, relative to the minimum-norm solution? Can it be nicely bounded, or can it be arbitrarily big? Consider this example:

         m = 10;
         n = 10000;
         A = ones(m, n) + 1e-6 * randn(m,n);
         b = ones(m, 1) + 1e-6 * randn(m,1);
         norm(A \ b)

while Octave's minimum-norm values are around 3e-2, Matlab's results are 50-times larger. For another issue, try this code:

         m = 5;
         n = 100;
         j = floor(m * rand(1, n)) + 1;
         b = ones(m, 1);
         A = zeros(m, n);
         A(sub2ind(size(A),j,1:n)) = 1;
         x = A \ b;
         [dummy,p] = sort(rand(1,n));
         y = A(:,p)\b;
         norm(x(p)-y)

It shows that unlike in Octave, mldivide in Matlab is not invariant with respect to column permutations. If there are multiple columns of the same norm, permuting columns of the matrix gets you different result than permuting the solution vector. This will surprise many users.

Since the mldivide (\) and mrdivide (/) operators are often part of a more complex expression, where there is no room to react to warnings or flags, it should prefer intelligence (robustness) to speed, and so the Octave developers are firmly of the opinion that Octave's approach for singular, under- and over-determined matrices is a better choice than Matlab's.

Octave extensions

The extensions in Octave over MATLAB syntax are very useful, but might cause issues when sharing with Matlab users. A list of the major extensions that should be avoided to be compatible with Matlab are:

Comments in Octave can be marked with #. This allows POSIX systems to have the first line as #! octave -q and mark the script itself executable. MATLAB doesn't have this feature due to the absence of comments starting with #".

Code blocks like if, for, while, etc can be terminated with block specific terminations like endif. MATLAB doesn't have this and all blocks must be terminated with end.

Octave has a lisp-like unwind_protect block that allows blocks of code that terminate in an error to ensure that the variables that are touched are restored. You can do something similar with try/catch combined with rethrow (lasterror ()) in Matlab, however rethrow and lasterror are only available in Octave 2.9.10 and later. MATLAB 2008a also introduced OnCleanUp that is similar to unwind_protect, except that the object created by this function has to be explicitly cleared in order for the cleanup code to run.

Note that using try/catch combined with rethrow (lasterror ()) can not guarantee that global variables will be correctly reset, as it won't catch user interrupts with Ctrl-C. For example

         global a
         a = 1;
         try
           _a = a;
           a = 2
           while true
           end
         catch
           fprintf ('caught interrupt\n');
           a = _a;
           rethrow (lasterror());
         end

compared to

         global a
         a = 1;
         unwind_protect
           _a = a;
           a = 2
           while true
           end
         unwind_protect_cleanup
           fprintf ('caught interrupt\n');
           a = _a;
         end

Typing Ctrl-C in the first case returns the user directly to the prompt, and the variable a is not reset to the saved value. In the second case the variable a is reset correctly. Therefore Matlab gives no safe way of temporarily changing global variables.

Indexing can be applied to all objects in Octave and not just variables. Therefore sin(x)(1:10) for example is perfectly valid in Octave but not Matlab. To do the same in Matlab you must do y = sin(x); y = y([1:10]);

Octave has the operators ++, –-, -=, +=, *=, etc. As MATLAB doesn't, if you are sharing code these should be avoided.

Character strings in Octave can be denoted with double or single quotes. There is a subtle difference between the two in that escaped characters like \n (newline), \t (tab), etc are interpreted in double quoted strings but not single quoted strings. This difference is important on Windows platforms where the \ character is used in path names, and so single quoted strings should be used in paths. MATLAB doesn't have double quoted strings and so they should be avoided if the code will be transferred to a MATLAB user.

What features are unique to Octave?

Although most of the Octave language will be familiar to Matlab users, it has some unique features of its own.

Functions defined on the command-line

Functions can be defined by entering code on the command line, a feature not supported by Matlab. For example, you may type:

    octave:1> function s = hello_string (to_who)
    > ## Say hello
    > if nargin<1, to_who = "World"; end
    > s = ["Hello ",\
    >      to_who];
    > endfunction
    octave:2> hello_string ("Moon")
    ans = Hello Moon

As a natural extension of this, functions can also be defined in script files (m-files whose first non-comment line isn't function out = foo (...))

Note: MATLAB R2016b added the ability to define functions in script files.

Comments with #

The pound character, #, may be used to start comments, in addition to %. See the previous example. The major advantage of this is that as # is also a comment character for unix script files, any file that starts with a string like #! /usr/bin/octave -q will be treated as an octave script and be executed by octave.

Strings delimited by double quotes "

The double quote, ", may be used to delimit strings, in addition to the single quote '. See the previous example. Also, double-quoted strings include backslash interpretation (like C++, C, and Perl) while single quoted are uninterpreted (like Matlab and Perl).

Line continuation by backslash

Lines can be continued with a backslash, \, in addition to three points .... See the previous example.

Informative block closing

You may close function, for, while, if, ... blocks with endfunction, endfor, endwhile, ... keywords in addition to using end. As with Matlab, the end (or endfunction) keyword that marks the end of a function defined in a .m file is optional.

Coherent syntax

Indexing other things than variables is possible, as in:

    octave:1> [3 1 4 1 5 9](3)
    ans = 4
    octave:2> cos([0 pi pi/4 7])(3)
    ans = 0.70711

In Matlab, it is for example necessary to assign the intermediate result cos([0 pi pi/4 7]) to a variable before it can be indexed again.

Exclamation mark as not operator

The exclamation mark ! (aka “Bang!”) is a negation operator, just like the tilde ~:

    octave:1> if ! strcmp (program_name, "octave"),
    >   "It's an error"
    > else
    >   "It works!"
    > end
    ans = It works!

Note however that Matlab uses the ! operator for shell escapes, for which Octave requires using the system command.

Increment and decrement operators

If you like the ++, += etc operators, rejoice! Octave includes the C-like increment and decrement operators ++ and -- in both their prefix and postfix forms, in addition to +=, -=, *=, /=, ^=,.+=,.-=,.*=, ./= and .^=.

For example, to pre-increment the variable x, you would write ++x. This would add one to x and then return the new value of x as the result of the expression. It is exactly the same as the expression x = x + 1.

To post-increment a variable x, you would write x++. This adds one to the variable x, but returns the value that x had prior to incrementing it. For example, if x is equal to 2, the result of the expression x++ is 2, and the new value of x is 3.

For matrix and vector arguments, the increment and decrement operators work on each element of the operand.

Unwind-protect

In addition to try-catch blocks, Octave supports an alternative form of exception handling modeled after the unwind-protect form of Lisp. The general form of an unwind_protect block looks like this:

    unwind_protect
      body
    unwind_protect_cleanup
      cleanup
    end_unwind_protect

Where body and cleanup are both optional and may contain any Octave expressions or commands. The statements in cleanup are guaranteed to be executed regardless of how control exits body.

The unwind_protect statement is often used to reliably restore the values of global variables that need to be temporarily changed.

Matlab can be made to do something similar with their onCleanup function that was introduced in 2008a. Octave also has onCleanup since version 3.4.0.

Built-in ODE and DAE solvers

Octave includes LSODE, DASSL and DASPK for solving systems of stiff ordinary differential and differential-algebraic equations. These functions are built in to the interpreter.

Do-Until loop structure

Similar to the do-while loop in C and C++, Octave allows a do-until loop which does not exist in Matlab

 x = 0
 do
   x += 1;
 until (x == 10)

Broadcasting

Borrowed from other languages, octave broadcasting allows easy and readable vectorization.

 f = (1:0.1:2);
 # put angular frequencies on the first dimension to prepare broadcasting
 omega = 2 * pi * f(:);
 # time is already on the second dimension (row vector)
 t = 0:0.02:2;
 # the resulting s will be a 2-dimensional array
 s = sin(omega .* t);
 # which can be displayed as
 pcolor(t, f, s)
 xlabel("t (s)")
 ylabel("f (Hz)")

Note: Automatic expansion of dimensions was added to MATLAB R2016b.

Documentation strings

Octave allows extensive formatting of the help string of functions using Texinfo. The effect on the online documentation is relatively small, but makes the help string of functions conform to the help of Octave’s own functions. However, the effect on the appearance of printed or online documentation will be greatly improved.

Test functions

Octave allows to add self-tests to user defined functions. Tests are put after function definition in specially commented block.

 function mult = a(val)
         mult = val.*2;
 endfunction
 %!test
 %! assert (a(3), 6);

Such a function can be tested for valid outputs by following code:

 octave:1> test a
 PASSES 1 out of 1 test

Demonstration Functions

Example code block can be part of function file in a similar manner as test functions. For example to run demo for function multinom of package specfun, use:

  demo multinom

Powerfull assert

Function assert have extended input possibilities.

GUI

Does Octave have a GUI?

Yes! It was officially released with Octave 4.0.0. It was also available since version 3.8.0 as an experimental feature (use the --force-gui option to start Octave).

Why did you create yet another GUI instead of making one that already exists better?

The previously existing GUIs were not part of Octave itself. The integration within Octave was rather bad, as all of them treated Octave as a foreign black box and used pipes for communication. This approach is bound to fail with each new version of Octave, as any fix would only be temporary. For historical reasons and to honor the approaches, a short list of previous GUIs for Octave:

  • QtOctave was a great, beautiful, and very useful tool which is now abandoned and incompatible with newer versions of Octave. We are thankful to its developers to make it free software so we could reuse large chunks of it for what is now the Octave GUI.
  • Quint was a project for an Octave GUI that actually tried to do it right. Eventually it was merged into the Octave repository and is no longer a separate project. Also, many bits from QtOctave were reused in the GUI.
  • Xoctave, which is proprietary and commercial.
  • GUI Octave, which was proprietary and is no longer available.

Graphics: backends and toolkits

What are the supported graphics backends?

  • OpenGL via the graphics toolkits qt (current default) and fltk
  • gnuplot via the gnuplot graphics toolkit

How do I change my graphics toolkit?

There are three commands to deal with graphics toolkits:

available_graphics_toolkits lists all available graphics toolkits
graphics_toolkit displays the currently used graphics toolkit
graphics_toolkit ("qt/fltk/gnuplot") sets the graphics toolkit to either of qt, fltk, or gnuplot, if available

Why did you replace gnuplot with an OpenGL backend?

The development of Octave is committed to being both compatible with Matlab and adding additional features. Toward those ends, the developers decided to introduce a native OpenGL backend that supports Matlab handle graphics and its uicontrols. Starting with the 3.8 release, Octave uses OpenGL graphics by default (with FLTK widgets in Octave 3.8 and Qt widgets in Octave 4.0 and later).

Are there any plans to remove the gnuplot backend?

No. There are no plans to remove the gnuplot backend. It will be available as long as our users find it useful.

How can I implement a new graphics backend/toolkit?

This is one of those times where the best documentation is to read the existing code. We have three different toolkits in Octave now, so there are some examples to draw from.

Development

When will feature X be released or implemented?

When it's ready, sooner if you help. You can send us patches if you can implement feature X yourself. If you can't, some developers may be convinced to work on your specific problem for some money.

How can I get involved in Octave development?

Be around. Be social. Participate in our mailing lists help@octave.org and maintainers@octave.org. Find things about Octave you don't like, and start thinking about how to fix them. Many people who now contribute to Octave first spent several years helping in the mailing list before they started to delve into the code. A good way to learn Octave is to understand the problems other people are having with it, so being helpful in the mailing lists not only helps Octave as a whole, but it also prepares you to be a better Octave contributor.

If you feel ready to dive right into the code, read the Developers wiki page or start here. But do not send an email to the mailing lists listing your skills and offering to help. We won't just suggest things for you to do. We lack volunteers and we do need your help, but because of that, we also lack the time to provide good guidance and mentoring. If there is a specific short-term project you would like to work on, say so, and just do it. Then ask for help or advice when you're doing it. It is a lot more important that you do something that you're actually interested on than something we suggested because it only matches your skills.

We also need help with this wiki and the manual. These are also important tasks. The documentation is easy to patch, and the help text for individual functions even more so. Editing this wiki is even easier.

Accurate bug reporting is also very useful. Find and report bugs, making an attempt to diagnose them. Eventually, you will also know how to fix them. If you want to help with bug reports or patches, subscribe to the bug tracker mailing list. You'll get updates on all bug activity, and you can jump in when you see something you can help with.

Look at our projects, short projects, and Summer of Code Project Ideas if you need specific inspiration for coding tasks that we would like to get done.