flat_multiset.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
 
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_FLAT_MULTISET_INCLUDED
#define ETL_FLAT_MULTISET_INCLUDED
 
#include "platform.h"
#include "initializer_list.h"
#include "nth_type.h"
#include "placement_new.h"
#include "pool.h"
#include "reference_flat_multiset.h"
#include "type_traits.h"
 
#include "private/comparator_is_transparent.h"
 
//*****************************************************************************
//*****************************************************************************
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TKeyCompare = etl::less<T> >
  class iflat_multiset : private etl::ireference_flat_multiset<T, TKeyCompare>
  {
  private:
 
    typedef etl::ireference_flat_multiset<T, TKeyCompare> refset_t;
    typedef typename refset_t::lookup_t                   lookup_t;
    typedef etl::ipool                                    storage_t;
 
    typedef const T& key_parameter_t;
 
  public:
 
    typedef T                 key_type;
    typedef T                 value_type;
    typedef TKeyCompare       key_compare;
    typedef value_type&       reference;
    typedef const value_type& const_reference;
#if ETL_USING_CPP11
    typedef value_type&& rvalue_reference;
#endif
    typedef value_type*       pointer;
    typedef const value_type* const_pointer;
    typedef size_t            size_type;
 
    typedef typename refset_t::iterator       iterator;
    typedef typename refset_t::const_iterator const_iterator;
 
    typedef ETL_OR_STD::reverse_iterator<iterator>                   reverse_iterator;
    typedef ETL_OR_STD::reverse_iterator<const_iterator>             const_reverse_iterator;
    typedef typename etl::iterator_traits<iterator>::difference_type difference_type;
 
  public:
 
    //*********************************************************************
    //*********************************************************************
    iterator begin()
    {
      return refset_t::begin();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator begin() const
    {
      return refset_t::begin();
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator end()
    {
      return refset_t::end();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator end() const
    {
      return refset_t::end();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator cbegin() const
    {
      return refset_t::cbegin();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator cend() const
    {
      return refset_t::cend();
    }
 
    //*********************************************************************
    //*********************************************************************
    reverse_iterator rbegin()
    {
      return refset_t::rbegin();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rbegin() const
    {
      return refset_t::rbegin();
    }
 
    //*********************************************************************
    //*********************************************************************
    reverse_iterator rend()
    {
      return refset_t::rend();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rend() const
    {
      return refset_t::rend();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crbegin() const
    {
      return refset_t::crbegin();
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crend() const
    {
      return refset_t::crend();
    }
 
    //*********************************************************************
    //*********************************************************************
    template <typename TIterator>
    void assign(TIterator first, TIterator last)
    {
#if ETL_IS_DEBUG_BUILD
      difference_type d = etl::distance(first, last);
      ETL_ASSERT(d <= difference_type(capacity()), ETL_ERROR(flat_multiset_full));
#endif
 
      clear();
 
      while (first != last)
      {
        insert(*first);
        ++first;
      }
    }
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, bool> insert(const_reference value)
    {
      ETL_OR_STD::pair<iterator, bool> result(end(), false);
 
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      iterator i_element = etl::upper_bound(begin(), end(), value, compare);
 
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(value);
      ETL_INCREMENT_DEBUG_COUNT;
      result = refset_t::insert_at(i_element, *pvalue);
 
      return result;
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, bool> insert(rvalue_reference value)
    {
      ETL_OR_STD::pair<iterator, bool> result(end(), false);
 
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      iterator i_element = etl::upper_bound(begin(), end(), value, compare);
 
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(etl::move(value));
      ETL_INCREMENT_DEBUG_COUNT;
      result = refset_t::insert_at(i_element, *pvalue);
 
      return result;
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator insert(const_iterator /*position*/, const_reference value)
    {
      return insert(value).first;
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    //*********************************************************************
    iterator insert(const_iterator /*position*/, rvalue_reference value)
    {
      return insert(etl::move(value)).first;
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    template <class TIterator>
    void insert(TIterator first, TIterator last)
    {
      while (first != last)
      {
        insert(*first);
        ++first;
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1>
    ETL_OR_STD::pair<iterator, bool> emplace(const_reference value)
    {
      return insert(value);
    }
 
    //*************************************************************************
    //*************************************************************************
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_FLAT_MULTISET_FORCE_CPP03_IMPLEMENTATION)
    template <typename... Args>
    ETL_OR_STD::pair<iterator, bool> emplace(Args&&... args)
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(etl::forward<Args>(args)...);
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
#else
    //*************************************************************************
    //*************************************************************************
    ETL_OR_STD::pair<iterator, bool> emplace()
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type();
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1>
    ETL_OR_STD::pair<iterator, bool> emplace(const T1& value1)
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(value1);
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2>
    ETL_OR_STD::pair<iterator, bool> emplace(const T1& value1, const T2& value2)
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(value1, value2);
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3>
    ETL_OR_STD::pair<iterator, bool> emplace(const T1& value1, const T2& value2, const T3& value3)
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(value1, value2, value3);
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3, typename T4>
    ETL_OR_STD::pair<iterator, bool> emplace(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
    {
      ETL_ASSERT(!full(), ETL_ERROR(flat_multiset_full));
 
      // Create it.
      value_type* pvalue = storage.allocate<value_type>();
      ::new (pvalue) value_type(value1, value2, value3, value4);
 
      iterator i_element = upper_bound(*pvalue);
 
      ETL_INCREMENT_DEBUG_COUNT;
      return ETL_OR_STD::pair<iterator, bool>(refset_t::insert_at(i_element, *pvalue));
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    size_t erase(key_parameter_t key)
    {
      ETL_OR_STD::pair<iterator, iterator> range = equal_range(key);
 
      if (range.first == end())
      {
        return 0;
      }
      else
      {
        size_t d = static_cast<size_t>(etl::distance(range.first, range.second));
        erase(range.first, range.second);
        return d;
      }
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    size_t erase(K&& key)
    {
      ETL_OR_STD::pair<iterator, iterator> range = equal_range(etl::forward<K>(key));
 
      if (range.first == end())
      {
        return 0;
      }
      else
      {
        size_t d = static_cast<size_t>(etl::distance(range.first, range.second));
        erase(range.first, range.second);
        return d;
      }
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(iterator i_element)
    {
      etl::destroy_at(etl::addressof(*i_element));
      storage.release(etl::addressof(*i_element));
      ETL_DECREMENT_DEBUG_COUNT;
      return refset_t::erase(i_element);
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(const_iterator i_element)
    {
      etl::destroy_at(etl::addressof(*i_element));
      storage.release(etl::addressof(*i_element));
      ETL_DECREMENT_DEBUG_COUNT;
      return refset_t::erase(i_element);
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(const_iterator first, const_iterator last)
    {
      const_iterator itr = first;
 
      while (itr != last)
      {
        etl::destroy_at(etl::addressof(*itr));
        storage.release(etl::addressof(*itr));
        ++itr;
        ETL_DECREMENT_DEBUG_COUNT;
      }
 
      return refset_t::erase(first, last);
    }
 
    //*************************************************************************
    //*************************************************************************
    void clear()
    {
      if ETL_IF_CONSTEXPR (etl::is_trivially_destructible<value_type>::value)
      {
        storage.release_all();
      }
      else
      {
        iterator itr = begin();
 
        while (itr != end())
        {
          etl::destroy_at(etl::addressof(*itr));
          storage.release(etl::addressof(*itr));
          ++itr;
        }
      }
 
      ETL_RESET_DEBUG_COUNT;
      refset_t::clear();
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator find(key_parameter_t key)
    {
      return refset_t::find(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    iterator find(const K& key)
    {
      return refset_t::find(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator find(key_parameter_t key) const
    {
      return refset_t::find(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    const_iterator find(const K& key) const
    {
      return refset_t::find(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    size_t count(key_parameter_t key) const
    {
      return refset_t::count(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    size_t count(const K& key) const
    {
      return refset_t::count(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator lower_bound(key_parameter_t key)
    {
      return refset_t::lower_bound(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    iterator lower_bound(const K& key)
    {
      return refset_t::lower_bound(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator lower_bound(key_parameter_t key) const
    {
      return refset_t::lower_bound(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    const_iterator lower_bound(const K& key) const
    {
      return refset_t::lower_bound(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator upper_bound(key_parameter_t key)
    {
      return refset_t::upper_bound(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    iterator upper_bound(const K& key)
    {
      return refset_t::upper_bound(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator upper_bound(key_parameter_t key) const
    {
      return refset_t::upper_bound(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    const_iterator upper_bound(const K& key) const
    {
      return refset_t::upper_bound(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, iterator> equal_range(key_parameter_t key)
    {
      return refset_t::equal_range(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    ETL_OR_STD::pair<iterator, iterator> equal_range(const K& key)
    {
      return refset_t::equal_range(key);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<const_iterator, const_iterator> equal_range(key_parameter_t key) const
    {
      return refset_t::equal_range(key);
    }
 
#if ETL_USING_CPP11
    //*********************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    ETL_OR_STD::pair<const_iterator, const_iterator> equal_range(const K& key) const
    {
      return refset_t::equal_range(key);
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    bool contains(key_parameter_t key) const
    {
      return find(key) != end();
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    template <typename K, typename KC = TKeyCompare, etl::enable_if_t<comparator_is_transparent<KC>::value, int> = 0>
    bool contains(const K& k) const
    {
      return find(k) != end();
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    iflat_multiset& operator=(const iflat_multiset& rhs)
    {
      if (&rhs != this)
      {
        assign(rhs.cbegin(), rhs.cend());
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    iflat_multiset& operator=(iflat_multiset&& rhs)
    {
      move_container(etl::move(rhs));
 
      return *this;
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    size_type size() const
    {
      return refset_t::size();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return refset_t::empty();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool full() const
    {
      return refset_t::full();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type capacity() const
    {
      return refset_t::capacity();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type max_size() const
    {
      return refset_t::max_size();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_t available() const
    {
      return refset_t::available();
    }
 
  protected:
 
    //*********************************************************************
    //*********************************************************************
    iflat_multiset(lookup_t& lookup_, storage_t& storage_)
      : refset_t(lookup_)
      , storage(storage_)
    {
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    void move_container(iflat_multiset&& rhs)
    {
      if (&rhs != this)
      {
        this->clear();
 
        etl::iflat_multiset<T, TKeyCompare>::iterator first = rhs.begin();
        etl::iflat_multiset<T, TKeyCompare>::iterator last  = rhs.end();
 
        // Move all of the elements.
        while (first != last)
        {
          typename etl::iflat_multiset<T, TKeyCompare>::iterator temp = first;
          ++temp;
 
          this->insert(etl::move(*first));
          first = temp;
        }
      }
    }
#endif
 
  private:
 
    // Disable copy construction.
    iflat_multiset(const iflat_multiset&);
 
    storage_t& storage;
 
    TKeyCompare compare;

    ETL_DECLARE_DEBUG_COUNT;
 
    //*************************************************************************
    //*************************************************************************
#if defined(ETL_POLYMORPHIC_FLAT_MULTISET) || defined(ETL_POLYMORPHIC_CONTAINERS)
 
  public:
 
    virtual ~iflat_multiset() {}
#else
 
  protected:
 
    ~iflat_multiset() {}
#endif
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TKeyCompare>
  bool operator==(const etl::iflat_multiset<T, TKeyCompare>& lhs, const etl::iflat_multiset<T, TKeyCompare>& rhs)
  {
    return (lhs.size() == rhs.size()) && etl::equal(lhs.begin(), lhs.end(), rhs.begin());
  }
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TKeyCompare>
  bool operator!=(const etl::iflat_multiset<T, TKeyCompare>& lhs, const etl::iflat_multiset<T, TKeyCompare>& rhs)
  {
    return !(lhs == rhs);
  }
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, const size_t MAX_SIZE_, typename TCompare = etl::less<T> >
  class flat_multiset : public etl::iflat_multiset<T, TCompare>
  {
  public:
 
    static ETL_CONSTANT size_t MAX_SIZE = MAX_SIZE_;
 
    //*************************************************************************
    //*************************************************************************
    flat_multiset()
      : etl::iflat_multiset<T, TCompare>(lookup, storage)
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    flat_multiset(const flat_multiset& other)
      : iflat_multiset<T, TCompare>(lookup, storage)
    {
      this->assign(other.cbegin(), other.cend());
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    flat_multiset(flat_multiset&& other)
      : etl::iflat_multiset<T, TCompare>(lookup, storage)
    {
      if (&other != this)
      {
        this->move_container(etl::move(other));
      }
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    flat_multiset(TIterator first, TIterator last)
      : iflat_multiset<T, TCompare>(lookup, storage)
    {
      this->assign(first, last);
    }
 
#if ETL_HAS_INITIALIZER_LIST
    //*************************************************************************
    //*************************************************************************
    flat_multiset(std::initializer_list<T> init)
      : iflat_multiset<T, TCompare>(lookup, storage)
    {
      this->assign(init.begin(), init.end());
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    ~flat_multiset()
    {
      this->clear();
    }
 
    //*************************************************************************
    //*************************************************************************
    flat_multiset& operator=(const flat_multiset& rhs)
    {
      if (&rhs != this)
      {
        this->assign(rhs.cbegin(), rhs.cend());
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    flat_multiset& operator=(flat_multiset&& rhs)
    {
      if (&rhs != this)
      {
        this->move_container(etl::move(rhs));
      }
 
      return *this;
    }
#endif
 
  private:
 
    typedef typename etl::iflat_multiset<T, TCompare>::value_type node_t;
 
    // The pool of nodes.
    etl::pool<node_t, MAX_SIZE> storage;
 
    // The vector that stores pointers to the nodes.
    etl::vector<node_t*, MAX_SIZE> lookup;
  };
 
  template <typename T, const size_t MAX_SIZE_, typename TCompare>
  ETL_CONSTANT size_t flat_multiset<T, MAX_SIZE_, TCompare>::MAX_SIZE;
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_CPP17 && ETL_HAS_INITIALIZER_LIST
  template <typename... T>
  flat_multiset(T...) -> flat_multiset<etl::nth_type_t<0, T...>, sizeof...(T)>;
#endif
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_CPP11 && ETL_HAS_INITIALIZER_LIST
  template <typename TKey, typename TKeyCompare = etl::less<TKey>, typename... T>
  constexpr auto make_flat_multiset(T&&... keys) -> etl::flat_multiset<TKey, sizeof...(T), TKeyCompare>
  {
    return {etl::forward<T>(keys)...};
  }
#endif
} // namespace etl
 
#endif