Class Scorer

Expert: Common scoring functionality for different types of queries.

A Scorer iterates over documents matching a query in increasing order of doc Id.

Document scores are computed using a given Similarity implementation.

NOTE: The values System.Single.NaN, System.Single.NegativeInfinity and System.Single.PositiveInfinity are not valid scores. Certain collectors (eg TopScoreDocCollector) will not properly collect hits with these scores.

Inheritance
System.Object
DocIdSetIterator
DocsEnum
Scorer
ConstantScoreQuery.ConstantScorer
ScoreCachingWrappingScorer
SpanScorer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public abstract class Scorer : DocsEnum

Constructors

| Improve this Doc View Source

Scorer(Weight)

Constructs a Scorer

Declaration
protected Scorer(Weight weight)
Parameters
Type Name Description
Weight weight

The scorers Weight.

Fields

| Improve this Doc View Source

m_weight

The Scorer's parent Weight. In some cases this may be null.

Declaration
protected readonly Weight m_weight
Field Value
Type Description
Weight

Properties

| Improve this Doc View Source

Weight

returns parent Weight

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration
public virtual Weight Weight { get; }
Property Value
Type Description
Weight

Methods

| Improve this Doc View Source

GetChildren()

Returns child sub-scorers

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration
public virtual ICollection<Scorer.ChildScorer> GetChildren()
Returns
Type Description
System.Collections.Generic.ICollection<Scorer.ChildScorer>
| Improve this Doc View Source

GetScore()

Returns the score of the current document matching the query. Initially invalid, until NextDoc() or Advance(Int32) is called the first time, or when called from within Collect(Int32).

Declaration
public abstract float GetScore()
Returns
Type Description
System.Single