org.chocosolver.memory.structure

Class IndexedBipartiteSet

java.lang.Object

org.chocosolver.memory.IStateIntVector

org.chocosolver.memory.structure.IndexedBipartiteSet

All Implemented Interfaces:

Serializable

public class IndexedBipartiteSet
extends IStateIntVector

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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.

Fields inherited from class org.chocosolver.memory.IStateIntVector

elementData, environment, MIN_CAPACITY, size

Constructor Summary

Constructors

Constructor and Description
IndexedBipartiteSet(IEnvironment environment, int nbValues) Create a stored bipartite set with a size.
IndexedBipartiteSet(IEnvironment environment, int[] values)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int i) Adds a new search at the end of the vector.
void	buildList(IEnvironment environment, int[] values)
void	clear()
boolean	contains(int object)
int	findIndexOfInt(int a)
int	get(int index) Returns the indexth element of the vector.
void	increaseSize(int gap) Increase the number of value watched.
boolean	isEmpty() Checks if the vector is empty.
String	pretty()
int	quickGet(int index) access an element without any bound check
int	quickSet(int index, int val) Assigns a new value val to the element indexth and return the old value without bound check
void	remove(int object) Removes an int.
void	removeLast() removes the search at the end of the vector.
int	set(int index, int val) Assigns a new value val to the element index and returns the old value
int	size() Returns the current size of the stored search vector.

Methods inherited from class org.chocosolver.memory.IStateIntVector

deepCopy, rangeCheck

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.

last

protected IStateInt last

The first element of the list

Constructor Detail

IndexedBipartiteSet

public IndexedBipartiteSet(IEnvironment environment,
                   int nbValues)

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

Parameters:

environment - backtrable environment

nbValues - capacity

IndexedBipartiteSet

public IndexedBipartiteSet(IEnvironment environment,
                   int[] 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()

Description copied from class: IStateIntVector

Returns the current size of the stored search vector.

Overrides:

size in class IStateIntVector

isEmpty

public final boolean isEmpty()

Description copied from class: IStateIntVector

Checks if the vector is empty.

Overrides:

isEmpty in class IStateIntVector

add

public final void add(int i)

Description copied from class: IStateIntVector

Adds a new search at the end of the vector.

Specified by:

add in class IStateIntVector

Parameters:

i - The search to add.

clear

public final void clear()

removeLast

public final void removeLast()

Description copied from class: IStateIntVector

removes the search at the end of the vector. does nothing when called on an empty vector

Specified by:

removeLast in class IStateIntVector

remove

public void remove(int object)

Description copied from class: IStateIntVector

Removes an int.

Specified by:

remove in class IStateIntVector

Parameters:

object - The search to remove.

contains

public boolean contains(int object)

Overrides:

contains in class IStateIntVector

get

public final int get(int index)

Description copied from class: IStateIntVector

Returns the indexth element of the vector.

Overrides:

get in class IStateIntVector

quickGet

public final int quickGet(int index)

Description copied from class: IStateIntVector

access an element without any bound check

Overrides:

quickGet in class IStateIntVector

Parameters:

index - index of the element

Returns:

the value

set

public final int set(int index,
      int val)

Description copied from class: IStateIntVector

Assigns a new value val to the element index and returns the old value

Specified by:

set in class IStateIntVector

quickSet

public final int quickSet(int index,
           int val)

Description copied from class: IStateIntVector

Assigns a new value val to the element indexth and return the old value without bound check

Specified by:

quickSet in class IStateIntVector

Parameters:

index - the index where the value is modified

val - the new value

Returns:

the old value

pretty

public final String pretty()

findIndexOfInt

public final int findIndexOfInt(int a)