Class FunctionQuery.FunctionWeight

Inheritance

object

Weight

FunctionQuery.FunctionWeight

Inherited Members

Weight.GetBulkScorer(AtomicReaderContext, bool, IBits)

Weight.ScoresDocsOutOfOrder

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Queries.Function

Assembly: Lucene.Net.Queries.dll

Syntax

protected class FunctionQuery.FunctionWeight : Weight

Constructors

FunctionWeight(FunctionQuery, IndexSearcher)

Declaration

public FunctionWeight(FunctionQuery outerInstance, IndexSearcher searcher)

Parameters

Type	Name	Description
FunctionQuery	outerInstance
IndexSearcher	searcher

Fields

m_context

Declaration

protected readonly IDictionary m_context

Field Value

Type	Description
IDictionary

m_queryNorm

Declaration

protected float m_queryNorm

Field Value

Type	Description
float

m_queryWeight

Declaration

protected float m_queryWeight

Field Value

Type	Description
float

m_searcher

Declaration

protected readonly IndexSearcher m_searcher

Field Value

Type	Description
IndexSearcher

Properties

Query

The query that this concerns.

Declaration

public override Query Query { get; }

Property Value

Type	Description
Query

Overrides

Lucene.Net.Search.Weight.Query

Methods

Explain(AtomicReaderContext, int)

An explanation of the score computation for the named document.

Declaration

public override Explanation Explain(AtomicReaderContext ctx, int doc)

Parameters

Type	Name	Description
AtomicReaderContext	ctx
int	doc	The document's id relative to the given context's reader

Returns

Type	Description
Explanation	An Lucene.Net.Search.Explanation for the score

Overrides

Weight.Explain(AtomicReaderContext, int)

Exceptions

Type	Condition
IOException	if an IOException occurs

GetScorer(AtomicReaderContext, IBits)

Returns a Lucene.Net.Search.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 Lucene.Net.Search.Scorer indeed scores documents out of order (i.e., call Lucene.Net.Search.Weight.ScoresDocsOutOfOrder), as some Lucene.Net.Search.Scorer implementations will always return documents in-order.

NOTE:null can be returned if no documents will be scored by this query.

Declaration

public override Scorer GetScorer(AtomicReaderContext ctx, IBits acceptDocs)

Parameters

Type	Name	Description
AtomicReaderContext	ctx
IBits	acceptDocs	Lucene.Net.Util.IBits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)

Returns

Type	Description
Scorer	A Lucene.Net.Search.Scorer which scores documents in/out-of order.

Overrides

Lucene.Net.Search.Weight.GetScorer(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)

Exceptions

Type	Condition
IOException	if there is a low-level I/O error

GetValueForNormalization()

The value for normalization of contained query clauses (e.g. sum of squared weights).

Declaration

public override float GetValueForNormalization()

Returns

Type	Description
float

Overrides

Lucene.Net.Search.Weight.GetValueForNormalization()

Normalize(float, float)

Assigns the query normalization factor and boost from parent queries to this.

Declaration

public override void Normalize(float norm, float topLevelBoost)

Parameters

Type	Name	Description
float	norm
float	topLevelBoost

Overrides

Weight.Normalize(float, float)