org.lenskit.util.collections

Interface Long2DoubleAccumulator

All Known Implementing Classes:

TopNLong2DoubleAccumulator, UnlimitedLong2DoubleAccumulator

public interface Long2DoubleAccumulator

Accumulate a sorted list of scored IDs.

Method Summary

Modifier and Type	Method and Description
LongList	finishList() Accumulate the scored items into a list.
Long2DoubleMap	finishMap() Accumulate the scores into a map and reset the accumulator.
LongSet	finishSet() Accumulate the scored items into a set.
boolean	isEmpty() Query whether the accumulator is empty.
void	put(long item, double score) Put a new item in the accumulator.
default void	putAll(Long2DoubleMap map) Add all items from a map to the accumulator.
int	size() Get the number of items in the accumulator.

Method Detail

isEmpty

boolean isEmpty()

Query whether the accumulator is empty.

Returns:

true if the accumulator has no items.

size

int size()

Get the number of items in the accumulator.

Returns:

The number of items accumulated so far, up to the maximum items desired from the accumulator.

put

void put(long item,
         double score)

Put a new item in the accumulator. Putting the same item twice does not replace the previous entry - it adds a new entry with the same ID.

Parameters:

item - The item to add to the accumulator.

score - The item’s score.

putAll

default void putAll(Long2DoubleMap map)

Add all items from a map to the accumulator.

Parameters:

map - The map.

finishMap

Long2DoubleMap finishMap()

Accumulate the scores into a map and reset the accumulator.

After this method is called, the accumulator is ready for another accumulation.

Returns:

A map of items.

finishSet

LongSet finishSet()

Accumulate the scored items into a set.

Returns:

The set of items accumulated.

finishList

LongList finishList()

Accumulate the scored items into a list.

Returns:

The list of items accumulated, in decreasing order of score.