org.lenskit.api

Interface ResultMap

All Superinterfaces:

java.lang.Iterable<Result>, java.util.Map<java.lang.Long,Result>

All Known Subinterfaces:

LenskitResultMap

All Known Implementing Classes:

BasicResultMap

public interface ResultMap
extends java.util.Map<java.lang.Long,Result>, java.lang.Iterable<Result>

A map of results from a recommender operation. This is returned from operations such as predict that provide scores or values for a collection of items, but do not rank or find items.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Result	get(long key) Get a result without boxing the key.
double	getScore(long id) Get the score associated with an ID.
java.util.Map<java.lang.Long,java.lang.Double>	scoreMap() View this result set as a map from longs to doubles.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

scoreMap

java.util.Map<java.lang.Long,java.lang.Double> scoreMap()

View this result set as a map from longs to doubles.

Returns:

A map view of this result set.

get

@Nullable
Result get(long key)

Get a result without boxing the key.

Parameters:

key - The item ID.

Returns:

The result, or null if the key is not in the map.

getScore

double getScore(long id)

Get the score associated with an ID.

Parameters:

id - The ID to query.

Returns:

The score associated with id, or Double.NaN if there is no score.