Class IntervalDomain

  • All Implemented Interfaces:
    java.lang.Cloneable
    Direct Known Subclasses:
    GCC.XDomain

    public class IntervalDomain
    extends IntDomain
    implements java.lang.Cloneable
    Defines interval of numbers which is part of FDV definition which consist of one or several intervals.
    Version:
    4.7
    • Field Detail

      • intervals

        public Interval[] intervals
        The values of the domain are encoded as a list of intervals.
      • size

        public int size
        It specifies number of intervals needed to encode the domain.
      • emptyDomain

        public static final IntervalDomain emptyDomain
        An empty domain, so no constant creation of empty domains is required.
      • generator

        private static final java.util.Random generator
    • Constructor Detail

      • IntervalDomain

        public IntervalDomain()
        Empty constructor, does not initialize anything.
      • IntervalDomain

        public IntervalDomain​(int size)
        It creates an empty domain, with at least specified number of places in an array list for intervals.
        Parameters:
        size - defines the initial size of an array storing the intervals.
      • IntervalDomain

        public IntervalDomain​(int min,
                              int max)
        It creates domain with all values between min and max.
        Parameters:
        min - defines the left bound of a domain.
        max - defines the right bound of a domain.
    • Method Detail

      • getPreviousDomain

        public IntDomain getPreviousDomain()
        Description copied from class: IntDomain
        It returns domain at earlier level at which the change has occurred.
        Specified by:
        getPreviousDomain in class IntDomain
        Returns:
        previous domain
      • unionAdapt

        public void unionAdapt​(Interval i)
        It adds interval of values to the domain. It adds at the end without checks for the correctness of domain representation.
        Overrides:
        unionAdapt in class IntDomain
        Parameters:
        i - Interval which needs to be added to the domain.
      • addLastElement

        public void addLastElement​(int i)
        It adds a value to the domain. It adds at the end without checks for the correctness of domain representation.
        Parameters:
        i - the element to be added as the lase element of the domain
      • addDom

        public void addDom​(IntDomain domain)
        It adds values as specified by the parameter to the domain. The input parameter can not be an empty set.
        Overrides:
        addDom in class IntDomain
        Parameters:
        domain - Domain which needs to be added to the domain.
      • unionAdapt

        public void unionAdapt​(int min,
                               int max)
        It adds all values between min and max to the domain.
        Specified by:
        unionAdapt in class IntDomain
        Parameters:
        min - the left bound of the interval being added.
        max - the right bound of the interval being added.
      • isIntersecting

        public boolean isIntersecting​(IntDomain domain)
        Checks if two domains intersect.
        Overrides:
        isIntersecting in class IntDomain
        Parameters:
        domain - the domain for which intersection is checked.
        Returns:
        true if domains are intersecting.
      • isIntersecting

        public boolean isIntersecting​(int min,
                                      int max)
        Description copied from class: IntDomain
        It checks if interval min..max intersects with current domain.
        Specified by:
        isIntersecting in class IntDomain
        Parameters:
        min - the left bound of the interval.
        max - the right bound of the interval.
        Returns:
        true if domain intersects with the specified interval.
      • clear

        public void clear()
        It removes all elements.
        Specified by:
        clear in class Domain
      • cloneLight

        public IntervalDomain cloneLight()
        It clones the domain object, only data responsible for encoding domain values is cloned. All other fields must be set separately.
        Specified by:
        cloneLight in class IntDomain
        Returns:
        It returns a clone of this domain.
      • contains

        public boolean contains​(IntDomain domain)
        It specifies if the current domain contains the domain given as a parameter. It assumes that input parameter does not represent an empty domain.
        Overrides:
        contains in class IntDomain
        Parameters:
        domain - for which we check if it is contained in the current domain.
        Returns:
        true if the supplied domain is cover by this domain.
      • complement

        public IntDomain complement()
        It creates a complement of a domain.
        Specified by:
        complement in class IntDomain
        Returns:
        it returns the complement of this domain.
      • contains

        public boolean contains​(int value)
        It checks if value belongs to the domain.
        Overrides:
        contains in class IntDomain
        Parameters:
        value - which is checked if it exists in the domain.
        Returns:
        true if value belongs to the domain.
      • nextValue

        public int nextValue​(int value)
        It gives next value in the domain from the given value (lexigraphical ordering). The provided value does not have to belong to the domain. If no value can be found then returns the same value.
        Specified by:
        nextValue in class IntDomain
        Parameters:
        value - it specifies the value after which a next value has to be found.
        Returns:
        next value after the specified one which belong to this domain.
      • div

        private int div​(int A,
                        int B)
      • valueEnumeration

        public ValueEnumeration valueEnumeration()
        It returns value enumeration of the domain values.
        Specified by:
        valueEnumeration in class IntDomain
        Returns:
        valueEnumeration which can be used to enumerate one by one value from this domain.
      • intervalEnumeration

        public IntervalEnumeration intervalEnumeration()
        It returns interval enumeration of the domain values.
        Specified by:
        intervalEnumeration in class IntDomain
        Returns:
        intervalEnumeration which can be used to enumerate intervals in this domain.
      • eq

        public boolean eq​(IntDomain domain)
        It checks if the domain is equal to the supplied domain.
        Overrides:
        eq in class IntDomain
        Parameters:
        domain - the domain which is compared to this domain.
        Returns:
        true if both domains contain the same elements, false otherwise.
      • getSize

        public int getSize()
        It returns the size of the domain.
        Specified by:
        getSize in class IntDomain
        Returns:
        number of elements in this domain.
      • intersect

        public IntDomain intersect​(IntDomain domain)
        It interesects current domain with the one given as a parameter.
        Specified by:
        intersect in class IntDomain
        Parameters:
        domain - domain with which the intersection needs to be computed.
        Returns:
        the intersection between supplied domain and this domain.
      • intersect

        public IntDomain intersect​(int min,
                                   int max)
        In intersects current domain with the domain min..max.
        Specified by:
        intersect in class IntDomain
        Parameters:
        min - the left bound of the interval (inclusive)
        max - the right bound of the interval (inclusive)
        Returns:
        the intersection between the specified interval and this domain.
      • subtract

        public IntDomain subtract​(int value)
        Description copied from class: IntDomain
        It intersects with the domain which is a complement of value.
        Overrides:
        subtract in class IntDomain
        Parameters:
        value - the value for which the complement is computed
        Returns:
        the domain which does not contain specified value.
      • isEmpty

        public boolean isEmpty()
        It returns true if given domain is empty.
        Specified by:
        isEmpty in class Domain
        Returns:
        true if the given domain is empty.
      • max

        public int max()
        It returns the maximum value in a domain.
        Specified by:
        max in class IntDomain
        Returns:
        the largest value present in the domain.
      • min

        public int min()
        It returns the minimum value in a domain.
        Specified by:
        min in class IntDomain
        Returns:
        the smallest value present in the domain.
      • multiply

        public IntDomain multiply​(int mul)
        {1..4} * 6 = {6, 12, 18, 24}
        Parameters:
        mul - the multiplier constant.
        Returns:
        the domain after multiplication.
      • removeInterval

        public void removeInterval​(int position)
        It removes the counter-th interval from the domain.
        Parameters:
        position - it specifies the position of the removed interval.
      • setDomain

        public void setDomain​(IntDomain domain)
        It sets the domain to the specified domain.
        Specified by:
        setDomain in class IntDomain
        Parameters:
        domain - the domain from which this domain takes all elements.
      • setDomain

        public void setDomain​(int min,
                              int max)
        It sets the domain to all values between min and max.
        Specified by:
        setDomain in class IntDomain
        Parameters:
        min - the left bound of the interval (inclusive).
        max - the right bound of the interval (inclusive).
      • singleton

        public boolean singleton()
        It returns true if given domain has only one element.
        Specified by:
        singleton in class Domain
        Returns:
        true if the domain contains only one element.
      • singleton

        public boolean singleton​(int c)
        It returns true if given domain has only one element equal c.
        Overrides:
        singleton in class IntDomain
        Parameters:
        c - the value to which the only element should be equal to.
        Returns:
        true if the domain contains only one element c.
      • subtract

        public IntDomain subtract​(IntDomain domain)
        It subtracts domain from current domain and returns the result.
        Overrides:
        subtract in class IntDomain
        Parameters:
        domain - the domain which is subtracted from this domain.
        Returns:
        the result of the subtraction.
      • subtract

        public IntervalDomain subtract​(int min,
                                       int max)
        It subtracts min..max from current domain and returns the result.
        Specified by:
        subtract in class IntDomain
        Parameters:
        min - the left bound of the interval (inclusive).
        max - the right bound of the interval (inclusive).
        Returns:
        the result of the subtraction.
      • union

        public IntDomain union​(IntDomain domain)
        It computes union of dom1 from dom2 and returns the result.
        Overrides:
        union in class IntDomain
        Parameters:
        domain - the domain for which the union is computed.
        Returns:
        the union of this domain with the supplied one.
      • union

        public IntDomain union​(int min,
                               int max)
        It computes union of current domain and an interval min..max;
        Overrides:
        union in class IntDomain
        Parameters:
        min - the left bound of the interval (inclusive).
        max - the right bound of the interval (inclusive).
        Returns:
        the union of this domain and the interval.
      • union

        public IntDomain union​(int value)
        It computes union of dom1 and value and returns the result.
        Overrides:
        union in class IntDomain
        Parameters:
        value - it specifies the value which is being added.
        Returns:
        domain which is a union of this one and the value.
      • toString

        public java.lang.String toString()
        It returns string description of the domain (only values in the domain).
        Specified by:
        toString in class Domain
      • toStringConstraints

        public java.lang.String toStringConstraints()
        It returns string description of the constraints attached to the domain.
        Specified by:
        toStringConstraints in class Domain
        Returns:
        the string description.
      • toStringFull

        public java.lang.String toStringFull()
        It returns complete string description containing all relevant information.
        Specified by:
        toStringFull in class Domain
        Returns:
        complete description of the domain.
      • inMin

        public void inMin​(int storeLevel,
                          Var var,
                          int min)
        It updates the domain according to the minimum value and stamp value. It informs the variable of a change if it occurred.
        Overrides:
        inMin in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        min - the minimum value to which the domain is updated.
      • inMax

        public void inMax​(int storeLevel,
                          Var var,
                          int max)
        It updates the domain according to the maximum value and stamp value. It informs the variable of a change if it occurred.
        Overrides:
        inMax in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        max - the maximum value to which the domain is updated.
      • in

        public void in​(int storeLevel,
                       Var var,
                       int min,
                       int max)
        It updates the domain to have values only within the interval min..max. The type of update is decided by the value of stamp. It informs the variable of a change if it occurred.
        Specified by:
        in in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        min - the minimum value to which the domain is updated.
        max - the maximum value to which the domain is updated.
      • in

        public void in​(int storeLevel,
                       Var var,
                       IntDomain domain)
        It updates the domain to have values only within the domain. The type of update is decided by the value of stamp. It informs the variable of a change if it occurred.
        Overrides:
        in in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        domain - the domain according to which the domain is updated.
      • noIntervals

        public int noIntervals()
        It returns the number intervals into which this domain is split.
        Specified by:
        noIntervals in class IntDomain
        Returns:
        the number of intervals in the domain.
      • intervalNo

        public int intervalNo​(int value)
        It specifies the position of the interval which contains specified value.
        Parameters:
        value - value for which an interval containing it is searched.
        Returns:
        the position of the interval containing the specified value.
      • getInterval

        public Interval getInterval​(int position)
        Description copied from class: IntDomain
        It returns required interval.
        Specified by:
        getInterval in class IntDomain
        Parameters:
        position - the position of the interval.
        Returns:
        the interval, or null if the required interval does not exist.
      • inComplement

        public void inComplement​(int storeLevel,
                                 Var var,
                                 int complement)
        It updates the domain to not contain the value complement. It informs the variable of a change if it occurred.
        Overrides:
        inComplement in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        complement - value which is removed from the domain if it belonged to the domain.
      • inComplement

        public void inComplement​(int storeLevel,
                                 Var var,
                                 int min,
                                 int max)
        Description copied from class: IntDomain
        It updates the domain so it does not contain the supplied interval. It informs the variable of a change if it occurred.
        Specified by:
        inComplement in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        min - the left bound of the interval (inclusive).
        max - the right bound of the interval (inclusive).
      • inShift

        public void inShift​(int storeLevel,
                            Var var,
                            IntDomain domain,
                            int shift)
        It updates the domain to contain the elements as specifed by the domain, which is shifted. E.g. {1..4} + 3 = 4..7
        Specified by:
        inShift in class IntDomain
        Parameters:
        storeLevel - level of the store at which the update occurs.
        var - variable for which this domain is used.
        domain - the domain according to which the domain is updated.
        shift - the shift which is used to shift the domain supplied as argument.
      • domainID

        public int domainID()
        It returns an unique identifier of the domain.
        Specified by:
        domainID in class Domain
        Returns:
        it returns an integer id of the domain.
      • isSparseRepresentation

        public boolean isSparseRepresentation()
        It specifies if the domain type is more suited to representing sparse domain.
        Specified by:
        isSparseRepresentation in class Domain
        Returns:
        true if sparse, false otherwise.
      • isNumeric

        public boolean isNumeric()
        It specifies if domain is a finite domain of numeric values (integers).
        Specified by:
        isNumeric in class Domain
        Returns:
        true if domains contains numeric values.
      • leftElement

        public int leftElement​(int intervalNo)
        It returns the left most element of the given interval.
        Overrides:
        leftElement in class IntDomain
        Parameters:
        intervalNo - the interval number.
        Returns:
        the left bound of the specified interval.
      • rightElement

        public int rightElement​(int intervalNo)
        It returns the left most element of the given interval.
        Overrides:
        rightElement in class IntDomain
        Parameters:
        intervalNo - the interval number.
        Returns:
        the right bound of the specified interval.
      • removeLevel

        public void removeLevel​(int level,
                                Var var)
        It removes a level of a domain. If domain is represented as a list of domains, the domain pointer within variable will be updated.
        Specified by:
        removeLevel in class Domain
        Parameters:
        level - the level which is being removed.
        var - the variable to which this domain belonged to.
      • recentDomainPruning

        public IntDomain recentDomainPruning​(int storeLevel)
        It removes a constraint from a domain, it should only be called by removeConstraint function of Variable object.
        Specified by:
        recentDomainPruning in class IntDomain
        Parameters:
        storeLevel - the current store level.
        Returns:
        emptyDomain if domain did not change at current level, or the set of values which have been removed at current level.
      • sizeConstraintsOriginal

        public int sizeConstraintsOriginal()
        It returns all constraints which are associated with variable, even the ones which are already satisfied.
        Specified by:
        sizeConstraintsOriginal in class Domain
        Returns:
        the number of constraints attached to the original domain of the variable associated with this domain.
      • previousValue

        public int previousValue​(int value)
        Description copied from class: IntDomain
        It gives previous value in the domain from the given one (lexigraphical ordering). If no value can be found then returns the same value.
        Specified by:
        previousValue in class IntDomain
        Parameters:
        value - before which a value is seeked for.
        Returns:
        it returns the value before the one specified as a parameter.
      • checkInvariants

        public java.lang.String checkInvariants()
        It is a function to check if the object is in consistent state.
        Specified by:
        checkInvariants in class Domain
        Returns:
        String describing the violated invariant, null if no invariant is violated.
      • unionAdapt

        public void unionAdapt​(int value)
        Description copied from class: IntDomain
        It adds a values to the domain.
        Overrides:
        unionAdapt in class IntDomain
        Parameters:
        value - value being added to the domain.
      • subtractAdapt

        public void subtractAdapt​(int value)
        Description copied from class: IntDomain
        It removes value from the domain. It adapts current (this) domain.
        Specified by:
        subtractAdapt in class IntDomain
        Parameters:
        value - the value for which the complement is computed
      • subtractAdapt

        public void subtractAdapt​(int minValue,
                                  int maxValue)
        Description copied from class: IntDomain
        It removes all values between min and max to the domain.
        Specified by:
        subtractAdapt in class IntDomain
        Parameters:
        minValue - the left bound of the interval being removed.
        maxValue - the right bound of the interval being removed.
      • intersectAdapt

        public int intersectAdapt​(IntDomain domain)
        Description copied from class: IntDomain
        It computes an intersection with a given domain and stores it in this domain.
        Specified by:
        intersectAdapt in class IntDomain
        Parameters:
        domain - domain with which the intersection is being computed.
        Returns:
        type of event which has occurred due to the operation.
      • unionAdapt

        public int unionAdapt​(IntDomain union)
        Description copied from class: IntDomain
        It computes a union between this domain and the domain provided as a parameter. This domain is changed to reflect the result.
        Overrides:
        unionAdapt in class IntDomain
        Parameters:
        union - the domain with is used for the union operation with this domain.
        Returns:
        it returns information about the pruning event which has occurred due to this operation.
      • intersectAdapt

        public int intersectAdapt​(int min,
                                  int max)
        Description copied from class: IntDomain
        It computes an intersection of this domain with an interval [min..max]. It adapts this domain to the result of the intersection.
        Specified by:
        intersectAdapt in class IntDomain
        Parameters:
        min - the minimum value of the interval used in the intersection computation.
        max - the maximum value of the interval used in the intersection computation.
        Returns:
        it returns information about the pruning event which has occurred due to this operation.
      • sizeOfIntersection

        public int sizeOfIntersection​(IntDomain domain)
        Description copied from class: IntDomain
        It computes the size of the intersection between this domain and the domain supplied as a parameter.
        Overrides:
        sizeOfIntersection in class IntDomain
        Parameters:
        domain - the domain with which the intersection is computed.
        Returns:
        the size of the intersection.
      • getElementAt

        public int getElementAt​(int index)
        Description copied from class: IntDomain
        It access the element at the specified position.
        Specified by:
        getElementAt in class IntDomain
        Parameters:
        index - the position of the element, indexing starts from 0.
        Returns:
        the value at a given position in the domain.
      • getRandomValue

        public int getRandomValue()
        Description copied from class: IntDomain
        It returns a random value from the domain.
        Overrides:
        getRandomValue in class IntDomain
        Returns:
        random value.
      • contains

        public boolean contains​(int min,
                                int max)
        Description copied from class: IntDomain
        It checks if an interval min..max belongs to the domain.
        Specified by:
        contains in class IntDomain
        Parameters:
        min - the minimum value of the interval being checked
        max - the maximum value of the interval being checked
        Returns:
        true if value belongs to the domain.