Ibex (org.choco-solver-choco-solver 3.3.1-j7 API)

java.lang.Object
- org.chocosolver.solver.constraints.real.Ibex

```
public class Ibex
extends Object
```
A link to Ibex library. The following option should be passed to the VM:
```
     -Djava.library.path=/path/to/ibex/dynlib
 
```
Since:

19/07/12

Author:

Charles Prud'homme

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BAD_POINT`
`static int`	`COMPO`
`static int`	`CONTRACT`
`protected int`	`contractorCount`
`static int`	`ENTAILED`
`static int`	`FAIL`
`static int`	`FALSE`
`static int`	`FALSE_OR_TRUE`
`static int`	`FULL_INFLATE`
`static int`	`HC4`
`static int`	`HC4_NEWTON`
`static int`	`INFLATE`
`static int`	`NOT_SIGNIFICANT`
`static int`	`NOTHING`
`static double`	`RATIO`
`static int`	`TRUE`
`static int`	`UNKNOWN_POINT`

Constructor Summary

Constructors
Constructor and Description

Ibex()

Constructors
Constructor and Description
`Ibex()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`add_contractor(int nb_var, String syntax, int option)` Add a new Ibex constraint Example: add_ctr(2,{0}={1},COMPO) will add the constraint x=y with COMPO contractor
`int`	`contract(int i, double[] bounds)` Same as contract(int, double bounds[], int reif) with reif=TRUE.
`int`	`contract(int i, double[] bounds, int reif)` Call the contractor associated to a constraint or its negation.
`int`	`getContractorCount()`
`int`	`inflate(int i, double[] p, double[] bounds, boolean in)` Inflate a point to a box with respect to a constraint or its negation.
`void`	`release()` Free IBEX structures from memory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RATIO
```
public static final double RATIO
```
    See Also:
    Constant Field Values
  - COMPO
```
public static final int COMPO
```
    See Also:
    Constant Field Values
  - HC4
```
public static final int HC4
```
    See Also:
    Constant Field Values
  - HC4_NEWTON
```
public static final int HC4_NEWTON
```
    See Also:
    Constant Field Values
  - FAIL
```
public static final int FAIL
```
    See Also:
    Constant Field Values
  - ENTAILED
```
public static final int ENTAILED
```
    See Also:
    Constant Field Values
  - CONTRACT
```
public static final int CONTRACT
```
    See Also:
    Constant Field Values
  - NOTHING
```
public static final int NOTHING
```
    See Also:
    Constant Field Values
  - NOT_SIGNIFICANT
```
public static final int NOT_SIGNIFICANT
```
    See Also:
    Constant Field Values
  - INFLATE
```
public static final int INFLATE
```
    See Also:
    Constant Field Values
  - FULL_INFLATE
```
public static final int FULL_INFLATE
```
    See Also:
    Constant Field Values
  - BAD_POINT
```
public static final int BAD_POINT
```
    See Also:
    Constant Field Values
  - UNKNOWN_POINT
```
public static final int UNKNOWN_POINT
```
    See Also:
    Constant Field Values
  - FALSE
```
public static final int FALSE
```
    See Also:
    Constant Field Values
  - TRUE
```
public static final int TRUE
```
    See Also:
    Constant Field Values
  - FALSE_OR_TRUE
```
public static final int FALSE_OR_TRUE
```
    See Also:
    Constant Field Values
  - contractorCount
```
protected int contractorCount
```
- Constructor Detail
  - Ibex
```
public Ibex()
```
- Method Detail
  - add_contractor
```
public int add_contractor(int nb_var,
                 String syntax,
                 int option)
```
    Add a new Ibex constraint Example: add_ctr(2,{0}={1},COMPO) will add the constraint x=y with COMPO contractor
    
    Parameters:
    nb_var - int
    syntax - String
    option - int
    
    Returns:
    the identifier or the newly created contractor
  - contract
