org.grouplens.lenskit.knn.user

Interface NeighborFinder

All Known Implementing Classes:

LiveNeighborFinder, SnapshotNeighborFinder

@DefaultImplementation(value=LiveNeighborFinder.class)
public interface NeighborFinder

Finds candidate neighbors for a user.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
Iterable<Neighbor>	getCandidateNeighbors(UserHistory<? extends Event> user, LongSet items) Get potential neighbors for a particular user.

Method Detail

getCandidateNeighbors

Iterable<Neighbor> getCandidateNeighbors(UserHistory<? extends Event> user,
                                         LongSet items)

Get potential neighbors for a particular user.

Parameters:

user - The user whose neighbors are wanted.

items - The items that the client needs to be able to score or recommend.

Returns:

A collection of potential neighbors for user. This collection may include neighbors that are not useful for scoring any item in items; the item set is just to help the neighbor finder guide its search if relevant.