org.chocosolver.util.objects.setDataStructures

Class Set_Trail

java.lang.Object

org.chocosolver.util.objects.setDataStructures.Set_Trail

All Implemented Interfaces:

Serializable, ISet

public class Set_Trail
extends Object
implements ISet

Backtrable set

Since:

Nov 2012

Author:

Jean-Guillaume Fages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Set_Trail(EnvironmentTrailing environment, ISet set)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(int element) Add element to the set Does not guaranty there is no duplications
void	clear() Remove all elements from the set
boolean	contain(int element) Test the existence of element in the set
int	getFirstElement()
int	getMaxSize() Gets the maximum size of the set, or -1 if it is unbounded.
int	getNextElement() enables to iterate over the set should be used as follow : for(int i=getFirstElement(); i>=0; i = getNextElement()){ ... } The use of getFirstElement() is necessary to ensure a complete iteration WARNING cannot encapsulate two for loops (copy the set for that)
SetType	getSetType()
int	getSize()
boolean	isEmpty()
boolean	remove(int element) Remove the first occurence of element from the set
int[]	toArray() Copies the set in an array if integers
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Set_Trail

public Set_Trail(EnvironmentTrailing environment,
         ISet set)

Method Detail

add

public boolean add(int element)

Description copied from interface: ISet

Add element to the set Does not guaranty there is no duplications

Specified by:

add in interface ISet

Parameters:

element - element to add

Returns:

true iff element was not in the set and has been added

remove

public boolean remove(int element)

Description copied from interface: ISet

Remove the first occurence of element from the set

Specified by:

remove in interface ISet

Parameters:

element - element to add

Returns:

true iff element was in the set and has been removed

contain

public boolean contain(int element)

Description copied from interface: ISet

Test the existence of element in the set

Specified by:

contain in interface ISet

Parameters:

element - element to add

Returns:

true iff the set contains element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ISet

Returns:

true iff the set is empty

getSize

public int getSize()

Specified by:

getSize in interface ISet

Returns:

the number of elements in the set

clear

public void clear()

Description copied from interface: ISet

Remove all elements from the set

Specified by:

clear in interface ISet

getFirstElement

public int getFirstElement()

Specified by:

getFirstElement in interface ISet

Returns:

the first element of the set, -1 empty set

getNextElement

public int getNextElement()

Description copied from interface: ISet

enables to iterate over the set

should be used as follow :

for(int i=getFirstElement(); i>=0; i = getNextElement()){ ... }

The use of getFirstElement() is necessary to ensure a complete iteration

WARNING cannot encapsulate two for loops (copy the set for that)

Specified by:

getNextElement in interface ISet

Returns:

the next element of the set

toString

public String toString()

Overrides:

toString in class Object

getSetType

public SetType getSetType()

Specified by:

getSetType in interface ISet

Returns:

the implementation type of this set

toArray

public int[] toArray()

Description copied from interface: ISet

Copies the set in an array if integers

Specified by:

toArray in interface ISet

Returns:

an array containing every integer of the set

getMaxSize

public int getMaxSize()

Description copied from interface: ISet

Gets the maximum size of the set, or -1 if it is unbounded.

Specified by:

getMaxSize in interface ISet

Returns:

the maximum size of the set, or -1 if it is unbounded