tpl_dynBinHeap.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef TPL_DYNBINHEAP_H
# define TPL_DYNBINHEAP_H
 
# include <ah-concepts.H>
# include <ahDry.H>
# include <ah-args-ctor.H>
# include <htlist.H>
# include <ah-dry.H>
# include <tpl_binNodeUtils.H>
# include <tpl_binHeap.H>
 
using namespace Aleph;
 
namespace Aleph {
 
  template <class T, class Compare = Aleph::less<T>>
    requires StrictWeakOrder<Compare, T>
  class DynBinHeap : public BinHeap<T, Compare>,
                     public LocateFunctions<DynBinHeap<T, Compare>, T>,
                     public FunctionalMethods<DynBinHeap<T, Compare>, T>,
                     public GenericKeys<DynBinHeap<T, Compare>, T>,
                     public EqualToMethod<DynBinHeap<T, Compare>>,
                     public StlAlephIterator<DynBinHeap<T, Compare>>
  {
  public:
 
    using Set_Type = DynBinHeap;
 
    using Item_Type = T;
 
    using Key_Type = T;
 
  private:
 
    using Base = BinHeap<T, Compare>;
 
    using Node = typename BinHeap<T, Compare>::Node;
 
    T & __insert(Node * p) noexcept
    {
      return BinHeap<T, Compare>::insert(p)->get_key();
    }
 
    void copy(const DynBinHeap & src)
    {
      src.for_each_in_preorder([this] (Node * p)
                               {
                                 __insert(new Node (p->get_key()));
                               });
    }
 
  public:
 
    DynBinHeap(Compare & cmp) noexcept : Base(cmp) { /* empty */ }
 
    DynBinHeap(Compare && cmp = Compare()) noexcept : BinHeap<T, Compare>(cmp)
    { /* empty */ }
 
    DynBinHeap(const DynBinHeap & h) : Base(h.cmp)
    {
      copy(h);
    }
 
    DynBinHeap(DynBinHeap && h) : Base(h.cmp)
    {
      this->swap(h);
    }
 
    Special_Ctors(DynBinHeap, T);
 
    Args_Ctor(DynBinHeap, T);
 
    DynBinHeap & operator = (const DynBinHeap & h)
    {
      if (this == &h)
        return *this;
 
      empty();
 
      copy(h);
 
      return *this;
    }
 
    DynBinHeap & operator = (DynBinHeap && h) noexcept
    {
      this->swap(h);
      return *this;
    }
 
    T & insert(const T & item)
    {
      return __insert(new Node (item));
    }
 
    T & insert(T && item)
    {
      return __insert(new Node (std::forward<T>(item)));
    }
 
    T & append(const T & item)
    {
      return __insert(new Node (item));
    }
 
    T & append(T && item)
    {
      return __insert(new Node (std::forward<T>(item)));
    }
 
    T & put(const T & item)
    {
      return insert(item);
    }
 
    T & put(T && item)
    {
      return insert(std::forward<T>(item));
    }
 
    T getMin()
    {
      Node * node = BinHeap<T, Compare>::getMin();
 
      T return_value = std::move(node->get_key());
 
      delete node;
 
      return return_value;
    }
 
    T getMax()
    {
      return getMin();
    }
 
    T get()
    {
      return getMin();
    }
 
    void update(T & data) noexcept
    {
      Node * node = Node::key_to_node(data);
      BinHeap<T, Compare>::update(node);
    }
 
    bool remove(T & data) noexcept
    {
      if (this->is_empty())
        return false;
 
      Node * node = BinHeap<T, Compare>::Node::key_to_node(data);
      Node * removed = BinHeap<T, Compare>::remove(node);
      if (removed == nullptr)
        return false;
 
      delete removed;
      return true;
    }
 
    bool erase(T & data) noexcept
    {
      return remove(data);
    }
 
    T & top() const
    {
      return BinHeap<T, Compare>::top()->get_key();
    }
 
    void empty() noexcept
    {
      this->remove_all_and_delete();
    }
 
    void clear() noexcept { empty(); }
 
    ~DynBinHeap()
    {
      empty();
    }
 
    template <class Operation>
    bool traverse(Operation & op)
    {
      return this->preorder_traverse([&op] (Node * p)
                                     { return op(p->get_key()); });
    }
 
    template <class Operation>
    bool traverse(Operation && op = Operation())
    {
      return traverse(op);
    }
 
    template <class Operation>
    bool traverse(Operation & op) const
    {
      return this->preorder_traverse([&op] (Node * p)
                                     { return op(p->get_key()); });
    }
 
    template <class Operation>
    bool traverse(Operation && op = Operation()) const
    {
      return traverse<Operation>(op);
    }
 
    struct Iterator : public Base::Iterator
    {
      using Item_Type = T;
      Iterator() noexcept = default;
      Iterator(const DynBinHeap & h)
        : Base::Iterator(h) {}
      const T & get_curr_ne() const noexcept
      {
        return KEY(Base::Iterator::get_curr_ne());
      }
      const T & get_curr() const { return KEY(Base::Iterator::get_curr()); }
    };
  };
 
} // end namespace Aleph
 
# endif // TPL_DYNBINHEAP_H