org.chocosolver.util.objects.setDataStructures.bitset

Class Set_BitSet

java.lang.Object

org.chocosolver.util.objects.setDataStructures.bitset.Set_BitSet

All Implemented Interfaces:

Iterable<Integer>, ISet

Direct Known Subclasses:

IntIterableBitSet

public class Set_BitSet
extends Object
implements ISet

BitSet implementation for a set of integers Supports negative numbers when using int... constructor

Author:

Jean-Guillaume Fages, Xavier Lorca

Field Summary

Fields

Modifier and Type	Field and Description
protected int	card
protected int	offset
protected BitSet	values

Constructor Summary

Constructors

Constructor and Description
Set_BitSet(int offSet) Creates an empty bitset having numbers greater or equal than offSet (possibly < 0)

Method Summary

Modifier and Type	Method and Description
boolean	add(int element) Add element to the set
void	clear() Remove all elements from the set
boolean	contains(int element) Test the existence of element in the set
SetType	getSetType()
ISetIterator	iterator() Use the following loop to iterate over this set without autoboxing.
int	max()
int	min()
ISetIterator	newIterator() Creates a new iterator object, for nested loops only.
boolean	remove(int element) Remove the first occurrence of element from the set
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.chocosolver.util.objects.setDataStructures.ISet

isEmpty, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

card

protected int card

offset

protected int offset

values

protected BitSet values

Constructor Detail

Set_BitSet

public Set_BitSet(int offSet)

Creates an empty bitset having numbers greater or equal than offSet (possibly < 0)

Parameters:

offSet - minimum value in the set

Method Detail

iterator

public ISetIterator iterator()

Description copied from interface: ISet

Use the following loop to iterate over this set without autoboxing. // more readable but with autoboxing for(int value:set){ ... } // more verbose but without autoboxing ISetIterator iter = set.primitiveIterator(); while(iter.hasNext()){ int k = iter.next(); ... } Do not use this iterator to make nested loops over ISet (prefer ISet.newIterator())

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface ISet

Returns:

the default iterator (singleton) of this set

newIterator

public ISetIterator newIterator()

Description copied from interface: ISet

Creates a new iterator object, for nested loops only.

Specified by:

newIterator in interface ISet

Returns:

a new iterator for this set

add

public boolean add(int element)

Description copied from interface: ISet

Add element to the set

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 occurrence 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

contains

public boolean contains(int element)

Description copied from interface: ISet

Test the existence of element in the set

Specified by:

contains in interface ISet

Parameters:

element - element to add

Returns:

true iff the set contains element

size

public int size()

Specified by:

size 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

min

public int min()

Specified by:

min in interface ISet

Returns:

the smallest element in the set throws an exception if the set is empty Time complexity is linear for BIPARTITESET and LINKED_LIST (constant time otherwise)

max

public int max()

Specified by:

max in interface ISet

Returns:

the largest element in the set throws an exception if the set is empty Time complexity is linear for BIPARTITESET and LINKED_LIST (constant time otherwise)

getSetType

public SetType getSetType()

Specified by:

getSetType in interface ISet

Returns:

the implementation type of this set

toString

public String toString()

Overrides:

toString in class Object