FAQ

This is a list of frequently asked questions (FAQ) for 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 Octave, or need help for something that is not covered by the Octave manual or the FAQ, please use the help@octave.org mailing list.

This FAQ is intended to supplement, not replace, the Octave manual. Before posting a question to the help@octave.org mailing list, you should first check to see if the topic is covered in the manual.

General

What is Octave?

Octave is a high-level interactive language, primarily intended for numerical computations that is mostly compatible with Matlab.1

Octave can do arithmetic for real, complex or integer-valued scalars and matrices, solve sets of nonlinear algebraic equations, integrate functions over finite and infinite intervals, and integrate systems of ordinary differential and differential-algebraic equations.

Octave uses the GNU readline library to handle reading and editing input. By default, the line editing commands are similar to the cursor movement commands used by GNU Emacs, and a vi-style line editing interface is also available. At the end of each session, the command history is saved, so that commands entered during previous sessions are not lost.

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

Who uses Octave?

Lots of people. It seems that universities use it for research and teaching, companies of all sizes, for development, individuals. This question comes often on Octave mailing lists, 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 was the original author of Octave, starting full-time development in February 1992. He is still the primary maintainer. The community of users/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), and octave-dev@lists.sourceforge.net (all things related to the Octave Forge repository of user-contributed functions).

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 guh-noo, approximately like canoe.

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.

For more information about the GNU project, see http://www.gnu.org.

What version should I use?

In general, you will find the latest version on http://www.octave.org/download.html. It is recommended to use the stable version of octave for general use, and the development version if you want the latest features and are willing to tolerate instability.

A list of user-visible changes since the last release is available in the file NEWS. The file ChangeLog in the source distribution contains a more detailed record of changes made since the last release.

On what platforms does Octave run?

Octave runs on various Unices—at least Linux and Solaris, Mac OS X, Windows and anything you can compile it on. Binary distributions exist at least for Debian, SUSE, Fedora and RedHat Linuxes (Intel and AMD CPUs, at least), for Mac OS X and Windows' 98, 2000, XP, Vista, and 7.

Two and three dimensional plotting is fully supported using gnuplot and an experimental OpenGL backend.

The underlying numerical solvers are currently standard Fortran ones like LAPACK, LINPACK, ODEPACK, the BLAS, etc., packaged in a library of C++ classes. If possible, the Fortran subroutines are compiled with the system's Fortran compiler, and called directly from the C++ functions. If that's not possible, you can still compile Octave if you have the free Fortran to C translator f2c.

Octave is also free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation, or at your option any later version.

Why are the developers planning to 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 development community has chosen to introduce a native OpenGL backend that supports Matlab handle graphics and its uicontrols. The introduction of the experimental fltk graphics toolkit is the first product of this effort. As of the 3.6.N series, the fltk toolkit is approximately as advanced as is the Gnuplot toolkit. It is not yet decided if the fltk toolkit is to become the default backend, or if another OpenGL implementation will replace Gnuplot as the default backend (An QtOpenGL toolkit is also under development).

How can I cite Octave?

Pointing to http://www.octave.org is good, because that gives people a direct way to find out more. If citation of a URL is not allowed by a publisher, or if you also want to point to a traditional reference, then you can cite the Octave manual:

    @BOOK{eaton:2008,
      author =     "John W. Eaton, David Bateman, and Søren Hauberg",
      title =      "GNU Octave Manual Version 3",
      publisher =  "Network Theory Limited",
      year =       "2008",
      isbn =       "0-9546120-6-X"
    }

How can I get involved in Octave development?

Be around. Be social. Participate in the help and maintainers' mailing lists. 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, here are some instructions on how to do so. make sure you read etc/HACKING for guidance.

We also need help with this wiki and the manual. These are also important tasks. The documentation is easier to patch, so you can discuss improvements to it and submit patches. Or just edit this wiki! 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.

