Class SingularFunction

A function with a single (one) argument.

NOTE: This was SingleFunction in Lucene, changed to avoid conusion with operations on the datatype float.

Inheritance

object

ValueSource

SingularFunction

SimpleSingleFunction

Inherited Members

ValueSource.GetValues(IDictionary, AtomicReaderContext)

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

Constructors

SingularFunction(ValueSource)

A function with a single (one) argument.

NOTE: This was SingleFunction in Lucene, changed to avoid conusion with operations on the datatype float.

Declaration

protected SingularFunction(ValueSource source)

Parameters

Type	Name	Description
ValueSource	source

Fields

m_source

A function with a single (one) argument.

NOTE: This was SingleFunction in Lucene, changed to avoid conusion with operations on the datatype float.

Declaration

protected readonly ValueSource m_source

Field Value

Type	Description
ValueSource

Properties

Name

A function with a single (one) argument.

NOTE: This was SingleFunction in Lucene, changed to avoid conusion with operations on the datatype float.

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)

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()