Skip to content

msis/pyIbex

 
 

Repository files navigation

Build Status

========================== Ibex python binding


Introduction

pyIbex is a python binding of Ibex library. It aims at providing a basic interface of Ibex Basic types (Interval, IntervalVector, Ctc, ...), high level functionnalities and contractors programming.


Prerequisites

  • CMake (>= 2.8.3)
  • Boost (tested with 1.4.2, but should work with >= 1.3.2)
  • Python (tested with 2.7, but should work with >= 2.2)
  • a C++ compiler for your platform, e.g. GCC or MinGW (not tested on Windows and Mac OS X)

Building

  • Set the BOOST_ROOT environment variable if Boost is installed in a non-standard directory
  • create a build directory, e.g. directly in the project directory and cd to it: mkdir build ; cd build
  • run cmake .. and afterwards make, make install and make test option :
    • use -DCMAKE_INSTALL_PREFIX= to change the install destination
    • use -DCMAKE_BUILD_TYPE=DEBUG | RELEASE to change the compilation mode
    • use -DCPPTEST_DIR= if libcpptest is installed in a non-standard directory
    • use -DIBEX_ROOT= if ibex is installed in a non-standard directory Alternatively, run the provided build.sh script.

For Windows Users

  • build boost
./b2 --with-python -q -d 2 include="/usr/include/python3.4m" variant=release link=static,shared threading=multi --prefix=${DEVEL_BASE} install
  • Build boost ./bjam --with-python variant=release link=static address-model=64 runtime-link=static

user-config.jam

using python : 3.4 : E:\pyzo2015a\python.exe : E:\pyzo2015a\include : E:\pyzo2015a\libs

E:\pyIbex\build>cmake -G "Visual Studio 12 2013 Win64" -DBOOST_ROOT=E:\boost_1_58_0 -DIBEX_ROOT="C:\Program Files\ibex-lib" -DCMAKE_INSTALL_PREFIX=E:\ -DPYTHON_EXECUTABLE=E:\pyzo2015a\python.exe -DUSE_PYTHON3=ON ../

+build ibex +open Developer COmmand Prompt for VS2013

cmake -G "Visual Studio 12 2013 Win64" -DCMAKE_BUILD_TYPE=Release -DCPPTEST_DIR=E:\add ../
msbuild /P:Configuration=Release /p:RuntimeLibrary=MT_StaticRelease PACKAGE.vcxproj
```bash
+Build pyIbex
```bash
cmake -G "Visual Studio 12 2013 Win64" -DBOOST_ROOT=$$$$$$$$ -DIBEX_ROOT=$$$$$$$$ -DPYTHON_EXECUTABLE=$$$$$$$$ ../
msbuild /P:Configuration=Release INSTALL.vcxproj
```bash

--------------------------
Features
--------------------------
Binding for :
- Interval, IntervalVector
- Bsc, LargestFirst
- Function (only text constructors)
- Ctc, CtcFwdBwd, CtcIn, CtcNotIn
- CtcUnion, CtcCompo
- CtcInverse
- CtcPolar
- CtcSegment (need ibex modification !!!)
- CtcQInterProjF
- SepUnion, SepInter
- SepCtcPair , SepFwdBwd, SepNot (negation of a separator)
- SepInverse, SepTransform
- SepPolygon, SepPolarXY, SepPolarXYT
- SepQInterProjF, SepCtcPairProj, SepProj




--------------------------
Tutorial
--------------------------
###Basic types manipulation

```python
# Load pyIbex lib
from pyIbex import *

# Create new Intervals
a = Interval.EMPTY_SET
a = Interval.ALL_REALS
a  = Interval(-2, 3)

# Create IntervalVector
b = IntervalVector( 2, a)
c = IntervalVector([1,2,3])
d = IntervalVector([[-1,3], [3,10], [-3, -1]])

# Operations
e = c & d
e = c+d
e = a * c

###Functions and contractors manipulation

# Define a Function from an equation
f = Function("x", "y", "x^2 + y^2 - 3")

# FwdBwd Contractor
ctc1 = CtcFwdBwd(f, CmpOp.LEQ, FwdMode.AFFINE_MODE)

# CtcIn/CtcOut contractors :math:`$f \in [-2.5, 3.5]$`
ctcIn = CtcIn(f, Interval(3).inflate(0.5))
ctcOut = CtcNotIn(f, Interval(3).inflate(0.5))

# Operations on Contractors 
# composition of two contractor
ctc = ctcIn & ctcOut 
# union of a python list of contractors
ctc1 = CtcUnion([ctcIn, ctcOut, ctc1]) 

TODO

  • Write the documentation !!!
  • Add IntervalMatrix support
    • Add IntervalMatrix support
    • Add Jacobian and gradient
  • Add numpy array support for interval Vector class
  • Add ratio option for LargestFirst(Vector, double )
  • Simplify Wrapper interface
  • Add n_var in separator
  • fix exceptions
  • Improve ItervalVectorinterface
    • Initialisation with X = IntervalVector(2, [2,3])
    • Iterate over dimension of an IntervalVector
  • add Function / Ctc / Sep Properties ( nb_vars, ...)
  • inheritance with python objects

About

A Python binding for ibex-lib

Resources

License

LGPL-3.0, LGPL-3.0 licenses found

Licenses found

LGPL-3.0
LICENSE
LGPL-3.0
COPYING.LESSER

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CMake 38.5%
  • C++ 30.9%
  • Python 30.5%
  • Shell 0.1%