Class SumInt

All Implemented Interfaces:
SatisfiedPresent, StoreAware

public class SumInt extends PrimitiveConstraint
SumInt constraint implements the summation over several variables.

sum(i in 1..N)(xi) = sum

It provides the sum from all variables on the list.

This implementaiton is based on "Bounds Consistency Techniques for Long Linear Constraints" by Warwick Harvey and Joachim Schimpf

Version:
4.8
  • Field Details

    • store

      Store store
    • idNumber

      static AtomicInteger idNumber
    • reified

      boolean reified
    • eq

      static final byte eq
      Defines relations
      See Also:
    • le

      static final byte le
      Defines relations
      See Also:
    • lt

      static final byte lt
      Defines relations
      See Also:
    • ne

      static final byte ne
      Defines relations
      See Also:
    • gt

      static final byte gt
      Defines relations
      See Also:
    • ge

      static final byte ge
      Defines relations
      See Also:
    • negRel

      static final byte[] negRel
      Defines negated relations
    • relationType

      public byte relationType
      It specifies what relations is used by this constraint
    • x

      IntVar[] x
      It specifies a list of variables being summed.
    • sum

      IntVar sum
      It specifies variable for the overall sum.
    • l

      int l
      It specifies the number of variables.
    • I

      long[] I
      It specifies "variability" of each variable
    • sumXmin

      long sumXmin
      It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
    • sumXmax

      long sumXmax
      It specifies sum of lower bounds (min values) and sum of upper bounds (max values)
    • guideValue

      int guideValue
  • Constructor Details

    • SumInt

      @Deprecated public SumInt(Store store, IntVar[] list, String rel, IntVar sum)
      Deprecated.
      SumInt constraint does not use Store parameter any longer.
      Parameters:
      store - current store
      list - variables which are being multiplied by weights.
      rel - the relation, one of "==", "<", ">", "<=", ">=", "!="
      sum - variable containing the sum of weighted variables.
    • SumInt

      @Deprecated public SumInt(Store store, List<? extends IntVar> variables, String rel, IntVar sum)
      Deprecated.
      SumInt constraint does not use Store parameter any longer.
      It constructs the constraint SumInt.
      Parameters:
      store - current store
      variables - variables which are being multiplied by weights.
      rel - the relation, one of "==", "<", ">", "<=", ">=", "!="
      sum - variable containing the sum of weighted variables.
    • SumInt

      public SumInt(IntVar[] list, String rel, IntVar sum)
      Parameters:
      list - variables which are being multiplied by weights.
      rel - the relation, one of "==", "<", ">", "<=", ">=", "!="
      sum - variable containing the sum of weighted variables.
    • SumInt

      public SumInt(List<? extends IntVar> variables, String rel, IntVar sum)
      It constructs the constraint SumInt.
      Parameters:
      variables - variables which are being multiplied by weights.
      rel - the relation, one of "==", "<", ">", "<=", ">=", "!="
      sum - variable containing the sum of weighted variables.
  • 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.
    • 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.
    • propagate

      public void propagate(int rel)
    • getDefaultConsistencyPruningEvent

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

      public void impose(Store store)
      Description copied from class: Constraint
      It imposes the constraint in a given store.
      Overrides:
      impose in class PrimitiveConstraint
      Parameters:
      store - the constraint store to which the constraint is imposed to.
    • computeInit

      private void computeInit()
    • pruneLtEq

      private void pruneLtEq(long b)
    • pruneGtEq

      private void pruneGtEq(long b)
    • pruneNeq

      private void pruneNeq()
    • pruneMin

      private boolean pruneMin(IntVar x, long min)
    • pruneMax

      private boolean pruneMax(IntVar x, long max)
    • pruneNe

      private boolean pruneNe(IntVar x, long min, long max)
    • satisfiedEq

      public boolean satisfiedEq()
    • satisfiedNeq

      public boolean satisfiedNeq()
    • satisfiedLtEq

      public boolean satisfiedLtEq(int b)
    • satisfiedGtEq

      public boolean satisfiedGtEq(int b)
    • 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.
    • entailed

      private boolean entailed(int rel)
    • relation

      public byte relation(String r)
    • rel2String

      public String rel2String()
    • 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.