ScoredIdAccumulator (LensKit 3.0-M2)

All Known Implementing Classes:

TopNScoredIdAccumulator, UnlimitedScoredIdAccumulator
```
public interface ScoredIdAccumulator
```
Accumulate a sorted list of scored IDs.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<ScoredId>`	`finish()` Accumulate the scores into a sorted scored list and reset the accumulator.
`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.
`MutableSparseVector`	`finishVector()` Accumulate the scores into a mutable sparse vector and reset the accumulator.
`boolean`	`isEmpty()` Query whether the accumulator is empty.
`void`	`put(long item, double score)` Put a new item in 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.
  - finish
```
List<ScoredId> finish()
```
    Accumulate the scores into a sorted scored list and reset the accumulator. Items are sorted in decreasing order of score.
    After this method is called, the accumulator is ready for another accumulation.
    
    Returns:
    
    The sorted, scored list of items.
  - finishVector
```
MutableSparseVector finishVector()
```
    Accumulate the scores into a mutable sparse vector and reset the accumulator.
    After this method is called, the accumulator is ready for another accumulation.
    
    Returns:
    
    A MutableSparseVector of items.
  - 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.

Interface ScoredIdAccumulator

Method Summary

Method Detail

isEmpty

size

put

finish

finishVector

finishMap

finishSet

finishList