org.apache.lucene.facet.TopOrdAndFloatNumberQueue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lucene-facet Show documentation

Package for Faceted Indexing and Search

There is a newer version: 10.1.0

/*
 * 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.
 */
package org.apache.lucene.facet;

/**
 * Keeps highest results, first by largest float value, then tie-break by smallest ord.
 *
 * @deprecated Replaced by {@link TopOrdAndFloatQueue} in 10.x
 */
@Deprecated
public class TopOrdAndFloatNumberQueue extends TopOrdAndNumberQueue {

  /** Sole constructor. */
  public TopOrdAndFloatNumberQueue(int topN) {
    super(topN);
  }

  /** Holds an ordinal and a float value. */
  public static final class OrdAndFloat extends OrdAndValue {
    /** The value corresponding to the ordinal is a float. */
    public float value;

    /** Default constructor. */
    public OrdAndFloat() {}

    @Override
    public boolean lessThan(OrdAndValue other) {
      OrdAndFloat otherOrdAndFloat = (OrdAndFloat) other;
      if (value < otherOrdAndFloat.value) {
        return true;
      }
      if (value > otherOrdAndFloat.value) {
        return false;
      }
      return ord > otherOrdAndFloat.ord;
    }

    @Override
    public Number getValue() {
      return value;
    }
  }

  @Override
  public OrdAndValue newOrdAndValue() {
    return new OrdAndFloat();
  }
}