org.dice_research.topicmodeling.commons.collections

Class TopIntBooleanCollection

java.lang.Object

org.dice_research.topicmodeling.commons.collections.TopIntBooleanCollection

public class TopIntBooleanCollection
extends Object

This container allows you to hold the top n value-object-pairs. If the sortAscending flag is set, the best values are the lowest of the collection. If the flag is set to false, the highest values are used as best.

Note that all value-object-pairs with a value worse than the nth best element are discarded.

Note that the values array is sorted ascending or descending relying on the value of the sortAscending flag. The elements of the objects array are sorted associated to their values in the values array.

Note that this class has been generated using the class TopCollectionClassGenerator. If changes to this class are necessary, they should be made inside the generator class.

Author:

Michael Röder (michael.roeder@uni-paderborn.de)

Field Summary

Fields

Modifier and Type	Field and Description
boolean[]	objects An array containing the objects associated to the n best values seen by this container.
private int	size current size of this container.
private boolean	sortAscending Flag defining the order of the value elements in this container.
int[]	values An array containing the n best values seen by this container.

Constructor Summary

Constructors

Constructor and Description
TopIntBooleanCollection(int n, boolean sortAscending) Creates a container which holds the n best int values and the objects associated with them.

Method Summary

Modifier and Type	Method and Description
boolean	add(int value, boolean object) Adds the given value and the object associated with to the container if the given value is inside the top n values.
void	clear() Clears the container.
private int	findPosition(int value) Searches for the position of the given value inside the values array.
private int	findPosition(int value, int startPosition, int endPosition) Searches for the position of the given value inside a sub array of the values array.
boolean[]	getObjects() Returns the array of objects associated to the best values.
int[]	getValues() Returns the array of the n best values.
boolean	pop() Pops the first object (the one with the best value) from the Container.
void	remove(int index) Removes the value with the given index and its associated object from the container.
int	size() Returns the size of this container.
boolean[]	toArray() Returns the array of objects associated to the values.

Methods inherited from class java.lang.Object

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

Field Detail

values

public int[] values

An array containing the n best values seen by this container.

Note that the array has the size with which this container has been constructed. If you want to iterate through the best values known by this container you should iterate from 0 to the size() of the container and not to the end of this array.

objects

public boolean[] objects

An array containing the objects associated to the n best values seen by this container.

Note that the array has the size with which this container has been constructed. If you want to iterate through the objects associated to the best values known by this container you should iterate from 0 to the size() of the container and not to the end of this array.

size

private int size

current size of this container.

sortAscending

private boolean sortAscending

Flag defining the order of the value elements in this container. If it is true the values are ordered ascending and the container will keep only the lowest values. If it is false the values are order descending and the container will keep only the highest values.

Constructor Detail

TopIntBooleanCollection

public TopIntBooleanCollection(int n,
                               boolean sortAscending)

Creates a container which holds the n best int values and the objects associated with them. Which int values are interpreted as the best is defined by the given flag.

Parameters:

n - The maximum number of elements which shall be stored by this container.

sortAscending - If this flag is true the lowest int value will be interpreted as the best value. If it is false the highest int value is interpreted as the best value.

Method Detail

add

public boolean add(int value,
                   boolean object)

Adds the given value and the object associated with to the container if the given value is inside the top n values.

Parameters:

value - The value which defines if the given element is inside the top n.

object - The object associated to the given value.

Returns:

True if the added value is inside the current top values, else False.

findPosition

private int findPosition(int value)

Searches for the position of the given value inside the values array.

Parameters:

value - The value for which the position inside the array should be found.

Returns:

The position or the size of the values array if the given value is not inside the top n values.

findPosition

private int findPosition(int value,
                         int startPosition,
                         int endPosition)

Searches for the position of the given value inside a sub array of the values array.

This method implements a recursive binary search.

Parameters:

value - The value for which the position inside the array should be found.

startPosition - The index of the first element of the sub array.

endPosition - The index of the last element of the sub array.

Returns:

The position of this value inside the sub array.

toArray

public boolean[] toArray()

Returns the array of objects associated to the values.

Returns:

An array of objects associated to the values.

getValues

public int[] getValues()

Returns the array of the n best values.

Note that this is the original array and not a copy.

Returns:

The array of the n best values.

getObjects

public boolean[] getObjects()

Returns the array of objects associated to the best values.

Note that this is the original array and not a copy.

Returns:

The array of objects associated to the values.

size

public int size()

Returns the size of this container.

Returns:

The size of this container.

clear

public void clear()

Clears the container.

remove

public void remove(int index)

Removes the value with the given index and its associated object from the container.

Parameters:

index -

pop

public boolean pop()

Pops the first object (the one with the best value) from the Container. In other words, removes and returns the first object of this container.

Returns:

The first object of this container.

Throws:

NoSuchElementException - - If this container is empty.