Module org.chocosolver
Package org.chocosolver.solver.variables.view

Class IntBoolView

    • Field Detail

      • cste

        public final int cste
        A constant value

    • Method Detail

      • removeValue

        public final boolean removeValue​(int value,
                                 ICause cause)
                          throws ContradictionException
        Description copied from interface: IntVar
        Removes valuefrom the domain of this. The instruction comes from propagator.
        • If value is out of the domain, nothing is done and the return value is false,
        • if removing value leads to a dead-end (domain wipe-out), a ContradictionException is thrown,
        • otherwise, if removing value from the domain can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        removeValue in interface IntVar
        Overrides:
        removeValue in class IntView<IntVar>
        Parameters:
        value - value to remove from the domain (int)
        cause - removal releaser
        Returns:
        true if the value has been removed, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • removeValues

        public final boolean removeValues​(IntIterableSet values,
                                  ICause cause)
                           throws ContradictionException
        Description copied from interface: IntVar
        Removes the value in valuesfrom the domain of this. The instruction comes from propagator.
        • If all values are out of the domain, nothing is done and the return value is false,
        • if removing a value leads to a dead-end (domain wipe-out), a ContradictionException is thrown,
        • otherwise, if removing the values from the domain can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        removeValues in interface IntVar
        Overrides:
        removeValues in class IntView<IntVar>
        Parameters:
        values - set of ordered values to remove
        cause - removal release
        Returns:
        true if at least a value has been removed, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • removeAllValuesBut

        public final boolean removeAllValuesBut​(IntIterableSet values,
                                        ICause cause)
                                 throws ContradictionException
        Description copied from interface: IntVar
        Removes all values from the domain of this except those in values. The instruction comes from propagator.
        • If all values are out of the domain, a ContradictionException is thrown,
        • if the domain is a subset of values, nothing is done and the return value is false,
        • otherwise, if removing all values but values from the domain can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        removeAllValuesBut in interface IntVar
        Overrides:
        removeAllValuesBut in class IntView<IntVar>
        Parameters:
        values - set of ordered values to keep in the domain
        cause - removal release
        Returns:
        true if a at least a value has been removed, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • removeInterval

        public final boolean removeInterval​(int from,
                                    int to,
                                    ICause cause)
                             throws ContradictionException
        Description copied from interface: IntVar
        Removes values between [from, to] from the domain of this. The instruction comes from propagator.
        • If union between values and the current domain is empty, nothing is done and the return value is false,
        • if removing a value leads to a dead-end (domain wipe-out), a ContradictionException is thrown,
        • otherwise, if removing at least a value from the domain can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        removeInterval in interface IntVar
        Overrides:
        removeInterval in class IntView<IntVar>
        Parameters:
        from - lower bound of the interval to remove (int)
        to - upper bound of the interval to remove(int)
        cause - removal releaser
        Returns:
        true if the value has been removed, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • updateLowerBound

        public final boolean updateLowerBound​(int value,
                                      ICause cause)
                               throws ContradictionException
        Description copied from interface: IntVar
        Updates the lower bound of the domain of this to value. The instruction comes from propagator.
        • If value is smaller than the lower bound of the domain, nothing is done and the return value is false,
        • if updating the lower bound to value leads to a dead-end (domain wipe-out), a ContradictionException is thrown,
        • otherwise, if updating the lower bound to value can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        updateLowerBound in interface IntVar
        Overrides:
        updateLowerBound in class IntView<IntVar>
        Parameters:
        value - new lower bound (included)
        cause - updating releaser
        Returns:
        true if the lower bound has been updated, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • updateUpperBound

        public final boolean updateUpperBound​(int value,
                                      ICause cause)
                               throws ContradictionException
        Description copied from interface: IntVar
        Updates the upper bound of the domain of this to value. The instruction comes from propagator.
        • If value is greater than the upper bound of the domain, nothing is done and the return value is false,
        • if updating the upper bound to value leads to a dead-end (domain wipe-out), a ContradictionException is thrown,
        • otherwise, if updating the upper bound to value can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        updateUpperBound in interface IntVar
        Overrides:
        updateUpperBound in class IntView<IntVar>
        Parameters:
        value - new upper bound (included)
        cause - update releaser
        Returns:
        true if the upper bound has been updated, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • updateBounds

        public final boolean updateBounds​(int lb,
                                  int ub,
                                  ICause cause)
                           throws ContradictionException
        Description copied from interface: IntVar
        Updates the lower bound and the upper bound of the domain of this to, resp. lb and ub. The instruction comes from propagator.

        • If lb is smaller than the lower bound of the domain and ub is greater than the upper bound of the domain,

          nothing is done and the return value is false,

        • if updating the lower bound to lb, or updating the upper bound to ub leads to a dead-end (domain wipe-out), or if lb is strictly greater than ub, a ContradictionException is thrown,
        • otherwise, if updating the lower bound to lb and/or the upper bound to ub can be done safely can be done safely, the event type is created (the original event can be promoted) and observers are notified and the return value is true
        Specified by:
        updateBounds in interface IntVar
        Overrides:
        updateBounds in class IntView<IntVar>
        Parameters:
        lb - new lower bound (included)
        ub - new upper bound (included)
        cause - update releaser
        Returns:
        true if the upper bound has been updated, false otherwise
        Throws:
        ContradictionException - if the domain become empty due to this action

      • getTypeAndKind

        public final int getTypeAndKind()
        Description copied from interface: Variable
        Return a MASK composed of 2 main information: TYPE and KIND.
        TYPE is defined in the 3 first bits : VAR ( 1 << 0), CSTE (1 << 1) or VIEW (1 << 2)
        KIND is defined on the other bits : INT (1 << 3), BOOL (INT + 1 << 4), GRAPH (1 << 5) or META (1 << 6)

        To get the TYPE of a variable: 

         int type = var.getTypeAndKind() & Variable.TYPE;

        To get the KIND of a variable: 

         int kind = var.getTypeAndKind() & Variable.KIND;

        To check a specific type or kind of a variable: 

             boolean isVar = (var.getTypeAndKind() & Variable.VAR) !=0;
     boolean isInt = (var.getTypeAndKind() & Variable.INT) !=0;
        Specified by:
        getTypeAndKind in interface Variable
        Overrides:
        getTypeAndKind in class IntView<IntVar>
        Returns:
        an int representing the type and kind of the variable

      • getValue

        public final int getValue()
        Description copied from interface: IntVar
        Retrieves the current value of the variable if instantiated, otherwier the lower bound.
        Specified by:
        getValue in interface IntVar
        Returns:
        the current value (or lower bound if not yet instantiated).

      • getValueIterator

        public final DisposableValueIterator getValueIterator​(boolean bottomUp)
        Description copied from interface: IntVar
        Retrieves an iterator over values of this.

        The values can be iterated in a bottom-up way or top-down way.

        To bottom-up iterate over the values in a IntVar, use the following loop: 

         DisposableValueIterator vit = var.getValueIterator(true);
 while(vit.hasNext()){
     int v = vit.next();
     // operate on value v here
 }
 vit.dispose();
        To top-down iterate over the values in a IntVar, use the following loop: 
         DisposableValueIterator vit = var.getValueIterator(false);
 while(vit.hasPrevious()){
     int v = vit.previous();
     // operate on value v here
 }
 vit.dispose();
        Using both previous and next can lead to unexpected behaviour.
        Specified by:
        getValueIterator in interface IntVar
        Overrides:
        getValueIterator in class IntView<IntVar>
        Parameters:
        bottomUp - way to iterate over values. true means from lower bound to upper bound, false means from upper bound to lower bound.
        Returns:
        a disposable iterator over values of this.

      • getRangeIterator

        public final DisposableRangeIterator getRangeIterator​(boolean bottomUp)
        Description copied from interface: IntVar
        Retrieves an iterator over ranges (or intervals) of this.

        The ranges can be iterated in a bottom-up way or top-down way.

        To bottom-up iterate over the values in a IntVar, use the following loop: 

         DisposableRangeIterator rit = var.getRangeIterator(true);
 while (rit.hasNext()) {
     int from = rit.min();
     int to = rit.max();
     // operate on range [from,to] here
     rit.next();
 }
 rit.dispose();
        To top-down iterate over the values in a IntVar, use the following loop: 
         DisposableRangeIterator rit = var.getRangeIterator(false);
 while (rit.hasPrevious()) {
     int from = rit.min();
     int to = rit.max();
     // operate on range [from,to] here
     rit.previous();
 }
 rit.dispose();
        Using both previous and next can lead to unexpected behaviour.
        Specified by:
        getRangeIterator in interface IntVar
        Overrides:
        getRangeIterator in class IntView<IntVar>
        Parameters:
        bottomUp - way to iterate over ranges. true means from lower bound to upper bound, false means from upper bound to lower bound.
        Returns:
        a disposable iterator over ranges of this.

      • createDelta

        public final void createDelta()
        Description copied from interface: Variable
        Create a delta, if necessary, in order to observe removed values of a this. If the delta already exists, has no effect.
        Specified by:
        createDelta in interface Variable
        Overrides:
        createDelta in class IntView<IntVar>

      • monitorDelta

        public final IIntDeltaMonitor monitorDelta​(ICause propagator)
        Description copied from interface: IntVar
        Allow to monitor removed values of this.
        Specified by:
        monitorDelta in interface IntVar
        Parameters:
        propagator - the cause that requires to monitor delta
        Returns:
        a delta monitor

      • not

        public final BoolVar not()
        Specified by:
        not in interface BoolVar
        Specified by:
        not in interface ReExpression
        Returns:
        return the expression "¬x" where this is "x"

      • hasNot

        public final boolean hasNot()
        Specified by:
        hasNot in interface BoolVar

      • isLit

        public final boolean isLit()
        Description copied from interface: ILogical
        Current tree is a literal
        Specified by:
        isLit in interface ILogical
        Returns:
        true if this is a literal

      • isNot

        public final boolean isNot()
        Description copied from interface: ILogical
        Current tree is rooted with NOT logical operator This is a one way relationship: in case a = not(b) a.isNot() returns true whereas b.isNot() returns false (unless b = not(c)...)
        Specified by:
        isNot in interface ILogical
        Returns:
        true if this is NOT

      • setNot

        public final void setNot​(boolean isNot)
        Description copied from interface: ILogical
        States whether or not this variable is the negation of another. This is a one way relationship: in case a = not(b) a.isNot() returns true whereas b.isNot() returns false (unless b = not(c)...)
        Specified by:
        setNot in interface ILogical
        Parameters:
        isNot - true iff this variable is the negation of another