org.lenskit.results

Class ResultAccumulator

java.lang.Object

org.lenskit.results.ResultAccumulator

public abstract class ResultAccumulator
extends Object

Accumulator for sorted lists of results. This class will return result lists, with the highest-scored result first.

Create one with create(int).

Method Summary

Modifier and Type	Method and Description
void	add(long item, double score) Add a basic result to the accumulator.
abstract void	add(Result r) Add a result to the accumulator.
static ResultAccumulator	create(int n) Create a new result accumulator.
abstract ResultList	finish() Finish accumulating and return the accumulated results.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ResultAccumulator create(int n)

Create a new result accumulator.

Parameters:

n - The number of results desired; -1 for unlimited.

Returns:

A result accumulator.

add

public abstract void add(@Nonnull
                         Result r)

Add a result to the accumulator.

Parameters:

r - The result to add.

add

public void add(long item,
                double score)

Add a basic result to the accumulator.

Parameters:

item - The item ID to add.

score - The score to add.

finish

public abstract ResultList finish()

Finish accumulating and return the accumulated results.

When this method is called, the accumulator is reset and can be used to accumulate a fresh set of results.

Returns:

The accumulated results, in nonincreasing order of score.