C# Class Lucene.Net.Search.Weight

Datei anzeigen Open project: synhershko/lucene.net Class Usage Examples

Public Methods

Method Description
Explain ( Lucene.Net.Index.IndexReader reader, int doc ) : Explanation

An explanation of the score computation for the named document.
Normalize ( float norm ) : void

Assigns the query normalization factor to this.
Scorer ( Lucene.Net.Index.IndexReader reader, bool scoreDocsInOrder, bool topScorer ) : Lucene.Net.Search.Scorer

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call ScoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.

Private Methods

Method Description
GetScoresDocsOutOfOrder ( ) : bool
GetSumOfSquaredWeights ( ) : float

Method Details

Explain() public abstract method

An explanation of the score computation for the named document.
public abstract Explain ( Lucene.Net.Index.IndexReader reader, int doc ) : Explanation
reader Lucene.Net.Index.IndexReader sub-reader containing the give doc ///
doc int ///
return Explanation

Normalize() public abstract method

Assigns the query normalization factor to this.
public abstract Normalize ( float norm ) : void
norm float
return void

Scorer() public abstract method

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call ScoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.

public abstract Scorer ( Lucene.Net.Index.IndexReader reader, bool scoreDocsInOrder, bool topScorer ) : Lucene.Net.Search.Scorer
reader Lucene.Net.Index.IndexReader /// the for which to return the . ///
scoreDocsInOrder bool specifies whether in-order scoring of documents is required. Note /// that if set to false (i.e., out-of-order scoring is required), /// this method can return whatever scoring mode it supports, as every /// in-order scorer is also an out-of-order one. However, an /// out-of-order scorer may not support /// and/or , therefore it is recommended to /// request an in-order scorer if use of these methods is required. ///
topScorer bool /// if true, will be called; if false, /// and/or will /// be called. ///
return Lucene.Net.Search.Scorer