org.chocosolver.util.objects.setDataStructures

Interface ISet

All Superinterfaces:

Serializable

All Known Implementing Classes:

Set_2LinkedList, Set_Array, Set_BitSet, Set_Copy, Set_Full, Set_LinkedList, Set_Std_2LinkedList, Set_Std_Array, Set_Std_BitSet, Set_Std_LinkedList, Set_Std_LinkedList_NoRecycling, Set_Std_Swap_Array, Set_Std_Swap_Hash, Set_Swap, Set_Swap_Array, Set_Swap_Hash, Set_Trail

public interface ISet
extends Serializable

Class representing a set of POSITIVE integers (typically graph nodes) Created by IntelliJ IDEA.

Since:

9 feb. 2011

Author:

chameau, Jean-Guillaume Fages

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

Method Detail

add

boolean add(int element)

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

Parameters:

element - element to add

Returns:

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

remove

boolean remove(int element)

Remove the first occurence of element from the set

Parameters:

element - element to add

Returns:

true iff element was in the set and has been removed

contain

boolean contain(int element)

Test the existence of element in the set

Parameters:

element - element to add

Returns:

true iff the set contains element

isEmpty

boolean isEmpty()

Returns:

true iff the set is empty

getSize

int getSize()

Returns:

the number of elements in the set

clear

void clear()

Remove all elements from the set

getFirstElement

int getFirstElement()

Returns:

the first element of the set, -1 empty set

getNextElement

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)

Returns:

the next element of the set

getSetType

SetType getSetType()

Returns:

the implementation type of this set

toArray

int[] toArray()

Copies the set in an array if integers

Returns:

an array containing every integer of the set

getMaxSize

int getMaxSize()

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

Returns:

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