Class LinearSingleFunction

LinearSingleFunction implements a linear function over another ValueSource.

Normally Used as an argument to a FunctionQuery

NOTE: This was LinearFloatFunction in Lucene

Inheritance

object

ValueSource

LinearSingleFunction

Inherited Members

ValueSource.ToString()

ValueSource.NewContext(IndexSearcher)

ValueSource.GetSortField(bool)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Queries.Function.ValueSources

Assembly: Lucene.Net.Queries.dll

Syntax

public class LinearSingleFunction : ValueSource

Constructors

LinearSingleFunction(ValueSource, float, float)

LinearSingleFunction implements a linear function over another ValueSource.

Normally Used as an argument to a FunctionQuery

NOTE: This was LinearFloatFunction in Lucene

Declaration

public LinearSingleFunction(ValueSource source, float slope, float intercept)

Parameters

Type	Name	Description
ValueSource	source
float	slope
float	intercept

Fields

m_intercept

LinearSingleFunction implements a linear function over another ValueSource.

Normally Used as an argument to a FunctionQuery

NOTE: This was LinearFloatFunction in Lucene

Declaration

protected readonly float m_intercept

Field Value

Type	Description
float

m_slope

LinearSingleFunction implements a linear function over another ValueSource.

Normally Used as an argument to a FunctionQuery

NOTE: This was LinearFloatFunction in Lucene

Declaration

protected readonly float m_slope

Field Value

Type	Description
float

m_source

LinearSingleFunction implements a linear function over another ValueSource.

Normally Used as an argument to a FunctionQuery

NOTE: This was LinearFloatFunction in Lucene

Declaration

protected readonly ValueSource m_source

Field Value

Type	Description
ValueSource

Methods

CreateWeight(IDictionary, IndexSearcher)

Implementations should propagate CreateWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to GetValues() where this info can be retrieved.

Declaration

public override void CreateWeight(IDictionary context, IndexSearcher searcher)

Parameters

Type	Name	Description
IDictionary	context
IndexSearcher	searcher

Overrides

ValueSource.CreateWeight(IDictionary, IndexSearcher)

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueSource.Equals(object)

GetDescription()

description of field, used in Explain()

Declaration

public override string GetDescription()

Returns

Type	Description
string

Overrides

ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Gets the values for this reader and the context that was previously passed to CreateWeight(IDictionary, IndexSearcher)

Declaration

public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)

Parameters

Type	Name	Description
IDictionary	context
AtomicReaderContext	readerContext

Returns

Type	Description
FunctionValues

Overrides

ValueSource.GetValues(IDictionary, AtomicReaderContext)