Also look at our Projects, the ESA Summer of Code in Space, and GSoC Project ideas if you need specific inspiration for coding tasks that we would like to get done.

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 plug-in interface (also known as a .oct file) necessarily links with Octave internals and is considered a derivative work of Octave and therefore must be released under terms that are compatible with the GPL.

Code written using Octave's implementation of the Matlab MEX interface may be released under the terms of whatever license you choose, provided that the following conditions are met:

1. The plugin should not use any bindings that are specific to Octave. In other words, the MEX file must use the MEX interface only, and not also call on other Octave internals. It should be possible in principle to use the MEX file with other programs that implement the MEX interface (e.g., Matlab).
2. The MEX file should 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 that you might effectively create a single work; this is just one example.

A program 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.

Since the MEX interface allows plugins to be distributed under terms that are incompatible with the GPL, does this mean that you are encouraging people to to write non-free software for Octave?

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.

I wrote a program that links with Octave libraries and I don't want to release it under the terms of 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 so that 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.

Why can't I use code from File Exchange in Octave? It's released under a BSD license!

When one downloads code from File Exchange and use it on non Mathworks software (such as Octave), they are violating the Matlab central Terms of Use. While the BSD licenses does allow one to use such code in Octave, it also allows others to further impose restrictions which Mathworks does through the terms of Use of their site.:

Content submitted to File Exchange may only be used with MathWorks products.

—Matlab central, Terms of Use 2iii

While interpretations of this vary, it should be safe to use the code if you contact the author directly and have them send you the code personally.

What's new in Octave

What's new in version series 3.6.N and 3.7.N of Octave

Several new features have been added to the 3.6.N series. The full details are in the NEWS file, but in brief 3.6.N series brings:

• Perl compatible regular expressions
• A profiler has been added.
• Broadcasting enabled for all built-in binary element-wise operators.
• The statistical distribution functions have been overhauled.
• The functions strread(), textscan(), and textread() have been rewritten.
• Performance of all m-file string functions has been improved.
• The qhull geometry functions have been revamped.
• Date/time functions have been updated.
• Matlab compatible preference functions have been added.
• Various handle graphics functions have be introduced.
• The parfor keyword is now recognized.

Features added in version series 3.4.N and 3.5.N of Octave

Here are some features that have been around since 3.4.N

• Many improvements to native OpenGL plotting
• ARPACK now distributed with Octave
• Indexing optimisations
• FTP object using libcurl
• Better consistency with ismatrix, issquare, and issymetric
• Function handles aware of overloaded functions
• More efficient matrix division by making a single LAPACK call
• Other optimisations in matrix operations
• bsxfun optimised for basic arithmetic functions
• Matlab-style ignoring of output arguments using ~
• Many optimisations of the accumarray function
• Sparse matrix indexing has been rewritten for speed
• Configuration pseudo-variables like page_screen_output accept a "local" option argument to limit their scope to function scope
• The pkg command now accepts a -forge option to pull packages directly from Octave-forge
• Several dlmread improvements
• Octave now uses gnulib for better cross-platform compatibility

Features added in version series 3.2.N and 3.3.N of Octave

Here are some features that have been around since 3.2.N

• integer types
• fixed point arithmetic
• sparse matrices
• linear programming code based on GLPK
• 64-bit compilation support
• gzipped files and stream and consequently support of Matlab v7 files
• better support for both msvc and mingw
• a fully compatible MEX interface
• many many other minor features and compatibility changes
• an experimental OpenGL graphics toolkit to replace gnuplot
• object orient programming
• block comments
• 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.
• Single precision type
• Improved array indexing
  The underlying code used for indexing of arrays has been completely rewritten and so the indexing of arrays is now significantly faster.

Features available since 2.1.N

Here are some older features that have been around since 2.1.N:

• NDArrays
• cells

Coming in a future release

The 3.7.N series is the current development release and will become a 3.8.N release in the future. This series brings the following new features:

• JIT compiling in the interpreter (speeds up loops)
• A GUI for Octave (based on Qt4)
• The default graphics toolkit it planned to be changed from Gnuplot to an OpenGL fltk toolkit.

