Package org.jacop.constraints

Class SumBool

  • All Implemented Interfaces:
    SatisfiedPresent, StoreAware
    public class SumBool
extends PrimitiveConstraint
    SumBool constraint implements the summation over several 0/1 variables.

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

    It provides the sum from all variables on the list.

    Version:
    4.8

    • Field Detail

      • idNumber

        static final java.util.concurrent.atomic.AtomicInteger idNumber

      • reified

        boolean reified

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

    • Constructor Detail

      • SumBool

        @Deprecated
public SumBool​(Store store,
               IntVar[] list,
               java.lang.String rel,
               IntVar sum)
        Deprecated.
        SumBool 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.

      • SumBool

        @Deprecated
public SumBool​(Store store,
               java.util.List<? extends IntVar> variables,
               java.lang.String rel,
               IntVar sum)
        Deprecated.
        SumBool constraint does not use Store parameter any longer.
        It constructs the constraint SumBool.
        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.

      • SumBool

        public SumBool​(IntVar[] list,
               java.lang.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.

      • SumBool

        public SumBool​(java.util.List<? extends IntVar> variables,
               java.lang.String rel,
               IntVar sum)
        It constructs the constraint SumBool.
        Parameters:
        variables - variables which are being multiplied by weights.
        rel - the relation, one of "==", "<", ">", "<=", ">=", "!="
        sum - variable containing the sum of weighted variables.

    • Method Detail

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

      • prune

        private void prune​(byte rel)

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

      • 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​(byte rel)

      • relation

        public byte relation​(java.lang.String r)

      • rel2String

        public java.lang.String rel2String()

      • filterAndOverflow

        IntVar[] filterAndOverflow​(IntVar[] x)

      • toString

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