Class MultiSingleFunction

Abstract ValueSource implementation which wraps multiple ValueSources and applies an extendible float function to their values.

NOTE: This was MultiFloatFunction in Lucene

Inheritance

object

ValueSource

MultiSingleFunction

MaxSingleFunction

MinSingleFunction

ProductSingleFunction

SumSingleFunction

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 abstract class MultiSingleFunction : ValueSource

Constructors

MultiSingleFunction(ValueSource[])

Abstract ValueSource implementation which wraps multiple ValueSources and applies an extendible float function to their values.

NOTE: This was MultiFloatFunction in Lucene

Declaration

protected MultiSingleFunction(ValueSource[] sources)

Parameters

Type	Name	Description
ValueSource[]	sources

Fields

m_sources

Abstract ValueSource implementation which wraps multiple ValueSources and applies an extendible float function to their values.

NOTE: This was MultiFloatFunction in Lucene

Declaration

protected readonly ValueSource[] m_sources

Field Value

Type	Description
ValueSource[]

Properties

Name

Abstract ValueSource implementation which wraps multiple ValueSources and applies an extendible float function to their values.

NOTE: This was MultiFloatFunction in Lucene

Declaration

protected abstract string Name { get; }

Property Value

Type	Description
string

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)

Func(int, FunctionValues[])

Abstract ValueSource implementation which wraps multiple ValueSources and applies an extendible float function to their values.

NOTE: This was MultiFloatFunction in Lucene

Declaration

protected abstract float Func(int doc, FunctionValues[] valsArr)

Parameters

Type	Name	Description
int	doc
FunctionValues[]	valsArr

Returns

Type	Description
float

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)