Package org.jacop.constraints

Class In

java.lang.Object
org.jacop.constraints.DecomposedConstraint<Constraint>
org.jacop.constraints.Constraint
org.jacop.constraints.PrimitiveConstraint
org.jacop.constraints.In
All Implemented Interfaces:
SatisfiedPresent, StoreAware
public class In extends PrimitiveConstraint
Constraints X to belong to a specified domain.

Domain consistency is used.

Version:
4.10

  • Field Details

    • idNumber

      static AtomicInteger idNumber

    • x

      public IntVar x
      It specifies variable x whose domain must lie within a specified domain.

    • dom

      public IntDomain dom
      It specifies domain d which restricts the possible value of the specified variable.

    • DomComplement

      private IntDomain DomComplement
      It specifies all the values which can not be taken by a variable.

  • Constructor Details

    • In

      public In(IntVar x, IntDomain dom)
      It constructs an In constraint to restrict the domain of the variable.
      Parameters:
      x - variable x for which the restriction is applied.
      dom - the domain to which the variables domain is restricted.

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

    • getDefaultConsistencyPruningEvent

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

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

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

    • getDefaultNestedConsistencyPruningEvent

      protected int getDefaultNestedConsistencyPruningEvent()
      Overrides:
      getDefaultNestedConsistencyPruningEvent in class PrimitiveConstraint

    • getDefaultNestedNotConsistencyPruningEvent

      protected int getDefaultNestedNotConsistencyPruningEvent()
      Overrides:
      getDefaultNestedNotConsistencyPruningEvent in class PrimitiveConstraint

    • getDefaultNotConsistencyPruningEvent

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

    • toString

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

    • getGuideConstraint

      public Constraint getGuideConstraint()
      Description copied from class: Constraint
      It specifies a constraint which if imposed by search will enhance propagation of this constraint.
      Overrides:
      getGuideConstraint in class Constraint
      Returns:
      Constraint enhancing propagation of this constraint.

    • getGuideValue

      public int getGuideValue()
      Description copied from class: Constraint
      This function provides a value which if assigned to a variable returned by getGuideVariable() will enhance propagation of this constraint.
      Overrides:
      getGuideValue in class Constraint
      Returns:
      Value which is a base of enhancing constraint.

    • getGuideVariable

      public Var getGuideVariable()
      Description copied from class: Constraint
      This function provides a variable which assigned a value returned by will enhance propagation of this constraint.
      Overrides:
      getGuideVariable in class Constraint
      Returns:
      Variable which is a base of enhancing constraint.

    • supplyGuideFeedback

      public void supplyGuideFeedback(boolean feedback)
      Description copied from class: Constraint
      This function allows to provide a guide feedback. If constraint does not propose sufficiently good enhancing constraints it will be informed so it has a chance to reexamine its efforts.
      Overrides:
      supplyGuideFeedback in class Constraint
      Parameters:
      feedback - true if the guide was useful, false otherwise.