Package org.jacop.constraints

Class Or

java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.Or
All Implemented Interfaces:
SatisfiedPresent, StoreAware, UsesQueueVariable
public class Or extends PrimitiveConstraint implements UsesQueueVariable
Constraint c1 \/ c2 \/ ... \/ cn.
Version:
4.10

  • Field Details

    • idNumber

      static AtomicInteger idNumber

    • listOfC

      public PrimitiveConstraint[] listOfC
      It specifies a list of constraints from which one constraint must be satisfied.

    • propagation

      private boolean propagation
      It specifies if during the consistency execution a propagation has occurred.

    • queueForward

      public final QueueForward<PrimitiveConstraint> queueForward

  • Constructor Details

    • Or

      public Or(PrimitiveConstraint[] listOfC)
      It constructs Or constraint.
      Parameters:
      listOfC - list of primitive constraints which at least one of them has to be satisfied.

    • Or

      public Or(List<PrimitiveConstraint> listOfC)
      It constructs Or constraint.
      Parameters:
      listOfC - list of primitive constraints which at least one of them has to be satisfied.

    • Or

      public Or(PrimitiveConstraint c1, PrimitiveConstraint c2)
      It constructs an Or constraint, at least one constraint has to be satisfied.
      Parameters:
      c1 - the first constraint which can be satisfied.
      c2 - the second constraint which can be satisfied.

  • Method Details

    • 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.

    • getNestedPruningEvent

      public int getNestedPruningEvent(Var var, boolean mode)
      Description copied from class: PrimitiveConstraint
      It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated. This events are the ones which can change satisfied status?
      Overrides:
      getNestedPruningEvent in class PrimitiveConstraint
      Parameters:
      var - for which pruning event is retrieved
      mode - decides if pruning event for consistency or nonconsistency is required.
      Returns:
      pruning event associated with the given variable for a given consistency mode.

    • getDefaultNotConsistencyPruningEvent

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

    • getDefaultConsistencyPruningEvent

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

    • queueVariable

      public void queueVariable(int level, Var var)
      Description copied from class: Constraint
      This is a function called to indicate which variable in a scope of constraint has changed. It also indicates a store level at which the change has occurred.
      Overrides:
      queueVariable in class Constraint
      Parameters:
      level - the level of the store at which the change has occurred.
      var - variable which has changed.

    • 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.

    • 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.

    • 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.

      Specified by:
      satisfied in interface SatisfiedPresent
      Returns:
      true if constraint is possible to verify that it is satisfied.

    • toString

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