src/Lucene.Net.Facet/TopOrdAndIntQueue.cs

// Lucene version compatibility level 4.8.1
using Lucene.Net.Util;
using System;
#nullable enable

namespace Lucene.Net.Facet
{
    /*
     * Licensed to the Apache Software Foundation (ASF) under one or more
     * contributor license agreements.  See the NOTICE file distributed with
     * this work for additional information regarding copyright ownership.
     * The ASF licenses this file to You under the Apache License, Version 2.0
     * (the "License"); you may not use this file except in compliance with
     * the License.  You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */

    /// <summary>
    /// Keeps highest results, first by largest <see cref="int"/> value,
    /// then tie break by smallest ord.
    /// <para/>
    /// NOTE: This was TopOrdAndIntQueue in Lucene
    /// </summary>

    // LUCENENET NOTE: Keeping this around because it is public. Although,
    // we don't use it internally anymore, we use TopOrdAndInt32Comparer
    // with ValuePriorityQueue instead.
    public class TopOrdAndInt32Queue : PriorityQueue<OrdAndValue<int>>
    {
        // LUCENENET specific - de-nested OrdAndValue and made it into a generic struct
        // so it can be used with this class and TopOrdAndSingleQueue

        /// <summary>
        /// Initializes a new instance of <see cref="TopOrdAndInt32Queue"/> with the specified
        /// <paramref name="topN"/> size.
        /// </summary>
        public TopOrdAndInt32Queue(int topN)
            : base(topN) // LUCENENET NOTE: Doesn't pre-populate because sentinelFactory is null
        {
        }

        protected internal override bool LessThan(OrdAndValue<int> a, OrdAndValue<int> b)
            => TopOrdAndInt32Comparer.Default.LessThan(a, b);
    }

    /// <summary>
    /// Keeps highest results, first by largest <see cref="int"/> value,
    /// then tie break by smallest ord.
    /// <para/>
    /// NOTE: This is a refactoring of TopOrdAndIntQueue in Lucene
    /// </summary>
    // LUCENENET: Refactored PriorityQueue<T> subclass into PriorityComparer<T>
    // implementation, which can be passed into ValuePriorityQueue.
    public sealed class TopOrdAndInt32Comparer : PriorityComparer<OrdAndValue<int>>
    {
        /// <summary>
        /// Returns a default sort order comparer for <see cref="OrdAndValue{Int32}"/>.
        /// Keeps highest results, first by largest <see cref="int"/> value,
        /// then tie break by smallest ord.
        /// </summary>
        public static TopOrdAndInt32Comparer Default { get; } = new TopOrdAndInt32Comparer();

        protected internal override bool LessThan(OrdAndValue<int> a, OrdAndValue<int> b)
        {
            if (a.Value < b.Value)
            {
                return true;
            }
            else if (a.Value > b.Value)
            {
                return false;
            }
            else
            {
                return a.Ord > b.Ord;
            }
        }
    }
}