es.uam.eps.ir.ranksys.core.util.topn

Class ObjectDoubleTopN<T>

java.lang.Object

java.util.AbstractCollection<T>

es.uam.eps.ir.ranksys.core.util.topn.AbstractTopN<Tuple2od<T>>

es.uam.eps.ir.ranksys.core.util.topn.ObjectDoubleTopN<T>

Type Parameters:

T - type of the object

All Implemented Interfaces:

Iterable<Tuple2od<T>>, Collection<Tuple2od<T>>

public class ObjectDoubleTopN<T>
extends AbstractTopN<Tuple2od<T>>

Bounded min-heap to keep just the top-n greatest object-double pairs according to the value of the double.

Author:

Saúl Vargas (saul.vargas@uam.es)

Field Summary

Fields inherited from class es.uam.eps.ir.ranksys.core.util.topn.AbstractTopN

capacity, size

Constructor Summary

Constructors

Constructor and Description
ObjectDoubleTopN(int capacity) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(T object, double value) Tries to add an object-double pair to the heap.
protected int	compare(int i, int j) Compares the i-th element of the heap with the j-th element in the heap.
protected int	compare(int i, Tuple2od<T> e) Compares the i-th element of the heap with the element
protected Tuple2od<T>	get(int i) Returns the i-th element in the heap.
protected void	set(int i, Tuple2od<T> e) Sets the element in the i-th position of the heap.
protected void	swap(int i, int j) Swaps the elements in the i-th and j-th element in the heap.

Methods inherited from class es.uam.eps.ir.ranksys.core.util.topn.AbstractTopN

add, iterator, peek, reverseIterator, reverseStream, size, sort

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ObjectDoubleTopN

public ObjectDoubleTopN(int capacity)

Constructor.

Parameters:

capacity - maximum capacity of the heap

Method Detail

add

public boolean add(T object,
                   double value)

Tries to add an object-double pair to the heap.

Parameters:

object - object to be added

value - double to be added

Returns:

true if the pair was added to the heap, false otherwise

get

protected Tuple2od<T> get(int i)

Description copied from class: AbstractTopN

Returns the i-th element in the heap.

Specified by:

get in class AbstractTopN<Tuple2od<T>>

Parameters:

i - index of the element

Returns:

the element in the heap

set

protected void set(int i,
                   Tuple2od<T> e)

Description copied from class: AbstractTopN

Sets the element in the i-th position of the heap.

Specified by:

set in class AbstractTopN<Tuple2od<T>>

Parameters:

i - index

e - element

compare

protected int compare(int i,
                      Tuple2od<T> e)

Description copied from class: AbstractTopN

Compares the i-th element of the heap with the element

Specified by:

compare in class AbstractTopN<Tuple2od<T>>

Parameters:

i - index

e - element

Returns:

a number less than, equal to or greater than zero if the i-th element in the heap is smaller, equal or greater than the element.

compare

protected int compare(int i,
                      int j)

Description copied from class: AbstractTopN

Compares the i-th element of the heap with the j-th element in the heap.

Specified by:

compare in class AbstractTopN<Tuple2od<T>>

Parameters:

i - index

j - index

Returns:

a number less than, equal to or greater than zero if the i-th element in the heap is smaller, equal or greater than j-th in the heap.

swap

protected void swap(int i,
                    int j)

Description copied from class: AbstractTopN

Swaps the elements in the i-th and j-th element in the heap.

Specified by:

swap in class AbstractTopN<Tuple2od<T>>

Parameters:

i - index

j - index