priority_queue.h

Go to the documentation of this file.

 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2015 John Wellbelove, rlindeman
 
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 ETL_PRIORITY_QUEUE_INCLUDED
#define ETL_PRIORITY_QUEUE_INCLUDED
 
#include "platform.h"
#include "algorithm.h"
#include "deque.h"
#include "error_handler.h"
#include "exception.h"
#include "functional.h"
#include "iterator.h"
#include "parameter_type.h"
#include "static_assert.h"
#include "type_traits.h"
#include "utility.h"
#include "vector.h"
 
#include <stddef.h>
 
//*****************************************************************************
//*****************************************************************************
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class priority_queue_exception : public exception
  {
  public:
 
    priority_queue_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
      : exception(reason_, file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class priority_queue_full : public etl::priority_queue_exception
  {
  public:
 
    priority_queue_full(string_type file_name_, numeric_type line_number_)
      : priority_queue_exception(ETL_ERROR_TEXT("priority_queue:full", ETL_PRIORITY_QUEUE_FILE_ID"A"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class priority_queue_iterator : public etl::priority_queue_exception
  {
  public:
 
    priority_queue_iterator(string_type file_name_, numeric_type line_number_)
      : priority_queue_exception(ETL_ERROR_TEXT("priority_queue:iterator", ETL_PRIORITY_QUEUE_FILE_ID"B"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class priority_queue_empty : public etl::priority_queue_exception
  {
  public:
 
    priority_queue_empty(string_type file_name_, numeric_type line_number_)
      : priority_queue_exception(ETL_ERROR_TEXT("priority_queue:empty", ETL_PRIORITY_QUEUE_FILE_ID"C"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename TContainer>
  struct priority_queue_container_interface
  {
    ETL_STATIC_ASSERT(sizeof(TContainer) == 0, "Unsupported container type for etl::ipriority_queue");
  };
 
  template <typename T, const size_t N>
  struct priority_queue_container_interface<etl::vector<T, N> >
  {
    typedef etl::ivector<T> type;
  };
 
  template <typename T, const size_t N>
  struct priority_queue_container_interface<etl::deque<T, N> >
  {
    typedef etl::ideque<T> type;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TContainerBase = etl::ivector<T>, typename TCompare = etl::less<T> >
  class ipriority_queue
  {
  public:
 
    typedef T              value_type;          
    typedef TCompare       compare_type;        
    typedef TContainerBase container_base_type; 
    typedef T&             reference;           
    typedef const T&       const_reference;     
#if ETL_USING_CPP11
    typedef T&& rvalue_reference; 
#endif
    typedef typename TContainerBase::size_type       size_type; 
    typedef typename TContainerBase::difference_type difference_type;
 
    //*************************************************************************
    //*************************************************************************
    reference top()
    {
      ETL_ASSERT_CHECK_EXTRA(!empty(), ETL_ERROR(priority_queue_empty));
      return container.front();
    }
 
    //*************************************************************************
    //*************************************************************************
    const_reference top() const
    {
      ETL_ASSERT_CHECK_EXTRA(!empty(), ETL_ERROR(priority_queue_empty));
      return container.front();
    }
 
    //*************************************************************************
    //*************************************************************************
    void push(const_reference value)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.push_back(value);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    void push(rvalue_reference value)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.push_back(etl::move(value));
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
#endif
 
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_PRIORITY_QUEUE_FORCE_CPP03_IMPLEMENTATION)
    //*************************************************************************
    //*************************************************************************
    template <typename... Args>
    void emplace(Args&&... args)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back(etl::forward<Args>(args)...);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
#else
    //*************************************************************************
    //*************************************************************************
    void emplace()
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back();
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1>
    void emplace(const T1& value1)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back(value1);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2>
    void emplace(const T1& value1, const T2& value2)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back(value1, value2);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3>
    void emplace(const T1& value1, const T2& value2, const T3& value3)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back(value1, value2, value3);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3, typename T4>
    void emplace(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
    {
      ETL_ASSERT(!full(), ETL_ERROR(etl::priority_queue_full));
 
      // Put element at end
      container.emplace_back(value1, value2, value3, value4);
      // Make elements in container into heap
      etl::push_heap(container.begin(), container.end(), compare);
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    void assign(TIterator first, TIterator last)
    {
#if ETL_IS_DEBUG_BUILD
      difference_type d = etl::distance(first, last);
      ETL_ASSERT(d >= 0, ETL_ERROR(etl::priority_queue_iterator));
      ETL_ASSERT(static_cast<size_t>(d) <= max_size(), ETL_ERROR(etl::priority_queue_full));
#endif
 
      clear();
      container.assign(first, last);
      etl::make_heap(container.begin(), container.end(), compare);
    }
 
    //*************************************************************************
    //*************************************************************************
    void pop()
    {
      ETL_ASSERT_CHECK_PUSH_POP_OR_RETURN(!empty(), ETL_ERROR(priority_queue_empty));
      // Move largest element to end
      etl::pop_heap(container.begin(), container.end(), compare);
      // Actually remove largest element at end
      container.pop_back();
    }
 
    //*************************************************************************
    //*************************************************************************
    void pop_into(reference destination)
    {
      destination = ETL_MOVE(top());
      pop();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type size() const
    {
      return container.size();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type max_size() const
    {
      return container.max_size();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return container.empty();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool full() const
    {
      return container.size() == container.max_size();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type available() const
    {
      return container.max_size() - container.size();
    }
 
    //*************************************************************************
    //*************************************************************************
    void clear()
    {
      container.clear();
    }
 
    //*************************************************************************
    //*************************************************************************
    ipriority_queue& operator=(const ipriority_queue& rhs)
    {
      if (&rhs != this)
      {
        clone(rhs);
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    ipriority_queue& operator=(ipriority_queue&& rhs)
    {
      if (&rhs != this)
      {
        clear();
        move(etl::move(rhs));
      }
 
      return *this;
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
#if defined(ETL_POLYMORPHIC_PRIORITY_QUEUE) || defined(ETL_POLYMORPHIC_CONTAINERS)
 
  public:
 
    virtual ~ipriority_queue() {}
#else
 
  protected:
 
    ~ipriority_queue() {}
#endif
 
  protected:
 
    //*************************************************************************
    //*************************************************************************
    void clone(const ipriority_queue& other)
    {
#include "etl/private/diagnostic_uninitialized_push.h"
      assign(other.container.cbegin(), other.container.cend());
#include "etl/private/diagnostic_pop.h"
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    void move(ipriority_queue&& other)
    {
      while (!other.empty())
      {
        push(etl::move(other.top()));
        other.pop();
      }
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    ipriority_queue(TContainerBase& container_)
      : container(container_)
    {
    }
 
  private:
 
    // Disable copy construction.
    ipriority_queue(const ipriority_queue&);

    TContainerBase& container;
 
    TCompare compare;
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, const size_t SIZE, typename TContainer = etl::vector<T, SIZE>,
            typename TCompare = etl::less<typename TContainer::value_type> >
  class priority_queue : public etl::ipriority_queue<T, typename etl::priority_queue_container_interface<TContainer>::type, TCompare>
  {
  private:
 
    typedef etl::ipriority_queue<T, typename etl::priority_queue_container_interface<TContainer>::type, TCompare> base_t;
 
  public:
 
    typedef typename TContainer::size_type size_type;
    typedef TContainer                     container_type;
 
    static ETL_CONSTANT size_type MAX_SIZE = size_type(SIZE);
 
    //*************************************************************************
    //*************************************************************************
    priority_queue()
      : base_t(container)
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    priority_queue(const priority_queue& rhs)
      : base_t(container)
    {
      base_t::clone(rhs);
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    priority_queue(priority_queue&& rhs)
      : base_t(container)
    {
      base_t::move(etl::move(rhs));
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    priority_queue(TIterator first, TIterator last)
      : base_t(container)
    {
      base_t::assign(first, last);
    }
 
    //*************************************************************************
    //*************************************************************************
    ~priority_queue()
    {
      base_t::clear();
    }
 
    //*************************************************************************
    //*************************************************************************
    priority_queue& operator=(const priority_queue& rhs)
    {
      if (&rhs != this)
      {
        base_t::clone(rhs);
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    priority_queue& operator=(priority_queue&& rhs)
    {
      if (&rhs != this)
      {
        base_t::clear();
        base_t::move(etl::move(rhs));
      }
 
      return *this;
    }
#endif
 
  private:
 
    TContainer container;
  };
 
  template <typename T, const size_t SIZE, typename TContainer, typename TCompare>
  ETL_CONSTANT typename priority_queue<T, SIZE, TContainer, TCompare>::size_type priority_queue<T, SIZE, TContainer, TCompare>::MAX_SIZE;
} // namespace etl
 
#endif