org.kit.furia
Interface IRIndexShort<O extends org.ajmm.obsearch.ob.OBShort>

All Superinterfaces:

IRIndex<O>

All Known Implementing Classes:

FIRIndexShort

public interface IRIndexShort<O extends org.ajmm.obsearch.ob.OBShort>
extends IRIndex<O>

An IRIndex that can store documents composed of Objects OBShort.

Since:

0

Author:

Arnoldo Jose Muller Molina

Method Summary

java.util.List<ResultCandidate>

search(Document<O> document, byte k, short r, short n) Searches the top n documents that are closest to document.

Methods inherited from interface org.kit.furia.IRIndex

close, delete, freeze, getIndex, getMSetScoreThreshold, getSetScoreThreshold, getSize, getWordsSize, insert, isValidationMode, setMSetScoreThreshold, setSetScoreThreshold, setValidationMode, shouldSkipDoc

Method Detail

search

java.util.List<ResultCandidate> search(Document<O> document,
                                       byte k,
                                       short r,
                                       short n)
                                       throws IRException

Searches the top n documents that are closest to document. For each "word" (element) that composes document, at most k closest objects will be returned, and all of the returned objects will be used to create the query. The k

Parameters:

document - A multi-set of objects OBShort.

k - k for the nearest neighbor search. All the k-elements will be used to create the IR query.

r - range for the nearest neighbor search

n - Maximum # of elements to return

Returns:

The closest elements to document. The leftmost document is the closest document.

Throws:

IRException - If something goes really wrong.