Class RangeMapSingleFunction

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Inheritance

object

ValueSource

RangeMapSingleFunction

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 RangeMapSingleFunction : ValueSource

Constructors

RangeMapSingleFunction(ValueSource, float, float, ValueSource, ValueSource)

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

public RangeMapSingleFunction(ValueSource source, float min, float max, ValueSource target, ValueSource def)

Parameters

Type	Name	Description
ValueSource	source
float	min
float	max
ValueSource	target
ValueSource	def

RangeMapSingleFunction(ValueSource, float, float, float, float?)

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

public RangeMapSingleFunction(ValueSource source, float min, float max, float target, float? def)

Parameters

Type	Name	Description
ValueSource	source
float	min
float	max
float	target
float?	def

Fields

m_defaultVal

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

protected readonly ValueSource m_defaultVal

Field Value

Type	Description
ValueSource

m_max

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

protected readonly float m_max

Field Value

Type	Description
float

m_min

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

protected readonly float m_min

Field Value

Type	Description
float

m_source

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

protected readonly ValueSource m_source

Field Value

Type	Description
ValueSource

m_target

RangeMapSingleFunction implements a map function over another ValueSource whose values fall within min and max inclusive to target.

Normally used as an argument to a FunctionQuery

NOTE: This was RangeMapFloatFunction in Lucene

Declaration

protected readonly ValueSource m_target

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)