org.chocosolver.util.objects

Class StoredIndexedBipartiteSet

java.lang.Object

org.chocosolver.util.objects.StoredIndexedBipartiteSet

Direct Known Subclasses:

StoredIndexedBipartiteSetWithOffset

public class StoredIndexedBipartiteSet
extends Object

A stored list dedicated to positive integers and three operations : - iteration - removal of an element - check if an element is or not within the list It only requires a StoredInt to denote the first element of the list and proceeds by swapping element with the first one to remove them and incrementing the index of the first element. IT DOES NOT PRESERVE THE ORDER OF THE LIST

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StoredIndexedBipartiteSet.BipartiteSetIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected StoredIndexedBipartiteSet.BipartiteSetIterator	_cachedIterator
protected IndexedObject[]	idxToObjects If objects are added to the list, a mapping from their indexes is needed.
protected IStateInt	last The first element of the list
protected int[]	list The list of values
protected int[]	position The position of each element within the list.

Constructor Summary

Constructors

Constructor and Description
StoredIndexedBipartiteSet(IEnvironment environment, ArrayList<IndexedObject> values)
StoredIndexedBipartiteSet(IEnvironment environment, IndexedObject[] values)
StoredIndexedBipartiteSet(IEnvironment environment, int nbValues) Create a stored bipartite set with a size.
StoredIndexedBipartiteSet(IEnvironment environment, int[] values)

Method Summary

Methods

Modifier and Type	Method and Description
int[]	_getStructure() DO NOT USE : FOR MEMORY OPTIM ONLY
void	add(int i)
void	buildList(IEnvironment environment, int[] values)
void	clear()
boolean	contains(IndexedObject object)
boolean	contains(int object)
StoredIndexedBipartiteSet	duplicate(Solver solver)
int	findIndexOfInt(int a)
int	get(int index)
DisposableIntIterator	getIterator()
IndexedObject	getObject(int index)
void	increaseSize(int gap) Increase the number of value watched.
boolean	isEmpty()
String	pretty()
void	remove(IndexedObject object)
void	remove(int object)
void	removeLast()
int	set(int index, int val)
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

list

protected int[] list

The list of values

position

protected int[] position

The position of each element within the list. indexes[3] = k <=> list[k] = 3 we assume that elements ranges from 0 ... list.lenght in other words the elements must be indexed.

idxToObjects

protected IndexedObject[] idxToObjects

If objects are added to the list, a mapping from their indexes is needed. idxToObjects[i] = o <=> o.getObjectIdx() == i

last

protected IStateInt last

The first element of the list

_cachedIterator

protected StoredIndexedBipartiteSet.BipartiteSetIterator _cachedIterator

Constructor Detail

StoredIndexedBipartiteSet

public StoredIndexedBipartiteSet(IEnvironment environment,
                         int[] values)

Parameters:

environment - the environment

values: - a set of DIFFERENT positive integer values !

StoredIndexedBipartiteSet

public StoredIndexedBipartiteSet(IEnvironment environment,
                         IndexedObject[] values)

Parameters:

environment - the environment

values: - a set of IndexObjects which have different indexes !

StoredIndexedBipartiteSet

public StoredIndexedBipartiteSet(IEnvironment environment,
                         ArrayList<IndexedObject> values)

Parameters:

environment - the environment

values: - a set of IndexObjects which have different indexes !

StoredIndexedBipartiteSet

public StoredIndexedBipartiteSet(IEnvironment environment,
                         int nbValues)

Create a stored bipartite set with a size. Thus the value stored will go from 0 to nbValues.

Parameters:

environment - the environment

nbValues - nb values

Method Detail

buildList

public void buildList(IEnvironment environment,
             int[] values)

increaseSize

public final void increaseSize(int gap)

Increase the number of value watched. BEWARE: be sure your are correctly calling this method. It deletes everything already declared

Parameters:

gap - the gap the reach the expected size

size

public final int size()

isEmpty

public final boolean isEmpty()

add

public final void add(int i)

clear

public final void clear()

removeLast

public final void removeLast()

remove

public void remove(int object)

remove

public final void remove(IndexedObject object)

contains

public boolean contains(int object)

contains

public final boolean contains(IndexedObject object)

get

public final int get(int index)

getObject

public final IndexedObject getObject(int index)

set

public final int set(int index,
      int val)

getIterator

public final DisposableIntIterator getIterator()

pretty

public final String pretty()

findIndexOfInt

public final int findIndexOfInt(int a)

_getStructure

public final int[] _getStructure()

DO NOT USE : FOR MEMORY OPTIM ONLY

duplicate

public StoredIndexedBipartiteSet duplicate(Solver solver)