```
public int contract(int i,
           double[] bounds,
           int reif)
```
    Call the contractor associated to a constraint or its negation.
    We consider here the reified constraint R(b,c) : b<=>c(x_1,...,x_n).
    
    Parameters:
    i - - Number of the constraint (in the order of creation)
    bounds - - The bounds of domains under the following form: (x1-,x1+,x2-,x2+,...,xn-,xn+), where xi- (resp. xi+) is the lower (resp. upper) bound of the domain of x_i.
    reif - - Domain of the reification variable b with the following accepted values: FALSE, TRUE, FALSE_OR_TRUE.
    
    Returns:
    The status of contraction or fail/entailment test. Note that the name of the constant in return refers to the constraint c, not R. Hence "FAIL" means that no tuple satisfies c (should R be satisfiable or not).
    FAIL - No tuple satisfies c. If reif==FALSE, the bounds of x may have been impacted (the part of the domain inside c has been removed and the remaining part has been proven to be outside c). If reif==TRUE, the bounds have not been impacted but we have to consider that the domain has been reduced to the empty set. If reif==FALSE_OR_TRUE, bounds have not been impacted.
    ENTAILED - All the tuples satisfy the constraint. If reif==FALSE, the bounds have not been impacted but we have to consider that the domain has been reduced to the empty set. If reif==TRUE, the bounds of x may have been impacted (the part of the domain outside c has been removed and the remaining part has been proven to be inside c). If reif==FALSE_OR_TRUE, bounds have not been impacted.
    CONTRACT - This value can only be returned if reif==FALSE or reif==TRUE. At least one bound of x has been reduced by more than RATIO. If reif==FALSE, the removed part of the domain is inside c. If reif==TRUE, the removed part is outside.
    NOTHING - No bound has been reduced and nothing could be proven.
  - inflate
```
public int inflate(int i,
          double[] p,
          double[] bounds,
          boolean in)
```
    Inflate a point to a box with respect to a constraint or its negation.
    Given a constraint "c", we say that a point is "inside" (resp. "outside") if it satisfies (resp. does not satisfy) c. A box is said to be "inside"/"outside" if all its points are inside/outside c.
    This method takes an initial point "p" and an enclosing box "x". It tries to inflate p inside x with respect to a constraint "c" or its negation. That is, it builds a box "y", containing p and contained in "x":
    p ∈ y ⊆ x
    If in==TRUE, y must be inside c. Otherwise, it must be outside.
    
    Parameters:
    i - - Number of the constraint c (in the order of creation)
    p - - The coordinates of the point to inflate: (p1,...pn)
    bounds - - The bounds of the enclosing box x under the following form: (x1-,x1+,x2-,x2+,...,xn-,xn+), where xi- (resp. xi+) is the lower (resp. upper) bound of the domain of x_i.
    in - - TRUE if the box has to be inflated inside c (-> inner region), FALSE if it has to be inflated outside c (-> forbidden region).
    
    Returns:
    The status of inflation. If in==TRUE (resp. FALSE):
    NOT_SIGNIFICANT - The point p has been proven to be inside (resp. outside). However, it could not be inflated to a "significant" box y. A box y is considered to be significant if, on each of its dimension, the width of the interval y_i is at least RATIO times the width of x_i.
    INFLATE - The point p has been inflated to a significant box y that is inside (reps. outside) the constraint.
    FULL_INFLATE - The whole box x has been proven to be inside (resp. outside).
    BAD_POINT - No inflation was possible because p has been proven to be outside (resp. inside).
    UNKWOWN_POINT - No inflation at all could be done and it could even not be decided whether p is inside or outside the constraint.
  - contract
```
public int contract(int i,
           double[] bounds)
```
    Same as contract(int, double bounds[], int reif) with reif=TRUE.
  - release
```
public void release()
```
    Free IBEX structures from memory
  - getContractorCount
```
public int getContractorCount()
```

Class Ibex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RATIO

COMPO

HC4

HC4_NEWTON

FAIL

ENTAILED

CONTRACT

NOTHING

NOT_SIGNIFICANT

INFLATE

FULL_INFLATE

BAD_POINT

UNKNOWN_POINT

FALSE

TRUE

FALSE_OR_TRUE

contractorCount

Constructor Detail

Ibex

Method Detail

add_contractor

contract

inflate

contract

release

getContractorCount