Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Util.TopResults<T>

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

    Inheritance
    object
    Util.TopResults<T>
    Implements
    IEnumerable<Util.Result<T>>
    IEnumerable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Util.Fst
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class Util.TopResults<T> : IEnumerable<Util.Result<T>>, IEnumerable where T : class
    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
    bool

    TopN

    The top results

    Declaration
    public IList<Util.Result<T>> TopN { get; }
    Property Value
    Type Description
    IList<Util.Result<T>>

    Methods

    GetEnumerator()

    Returns an enumerator that iterates through the collection.

    Declaration
    public IEnumerator<Util.Result<T>> GetEnumerator()
    Returns
    Type Description
    IEnumerator<Util.Result<T>>

    An enumerator that can be used to iterate through the collection.

    Implements

    IEnumerable<T>
    IEnumerable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.