Class PropSort

  • All Implemented Interfaces:
    Comparable<Propagator>, ICause, Identity

    public final class PropSort
    extends Propagator<IntVar>
    SortingConstraint is a constraint that ensures that a vector is the sorted version of a second one. The filtering algorithm is the version of Kurt Mehlhorn and Sven Thiel, from CP'00 (Faster algorithms for Bound-Consistency of the Sortedness and the Alldifferent Constraint).
    Since:
    17 apr. 2014
    Author:
    Sylvain Bouveret (initial code), Charles Prud'homme (migration to choco3, debugging)
    • Constructor Detail

      • PropSort

        public PropSort​(IntVar[] x,
                        IntVar[] y)
        Creates a new PropSort instance.
        Parameters:
        x - the first array of integer variables
        y - the second array of integer variables
    • Method Detail

      • propagate

        public void propagate​(int evtmask)
                       throws ContradictionException
        Description copied from class: Propagator
        Call the main filtering algorithm to apply to the Domain of the Variable objects. It considers the current state of this objects to remove some values from domains and/or instantiate some variables. Calling this method is done from 2 (and only 2) steps:
        - at the initial propagation step,
        - when involved in a reified constraint.
        It should initialized the internal data structure and apply filtering algorithm from scratch.
        Specified by:
        propagate in class Propagator<IntVar>
        Parameters:
        evtmask - type of propagation event this must consider.
        Throws:
        ContradictionException - when a contradiction occurs, like domain wipe out or other incoherencies.
      • isEntailed

        public ESat isEntailed()
        Description copied from class: Propagator
        Check wether this is entailed according to the current state of its internal structure. At least, should check the satisfaction of this (when all is instantiated).
        Specified by:
        isEntailed in class Propagator<IntVar>
        Returns:
        ESat.TRUE if entailed, ESat.FALSE if not entailed, ESat.UNDEFINED if unknown