The GNU Octave interval package for real-valued interval arithmetic.
- 1 Distribution
- 2 Development status
- 3 Compatibility
- 4 Similar software
- 5 Developer Information
- 6 VERSOFT
- Latest version at Octave Forge
- Debian GNU/Linux, Launchpad Ubuntu
- archlinux user repository
- Included in official Windows installer and installed automatically with Octave (since version 4.0.1)
- MacPorts for Mac OS X
- FreshPorts for FreeBSD
- Cygwin for Windows
- openSUSE build service
- All required functions from IEEE Std 1788-2015, IEEE standard for interval arithmetic, are implemented. The standard was approved on June 11, 2015. It will remain active for ten years.
- In addition there are functions for interval matrix arithmetic, plotting and solvers.
- Includes tests for all functions, many tests for basic functions
- No known bugs. The package is quite new and still has a small user base, so there might be hidden bugs. Also some advanced functions will always need more testing.
- Runs in GNU Octave ≥ 3.8.2
- Known to run under GNU/Linux, Microsoft Windows, macOS, and FreeBSD
- Possible TODOs
- To be considered in the future: Algorithms can be migrated from the C-XSC Toolbox (C++ code) from  (nlinsys.cpp and cpzero.cpp), however these would need gradient arithmetic and complex arithmetic.
- Interval version of
subsasgnto allow direct manipulation of inf and sup (and dec) properties.
>> A = infsup ("[2, 4]"); >> A.inf = infsup ("[1, 3]") A = [1, 4] >> A.inf = 5 A = [Empty]
- While at it, also allow multiple subscripts in
- While at it, also allow multiple subscripts in
>> A(:)(2:4)(2) = 42; # equivalent to A(3) = 42 >> A.inf(3) = 42; # also A(3).inf = 42 >> A.inf.inf = 42 # should produce error? >> A.inf.sup = 42 # should produce error?
a) It should be possible to specify the preferred overall field width (the length of s). b) It should be possible to specify how Empty, Entire and NaI are output, e.g., whether lower or upper case, and whether Entire becomes [Entire] or [-Inf, Inf]. c) For l and u, it should be possible to specify the field width, and the number of digits after the point or the number of significant digits. (partly this is already implemented by output_precision (...) / `format long` / `format short`) d) It should be possible to output the bounds of an interval without punctuation, e.g., 1.234 2.345 instead of [1.234, 2.345]. For instance, this might be a convenient way to write intervals to a file for use by another application.
The interval package's main goal is to be compliant with IEEE Std 1788-2015, so it is compatible with other standard-conforming implementations (on the set of operations described by the standard document).
Octave Forge simp package
In 2008/2009 there was a Single Interval Mathematics Package (SIMP) for Octave, which has eventually become unmaintained at Octave Forge.
The simp package contains a few basic interval arithmetic operations on scalar or vector intervals. It does not consider inaccurate built-in arithmetic functions, round-off, conversion and representational errors. As a result its syntax is very easy, but the arithmetic fails to produce guaranteed enclosures.
It is recommended to use the interval package as a replacement for simp. However, function names and interval constructors are not compatible between the packages.
This interval package is not meant to be a replacement for INTLAB and any compatibility with it is pure coincidence. Since both are compatible with GNU Octave, they happen to agree on many function names and programs written for INTLAB may possibly run with this interval package as well. Some fundamental differences that I am currently aware of:
- INTLAB is non-free software, it grants none of the four essential freedoms of free software
- INTLAB is not conforming to IEEE Std 1788-2015 and the parsing of intervals from strings uses a different format—especially for the uncertain form
- INTLAB supports intervals with complex numbers and sparse interval matrices, but no empty intervals
- INTLAB uses inferior accuracy for most arithmetic operations, because it focuses on speed
- Basic operations can be found in both packages, but the availability of special functions depends
|Code: In GNU Octave the interval package can also be run alongside INTLAB.|
# INTLAB intervals A1 = infsup (2, 3); B1 = hull (-4, A1); C1 = midrad (0, 2); # Interval package intervals pkg load interval A2 = infsup (2, 3); B2 = hull (-4, A2); C2 = midrad (0, 2); pkg unload interval # Computation with INTLAB A1 + B1 * C1 # Computation without INTLAB A2 + B2 * C2
Simple programs written for INTLAB should run without modification with this interval package. The following table lists common functions that use a different name in INTLAB.
|infsup (x)||intval (x)|
|wid (x)||diam (x)|
|subset (a, b)||in (a, b)|
|interior (a, b)||in0 (a, b)|
|isempty (x)||isnan (x)|
|disjoint (a, b)||emptyintersect (a, b)|
|hdist (a, b)||qdist (a, b)|
|disp (x)||disp2str (x)|
|infsup (s)||str2intval (s)|
|isa (x, "infsup")||isintval (x)|
For C++ there is an interval library libieeep1788 by Marco Nehmeier (member of IEEE P1788). It aims to be standard compliant with IEEE Std 1788-2015 and is designed in a modular way, supporting several interval data types and different flavors of interval arithmetic . The GNU Octave interval package shares several unit tests with libieeep1788.
For Julia there is an evolving interval library ValidatedNumerics.jl by Luis Benet and David P. Sanders. It is planned to become conforming to IEEE Std 1788-2015 (or to the basic standard 1788.1) in the future.
Source Code Repository
apt-get install liboctave-dev mercurial make automake libmpfr-dev
The repository contains a Makefile which controls the build process. Some common targets are:
make releaseCreate a release tarball and the HTML documentation for Octave Forge (takes a while).
make checkRun the full test-suite to verify that code changes didn't break anything (takes a while).
make runQuickly start Octave with minimal recompilation and functions loaded from the workspace (for interactive testing of code changes).
apt-get install libmpfr-dev autoconf automake git python3-ply python3-yaml inkscape zopfli
- Octave package: doctest
- Purpose: Verification of the examples in the manual and in the function documentation
- Installation: Use
pkg install -forge doctestinside Octave
- Octave package: generate_html
- Purpose: Generate HTML documenation for publication on Octave Forge (only needed for release)
- Installation: Use
pkg install -forge generate_htmlinside Octave
- Autoconf & Automake
- Purpose: Preparation of bundled crlibm library for a release
- Purpose: Compilation of unit-test
- Installation: The git repository is automatically cloned by the Makefile
- Purpose: Generate / convert images for the manual
- Purpose: Optimize the size of the compressed release tarball
In a nutshell the package provides two new data types to users: bare intervals and decorated intervals. The data types are implemented as:
infsup(bare interval) with attributes
inf(lower interval boundary) and
sup(upper interval boundary)
infsupdec(decorated interval) which extends the former and adds attribute
Almost all functions in the package are implemented as methods of these classes, e. g.
@infsup/sin implements the sine function for bare intervals. Most code is kept in m-files. Arithmetic operations that require correctly-rounded results are implemented in oct-files (C++ code), these are used internally by the m-files of the package. The source code is organized as follows:
+- doc/ – package manual +- inst/ | +- @infsup/ | | +- infsup.m – class constructor for bare intervals | | +- sin.m – sine function for bare intervals (uses mpfr_function_d internally) | | `- ... – further functions on bare intervals | +- @infsupdec/ | | +- infsupdec.m – class constructor for decorated intervals | | +- sin.m – sine function for decorated intervals (uses @infsup/sin internally) | | `- ... – further functions on decorated intervals | `- ... – a few global functions that don't operate on intervals +- src/ | | +- mpfr_function_d.cc – computes various arithmetic functions correctly rounded (using MPFR) | | `- ... – other oct-file sources `- test/ – interval arithmetic unit tests
- All methods must check
print_usageif the number of parameters is wrong. This prevents simple errors by the user.
- Methods with more than 1 parameter must convert non-interval parameters to intervals using the class constructor. This allows the user to mix non-interval parameters with interval parameters and the function treats any inputs as intervals. Invalid values will be handled by the class constructors.
if (not (isa (x, "infsup"))) x = infsup (x); endif if (not (isa (y, "infsup"))) y = infsup (y); endif
if (not (isa (x, "infsupdec"))) x = infsupdec (x); endif if (not (isa (y, "infsupdec"))) y = infsupdec (y); endif
Use of Octave functions
Octave functions may be used as long as they don't introduce arithmetic errors. For example, the ceil function can be used safely since it is exact on binary64 numbers.
function x = ceil (x) ... parameter checking ... x.inf = ceil (x.inf); x.sup = ceil (x.sup); endfunction
If Octave functions would introduce arithmetic/rounding errors, there are interfaces to MPFR (
mpfr_function_d) and crlibm (
crlibm_function), which can produce guaranteed boundaries.
Vectorization & Indexing
All functions should be implemented using vectorization and indexing. This is very important for performance on large data. For example, consider the plus function. It computes lower and upper boundaries of the result (x.inf, y.inf, x.sup, y.sup may be vectors or matrices) and then uses an indexing expression to adjust values where empty intervals would have produces problematic values.
function x = plus (x, y) ... parameter checking ... l = mpfr_function_d ('plus', -inf, x.inf, y.inf); u = mpfr_function_d ('plus', +inf, x.sup, y.sup); emptyresult = isempty (x) | isempty (y); l(emptyresult) = inf; u(emptyresult) = -inf; … endfunction
The VERSOFT software package (by Jiří Rohn) has been released under a free software license (Expat license) and algorithms may be migrated into the interval package.
The following table is no longer up-to-date, it describes the situation before p-coded files have been disclosed. So, some functions are no longer trapped.
|Real (or complex) data only: Matrices|
|verbasis||trapped||depends on |
|vercondnum||trapped||depends on |
|verdet||trapped||depends on p-coded |
|verdistsing||trapped||depends on |
|verfullcolrank||encrypted||implemented in p-coded |
|vernorm2||trapped||depends on |
|vernull (experimental)||unknown||depends on |
|verorth||trapped||depends on |
|verorthproj||trapped||depends on |
|verpd||trapped||depends on |
|verpmat||trapped||depends on |
|verrank||trapped||depends on |
|verrref||trapped||depends on |
|Real (or complex) data only: Matrices: Eigenvalues and singular values|
|vereig||encrypted||implemented in p-coded |
|free, migrated (for real eigenvalues)||dependency |
|verspectrad||trapped||main part implemented in p-coded |
|Real (or complex) data only: Matrices: Decompositions|
|verpoldec||trapped||depends on |
|verrankdec||trapped||depends on |
|verspectdec||trapped||main part implemented in p-coded |
|verthinsvd||encrypted||implemented in p-coded |
|Real (or complex) data only: Matrix functions|
|vermatfun||trapped||main part implemented in p-coded |
|Real data only: Linear systems (rectangular)|
|free, migrated||use |
|verlsq||trapped||depends on |
|Real data only: Optimization|
|verlcpall||trapped||depends on |
|free, migrated||use |
|verlinprogg||encrypted||implemented in p-coded |
|Real (or complex) data only: Polynomials|
|verroots||trapped||main part implemented in p-coded |
|Interval (or real) data: Matrices|
|verhurwstab||trapped||depends on |
|verinverse||trapped||depends on |
|verposdef||trapped||depends on |
|Interval (or real) data: Matrices: Eigenvalues and singular values|
|vereigsym||trapped||main part implemented in p-coded |
|vereigval||trapped||depends on |
|verperrvec||free||the function is just a wrapper around |
|versingval||trapped||depends on |
|Interval (or real) data: Matrices: Decompositions|
|free, migrated||migrated version has been named after the standard Octave function |
|Interval (or real) data: Linear systems (square)|
|verenclinthull||trapped||main part implemented in p-coded |
|verhullparam||encrypted||implemented in p-coded |
|verhullpatt||trapped||main part implemented in p-coded |
|verintervalhull||encrypted||implemented in p-coded |
|Interval (or real) data: Linear systems (rectangular)|
|verintlinineqs||free||depends on |
|vertolsol||free||depends on |
|Interval (or real) data: Matrix equations (rectangular)|
|Real data only: Uncommon problems|
|verabsvaleqn||trapped||main part implemented in p-coded |
|verabsvaleqnall||trapped||depends on |
|verbasintnpprob||trapped||depends on |