What documentation exists for Octave?

Besides the current wiki, there are other important sources of documentation and help for Octave.

What documentation exists for Octave?

The Octave distribution includes a 650+ page manual that is also distributed under the terms of the GNU GPL. It is available on the web at http://www.gnu.org/software/octave/doc/interpreter/ and you will also find there instructions on how to order a paper version.

The complete text of the Octave manual is also available using the GNU Info system via the GNU Emacs, info, or xinfo programs, or by using the doc command to start the GNU info browser directly from the Octave prompt.

If you have problems using this documentation, 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 an IRC chat room.

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 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
• ftp://ftp.octave.org/pub/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 binary packages

The Octave project does not distribute binary packages, but other projects do. For an up-to-date listing of packagers, see:

• http://www.octave.org/download.html
• Build From Source

As of today, Octave binaries are available at least on Debian, Ubuntu, RedHat, Suse and Fedora GNU/Linuxen, Mac OS X, Windows' 98, 2000 and XP, Vista, and 7.

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 the maintainers' mailing list.

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).

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 mailing list.

How do I install all octave packages?

Do not do it! Really, there is no reason to do this. Octave Forge has many packages for different needs but it's unlikely that you need all of them. The common misconception is that the more packages one installs, the more complete and powerful its octave installation will be be. However, in the same way one would never install all perl modules, ruby gems or python packages (because it simply makes no sense), one should not install all octave packages. This isn't desirable and it's not even possible. Some packages conflict with each other, some are broken, others are just crappy and will break your system. What's worse, some packages are even loaded automatically at startup so you may be screwing your octave installation without even realizing it.

Further links

• Check the page Installation for more detailed information about installing Octave.

Coding

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 (...))

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.

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 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:1> 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:2> corr
 corr2     corrcoef

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 vary the line thickness?

• There's plpot_octave, but the one in debian doesn't work for me.
• Here's my octave hack for it--- http://gnufans.net/~deego/pub/octave/plot_width.m This one simply draws the line multiple times.
• You can edit the .eps file manually or using sed and awk.
• Export the graph as fig file (gset term fig thickness 2). This also allows for easy postediting with xfig and export to formats not supported by gnuplot.
• The gplot command of octave does not support gnuplot's linewidth parameter Thus you must use the graw() function for sending this option directly to gnuplot, eg.

graw('replot "" notitle with lines lw 4\n');

• Search the octave archives for more.

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:

#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 create a full semilog/log grid

gset grid mxtics mytics
gset grid lw 2, lw 0.1
grid("on");

One can use postscript enhancement for proper axis

gset format x "10^{%%L}"

or

gset format y "10^{%%L}" 

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

Here is a awk script to get a rainbow colour 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 (ie, a plot to a file)?

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

One can set that behaviour as default:

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

Common problems

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.

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

How do I get sound output in Windows?

See http://www.octave.org/octave-lists/archive/help-octave.2003/msg01567.html for a start.

Why does Octave segfault when using "clear all;"?

This is a known problem if you have one of the following packages loaded:

• ann
• database
• ftp

See http://www.nabble.com/Segmentation-Fault---Clear-all-td21998563.html for a discussion

Octave takes a long time to find symbols.

Octave uses the genpath function to recursively add directories to the list of directories searched for function files. Check the list of directories with the path command. If the path list is very long check your use of the genpath function.

When plotting Octave occasionally gives me errors like gnuplot> 9 0.735604 line 26317: invalid command.

There is a known bug in gnuplot 4.2 that can cause an off by one error while piping data to gnuplot. It has been fixed in gnuplot 4.4.

If you have obtained your copy of Octave from a distribution please file a bug report requesting that the fix reported in the above bug report be included.

