Class CardAeqX

All Implemented Interfaces:
SatisfiedPresent

public class CardAeqX extends Constraint implements SatisfiedPresent
The set cardinality constraint.
Version:
3.1
  • Field Details

    • idNumber

      static AtomicInteger idNumber
    • a

      public SetVar a
      It specifies set variable a which is being restricted.
    • cardinality

      public IntVar cardinality
      It specifies integer variable c specifying the possible cardinality of set variable a.
  • Constructor Details

    • CardAeqX

      public CardAeqX(SetVar a, IntVar cardinality)
      It constructs a cardinality constraint to restrict the number of elements in the set assigned to set variable a.
      Parameters:
      a - variable that is restricted to have the cardinality c.
      cardinality - the variable specifying the possible values for cardinality of set variable a.
  • 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.
    • getConsistencyPruningEvent

      public int getConsistencyPruningEvent(Var var)
      Description copied from class: Constraint
      It retrieves the pruning event which causes reevaluation of the constraint.
      Overrides:
      getConsistencyPruningEvent in class Constraint
      Parameters:
      var - variable for which pruning event is retrieved
      Returns:
      it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)
    • getDefaultConsistencyPruningEvent

      public int getDefaultConsistencyPruningEvent()
      Specified by:
      getDefaultConsistencyPruningEvent in class Constraint
    • 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