/**********************************************************************
 * File:        sortflts.h  (Formerly sfloats.h)
 * Description: Code to maintain a sorted list of floats.
 * Author:      Ray Smith
 *
 * (C) Copyright 1993, Hewlett-Packard Ltd.
 ** Licensed 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.
 *
 **********************************************************************/

#ifndef SORTFLTS_H
#define SORTFLTS_H

#include "elst.h"

namespace tesseract {

class SORTED_FLOAT : public ELIST<SORTED_FLOAT>::LINK {
  friend class SORTED_FLOATS;

public:
  SORTED_FLOAT() = default;
  SORTED_FLOAT(      // create one
      float value,   // value of entry
      int32_t key) { // reference
    entry = value;
    address = key;
  }

private:
  float entry;     // value of float
  int32_t address; // key
};

ELISTIZEH(SORTED_FLOAT)
class SORTED_FLOATS {
public:
  /** empty constructor */
  SORTED_FLOATS() {
    it.set_to_list(&list);
  }
  /**
   * add sample
   * @param value sample float
   * @param key retrieval key
   */
  void add(float value, int32_t key);
  /**
   * delete sample
   * @param key key to delete
   */
  void remove(int32_t key);
  /**
   * index to list
   * @param index item to get
   */
  float operator[](int32_t index);

private:
  SORTED_FLOAT_LIST list; // list of floats
  SORTED_FLOAT_IT it;     // iterator built-in
};

} // namespace tesseract

#endif
