Package org.jacop.constraints

Class XorBool

    • Field Detail

      • idNumber

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

      • x

        public final IntVar[] x
        It specifies variables x for the constraint.

    • Constructor Detail

      • XorBool

        public XorBool​(IntVar[] x,
               IntVar y)
        It constructs constraint (x_0 xor x_1 xor ... xor x_n ) <=> y.
        Parameters:
        x - variables x.
        y - variable y.

    • Method Detail

      • checkInvariants

        public java.lang.String checkInvariants()
        It checks invariants required by the constraint. Namely that boolean variables have boolean domain.
        Returns:
        the string describing the violation of the invariant, null otherwise.

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

      • getNestedPruningEvent

        public int getNestedPruningEvent​(Var var,
                                 boolean mode)
        Description copied from class: PrimitiveConstraint
        It retrieves the pruning event for which any composed constraint which uses this constraint should be evaluated. This events are the ones which can change satisfied status?
        Overrides:
        getNestedPruningEvent in class PrimitiveConstraint
        Parameters:
        var - for which pruning event is retrieved
        mode - decides if pruning event for consistency or nonconsistency is required.
        Returns:
        pruning event associated with the given variable for a given consistency mode.

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

      • 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