Class SumWeight

All Implemented Interfaces:
RemoveLevelLate, SatisfiedPresent, UsesQueueVariable

public class SumWeight extends Constraint implements UsesQueueVariable, SatisfiedPresent, RemoveLevelLate
  • Field Details

    • idNumber

      static final AtomicInteger idNumber
    • list

      protected final IntVar[] list
      It specifies a list of variables being summed.
    • weights

      protected final long[] weights
      It specifies a list of weights associated with the variables being summed.
    • equalTo

      protected final long equalTo
      It specifies value to which SumWeight is equal to.
    • sumGrounded

      private TimeStamp<Long> sumGrounded
      The sum of grounded variables.
    • nextGroundedPosition

      private TimeStamp<Integer> nextGroundedPosition
      The position for the next grounded variable.
    • variableQueue

      LinkedHashSet<IntVar> variableQueue
    • lMin

      private long lMin
    • lMax

      private long lMax
    • lMinArray

      private long[] lMinArray
    • lMaxArray

      private long[] lMaxArray
    • positionMaping

      private Map<Var,Integer> positionMaping
    • backtrackHasOccured

      private boolean backtrackHasOccured
  • Constructor Details

    • SumWeight

      public SumWeight(IntVar[] list, int[] weights, IntVar sum)
      SumWeight constraint implements the weighted summation over several variables.
      Parameters:
      list - the list of varibales
      weights - the list of weights
      sum - the resulting sum
    • SumWeight

      public SumWeight(IntVar[] list, int[] weights, int equalTo)
      SumWeight constraint implements the weighted summation over several variables.
      Parameters:
      list - the list of varibales
      weights - the list of weights
      equalTo - the value to which SumWeight is equal to.
    • SumWeight

      private SumWeight(IntVar[] list, int[] weights, IntVar sum, int equalTo)
    • SumWeight

      public SumWeight(List<? extends IntVar> variables, List<Integer> weights, IntVar sum)
      It constructs the constraint SumWeight.
      Parameters:
      variables - variables which are being multiplied by weights.
      weights - weight for each variable.
      sum - variable containing the sum of weighted variables.
  • Method Details

    • removeLevelLate

      public void removeLevelLate(int level)
      Description copied from interface: RemoveLevelLate
      This function is called in case of the backtrack. It is called after all timestamps, variables, mutablevariables have reverted to their values *after* removing the level.
      Specified by:
      removeLevelLate in interface RemoveLevelLate
      Parameters:
      level - the level which is being removed.
    • 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
    • impose

      public void impose(Store store)
      Description copied from class: Constraint
      It imposes the constraint in a given store.
      Overrides:
      impose in class Constraint
      Parameters:
      store - the constraint store to which the constraint is imposed to.
    • 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.
    • treatChangedVariables

      private void treatChangedVariables()
    • 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.
    • checkForOverflow

      void checkForOverflow()
    • toString

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