Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SuggestWordQueue

    Sorts SuggestWord instances

    Inheritance
    object
    PriorityQueue<SuggestWord>
    SuggestWordQueue
    Inherited Members
    PriorityQueue<SuggestWord>.Add(SuggestWord)
    PriorityQueue<SuggestWord>.Insert(SuggestWord)
    PriorityQueue<SuggestWord>.InsertWithOverflow(SuggestWord)
    PriorityQueue<SuggestWord>.Top
    PriorityQueue<SuggestWord>.Pop()
    PriorityQueue<SuggestWord>.UpdateTop()
    PriorityQueue<SuggestWord>.Count
    PriorityQueue<SuggestWord>.Clear()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Search.Spell
    Assembly: Lucene.Net.Suggest.dll
    Syntax
    public sealed class SuggestWordQueue : PriorityQueue<SuggestWord>

    Constructors

    SuggestWordQueue(int)

    Use the DEFAULT_COMPARER

    Declaration
    public SuggestWordQueue(int size)
    Parameters
    Type Name Description
    int size

    The size of the queue

    See Also
    SuggestWordScoreComparer
    SuggestWordFrequencyComparer

    SuggestWordQueue(int, IComparer<SuggestWord>)

    Specify the size of the queue and the comparer to use for sorting.

    Declaration
    public SuggestWordQueue(int size, IComparer<SuggestWord> comparer)
    Parameters
    Type Name Description
    int size

    The size

    IComparer<SuggestWord> comparer

    The comparer.

    See Also
    SuggestWordScoreComparer
    SuggestWordFrequencyComparer

    Fields

    DEFAULT_COMPARER

    Default comparer: score then frequency.

    Declaration
    public static readonly IComparer<SuggestWord> DEFAULT_COMPARER
    Field Value
    Type Description
    IComparer<SuggestWord>
    See Also
    SuggestWordScoreComparer

    Methods

    LessThan(SuggestWord, SuggestWord)

    Determines the ordering of objects in this priority queue. Subclasses must define this one method.

    Declaration
    protected override bool LessThan(SuggestWord wa, SuggestWord wb)
    Parameters
    Type Name Description
    SuggestWord wa
    SuggestWord wb
    Returns
    Type Description
    bool

    true if parameter a is less than parameter b; othewise, false.

    Overrides
    PriorityQueue<SuggestWord>.LessThan(SuggestWord, SuggestWord)
    See Also
    SuggestWordScoreComparer
    SuggestWordFrequencyComparer

    See Also

    SuggestWordScoreComparer
    SuggestWordFrequencyComparer
    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.