Module org.maxicp

Package org.maxicp.cp.engine.core

Class SparseSetDomain

java.lang.Object

org.maxicp.cp.engine.core.SparseSetDomain

All Implemented Interfaces:

IntDomain

public class SparseSetDomain
extends Object
implements IntDomain

Implementation of a domain with a sparse-set

Constructor Summary

Constructors

Constructor	Description
SparseSetDomain(StateManager sm, int min, int max)

Method Summary

Modifier and Type	Method	Description
boolean	contains(int v)	Checks if the specified value belongs to the domain.
int	fillArray(int[] dest)	Copies the values of the domain into an array.
int	fillDeltaArray(int oldMin, int oldMax, int oldSize, int[] arr)
boolean	isSingleton()	Checks if the domain contains a single element.
int	max()	Returns the maximum value of the domain.
int	min()	Returns the minimum value of the domain.
void	remove(int v, IntDomainListener l)	Removes a value from the domain and notifies appropriately the listener.
void	removeAbove(int value, IntDomainListener l)	Removes every value larger than the specified value from the domain.
void	removeAllBut(int v, IntDomainListener l)	Removes every value from the domain except the specified one.
void	removeBelow(int value, IntDomainListener l)	Removes every value less than the specified value from the domain.
int	size()	Returns the cardinality of the domain.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SparseSetDomain

public SparseSetDomain(StateManager sm,
 int min,
 int max)

Method Details

fillArray

public int fillArray(int[] dest)

Description copied from interface: IntDomain

Copies the values of the domain into an array.

Specified by:

fillArray in interface IntDomain

Parameters:

dest - an array large enough dest.length >= size()

Returns:

the size of the domain and dest[0,...,size-1] contains the values in the domain in an arbitrary order

min

public int min()

Description copied from interface: IntDomain

Returns the minimum value of the domain.

Specified by:

min in interface IntDomain

Returns:

the minimum value of the domain

max

public int max()

Description copied from interface: IntDomain

Returns the maximum value of the domain.

Specified by:

max in interface IntDomain

Returns:

the maximum value of the domain

size

public int size()

Description copied from interface: IntDomain

Returns the cardinality of the domain.

Specified by:

size in interface IntDomain

Returns:

the cardinality value of the domain

contains

public boolean contains(int v)

Description copied from interface: IntDomain

Checks if the specified value belongs to the domain.

Specified by:

contains in interface IntDomain

Parameters:

v - the value to be tested

Returns:

true if v belongs to the domain, false otherwise

isSingleton

public boolean isSingleton()

Description copied from interface: IntDomain

Checks if the domain contains a single element.

Specified by:

isSingleton in interface IntDomain

Returns:

true if the domain contains a single element, false otherwise

remove

public void remove(int v,
 IntDomainListener l)

Description copied from interface: IntDomain

Removes a value from the domain and notifies appropriately the listener.

Specified by:

remove in interface IntDomain

Parameters:

v - the value to be removed

l - the methods of the listener are notified as follows:

• IntDomainListener.change() is called if v belongs to the domain
• IntDomainListener.changeMax() is called if v is equal to the maximum value
• IntDomainListener.changeMin() is called if v is equal to the minimum value
• IntDomainListener.bind() is called if v belongs to the domain and after its removal the domain has a single value
• IntDomainListener.empty() is called if v is the last value in the domain i.e. the domain is empty after this operation

removeAllBut

public void removeAllBut(int v,
 IntDomainListener l)

Description copied from interface: IntDomain

Removes every value from the domain except the specified one.

Specified by:

removeAllBut in interface IntDomain

Parameters:

v - the value to be kept

l - the methods of the listener are notified as follows:

• IntDomainListener.change() is called if some value is removed during the operation
• IntDomainListener.changeMax() is called if v is not equal to the maximum value
• IntDomainListener.changeMin() is called if v is not equal to the minimum value
• IntDomainListener.bind() is called if v belongs to the domain and after its removal the domain has a single value
• IntDomainListener.empty() is called if v is not in the domain i.e. the domain is empty after this operation

removeBelow

public void removeBelow(int value,
 IntDomainListener l)

Description copied from interface: IntDomain

Removes every value less than the specified value from the domain.

Specified by:

removeBelow in interface IntDomain

Parameters:

value - the value such that all the values less than v are removed

l - the methods of the listener are notified as follows:

• IntDomainListener.change() is called if some value is removed during the operation
• IntDomainListener.changeMax() is called if v is is larger than the minimum value
• IntDomainListener.bind() is called if v is equal to the maximum value
• IntDomainListener.empty() is called if v is larger than the maximum value i.e. the domain is empty after this operation

removeAbove

public void removeAbove(int value,
 IntDomainListener l)

Description copied from interface: IntDomain

Removes every value larger than the specified value from the domain.

Specified by:

removeAbove in interface IntDomain

Parameters:

value - the value such that all the values larger than v are removed

l - the methods of the listener are notified as follows:

• IntDomainListener.change() is called if some value is removed during the operation
• IntDomainListener.changeMax() is called if v is is less than the maximum value
• IntDomainListener.bind() is called if v is equal to the minimum value
• IntDomainListener.empty() is called if v is less than the minimum value i.e. the domain is empty after this operation

toString

public String toString()

Specified by:

toString in interface IntDomain

Overrides:

toString in class Object

fillDeltaArray

public int fillDeltaArray(int oldMin,
 int oldMax,
 int oldSize,
 int[] arr)

Specified by:

fillDeltaArray in interface IntDomain