I cannot install a package. Octave complains about a missing 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 XXX 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. Instead, report the output of "hg summary" or "hg id". Also please use hash numbers instead of 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 this 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 decimals like 0.1 exactly in base 2. In binary, the representation to one tenth is $0.{\overline {00011}}$ where the bar indicates that it repeats infinitely (like how $1/3=0.{\overline {3}}$ 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.

This isn't an Octave bug. It happens with any program that uses IEEE 754 floating point arithmetic. The reason why Octave and other programs use IEEE 754 floats is that they are fast, because they are implemented in hardware. Unless you are using very exotic hardware, Octave will use your computer's processor for 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.

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.

Porting programs from Matlab to Octave

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 at anytime.

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

How is Octave different from Matlab?

The major differences between Octave 3.4.N and Matlab R2010b are:

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 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.

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 behaviour 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 behaviour, 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.

GUI

This is a small section but it's probably one of the most frequent questions.

Is there a GUI for Octave?

No.

Is there a GUI planned for Octave?

Yes, and is already in development. You can download the Octave repository and compile the development branch yourself (it seems to be stable enough for use and the 3.6.2 binaries for windows already have it). Testing is always welcomed, and patches even more. Note that despite being called Octave GUI, it is not a separate project. It is simply the Octave GUI, the Octave Graphical User Interface, just like the Octave prompt, Octave interpreter, etc are not separate projects (not to be confused with the completely unrelated but similarly named, GUI Octave project).

How come there's still no GUI for Octave?

The Octave prompt is really really good and that's what the Octave developers use. Octave is community project which means that it has the functionalities that its users are willing to spend time implementing. Since Octave developers do not need a GUI (some actually would not use one if it existed), they have no reason to make one. Also, many people on the community are of the opinion that using a GUI slows down the learning of the language.

I want Octave developers to work on a GUI?

If you would like the Octave developers to implement a GUI for you, consider the same route taken by others that want a specific function/capability to be implemented. Some of the Octave developers will work as coders for hire. Ask on the maintainers mailing list. This is not unlike paying a builder to add an extra room to your house. The fact there is no GUI in Octave only shows that there is not enough interest for it (despite the amount of time people asking for it).

What about all the Octave GUIs I find on Google?

None of the GUIs for Octave that have been developed thus far are part of Octave and there is a reason for it. All of them fail at a very important point, integration with Octave. They treat Octave as a foreign black box using pipes for communication, an approach that is bound to eventually fail. This includes QtOctave (now abandoned and incompatible with newer versions of Octave), Xoctave (which is proprietary and commercial) and GUI Octave (which is proprietary and the author is not interested to share his code to preserve its "artistic integrity").

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 now under development under the name Octave GUI (this is not a separate project anymore, it is simply the Octave GUI and not to be confused with the completely unrelated but similarly-named, GUI Octave project).

QtOctave has been abandoned. Why are you working on yet another GUI rather than trying to fix QtOctave?

Read previous question. The approach taken by QtOctave for interacting with Octave is bound to fail. Yes, it could be fixed and made to work again for the latest octave release but this would not be a permanent fix and would eventually fail again. A longer explanation has already been written as part of GSoC2012.

Yes, QtOctave is a useful tool, looks beautiful and we are thankful to its developers for working on such a nice tool plus making it libre. We are in no way saying the opposite. However, it will never be stable. The Octave GUI being developed now uses code from many different projects, we are trying to not reinvent the wheel. But we want something that will achieve stability.

What about GUI Octave?

GUI Octave is not part of the Octave project despite its very deceptive name. Not only is a different project, it is also very inappropriate for this piece of closed-source software to occupy the name "GUI Octave" with the hostile anti free-software stance the developer has taken. It advertises itself as a "completely free" wrapper to "GNU Octave". It must be explicit that it is not free software as understood by GNU. This is deceptive.

How can I know more about Octave GUI?

This is being developed as part of the Octave project so subscribe to the maintainers mailing list. When you checkout the Octave repository, you'll find the GUI source on the development/default branch.

I'm having problem XXX using GUI Octave, XOctave, QtOctave, etc?

Install Octave only, without any of the non-supported by GUIs and see if the problem disappears.