Package org.jacop.constraints

Class EqBool

java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.EqBool
All Implemented Interfaces:
SatisfiedPresent, StoreAware
public class EqBool extends PrimitiveConstraint
If all x's are equal to each other then result variable is equal 1. Otherwise, result variable is equal to zero. It restricts the domains of all variables to be either 0 or 1.
Version:
4.10

  • Field Details

    • idNumber

      static AtomicInteger idNumber

    • list

      public IntVar[] list
      It specifies x variables in the constraint.

    • result

      public IntVar result
      It specifies variable result in the constraint.

    • constraints

      List<Constraint> constraints

  • Constructor Details

    • EqBool

      public EqBool(IntVar[] list, IntVar result)
      It constructs eqBool.
      Parameters:
      list - list of x's which must all be equal to the same value to make result equal 1.
      result - variable which is equal 0 if x's contain different values.

    • EqBool

      public EqBool(List<? extends IntVar> list, IntVar result)
      It constructs eqBool.
      Parameters:
      list - list of variables which must all be equal to the same value to make result equal 1.
      result - variable which is equal 0 if variables from list contain different values.

  • Method Details

    • checkInvariants

      public String checkInvariants()
      It checks invariants required by the constraint. Namely that boolean variables have boolean domain.
      Returns:
      the string describing the violation of the invariant, null otherwise.

    • getDefaultNestedNotConsistencyPruningEvent

      protected int getDefaultNestedNotConsistencyPruningEvent()
      Overrides:
      getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

    • getDefaultNestedConsistencyPruningEvent

      protected int getDefaultNestedConsistencyPruningEvent()
      Overrides:
      getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

    • getDefaultConsistencyPruningEvent

      public int getDefaultConsistencyPruningEvent()
      Specified by:
      getDefaultConsistencyPruningEvent in class Constraint

    • getDefaultNotConsistencyPruningEvent

      protected int getDefaultNotConsistencyPruningEvent()
      Specified by:
      getDefaultNotConsistencyPruningEvent in class PrimitiveConstraint

    • consistency

      public void consistency(Store store)
      Description copied from class: Constraint
      It is a (most probably incomplete) consistency function which removes the values from variables domains. Only values which do not have any support in a solution space are removed.
      Specified by:
      consistency in class Constraint
      Parameters:
      store - constraint store within which the constraint consistency is being checked.

    • notConsistency

      public void notConsistency(Store store)
      Description copied from class: PrimitiveConstraint
      It makes pruning in such a way that constraint is notConsistent. It removes values which always belong to a solution.
      Specified by:
      notConsistency in class PrimitiveConstraint
      Parameters:
      store - the constraint store in which context the notConsistency technique is evaluated.

    • satisfied

      public boolean satisfied()
      Description copied from interface: SatisfiedPresent
      It checks if the constraint is satisfied. It can return false even if constraint is satisfied but not all variables in its scope are grounded. It needs to return true if all variables in its scope are grounded and constraint is satisfied.

      Implementations of this interface for constraints that are not PrimitiveConstraint may require constraint imposition and consistency check as a requirement to work correctly.

      Returns:
      true if constraint is possible to verify that it is satisfied.

    • notSatisfied

      public boolean notSatisfied()
      Description copied from class: PrimitiveConstraint
      It checks if constraint would be always not satisfied.
      Specified by:
      notSatisfied in class PrimitiveConstraint
      Returns:
      true if constraint must be notSatisfied, false otherwise.

    • toString

      public String toString()
      Description copied from class: Constraint
      It produces a string representation of a constraint state.
      Overrides:
      toString in class Constraint

    • decompose

      public List<Constraint> decompose(Store store)
      Description copied from class: Constraint
      It returns an array list of constraint which are used to decompose this constraint. It actually creates a decomposition (possibly also creating variables), but it does not impose the constraint.
      Overrides:
      decompose in class Constraint
      Parameters:
      store - the constraint store in which context the decomposition takes place.
      Returns:
      an array list of constraints used to decompose this constraint.

    • imposeDecomposition

      public void imposeDecomposition(Store store)
      Description copied from class: Constraint
      It imposes the decomposition of the given constraint in a given store.
      Overrides:
      imposeDecomposition in class Constraint
      Parameters:
      store - the constraint store to which the constraint is imposed to.