Class Util.TopResults<T>

Holds the results for a top N search using Util.TopNSearcher<T>

Inheritance

System.Object

Util.TopResults<T>

Implements

System.Collections.Generic.IEnumerable<Util.Result<T>>

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Util.Fst

Assembly: Lucene.Net.dll

Syntax

public sealed class TopResults<T> : IEnumerable<Util.Result<T>>, IEnumerable

Type Parameters

Name	Description
T

Properties

IsComplete

true iff this is a complete result ie. if the specified queue size was large enough to find the complete list of results. this might be false if the Util.TopNSearcher<T> rejected too many results.

Declaration

public bool IsComplete { get; }

Property Value

Type	Description
System.Boolean

TopN

The top results

Declaration

public IList<Util.Result<T>> TopN { get; }

Property Value

Type	Description
System.Collections.Generic.IList<Util.Result<T>>

Methods

GetEnumerator()

Declaration

public IEnumerator<Util.Result<T>> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<Util.Result<T>>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable