reference_flat_set.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) 2017 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_REFERENCE_FLAT_SET_INCLUDED
#define ETL_REFERENCE_FLAT_SET_INCLUDED
 
#include "platform.h"
#include "algorithm.h"
#include "error_handler.h"
#include "exception.h"
#include "functional.h"
#include "iterator.h"
#include "nth_type.h"
#include "pool.h"
#include "type_traits.h"
#include "utility.h"
#include "vector.h"
 
#include "private/comparator_is_transparent.h"
 
#include <stddef.h>
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class flat_set_exception : public exception
  {
  public:
 
    flat_set_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
      : exception(reason_, file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class flat_set_full : public flat_set_exception
  {
  public:
 
    flat_set_full(string_type file_name_, numeric_type line_number_)
      : flat_set_exception(ETL_ERROR_TEXT("flat_set:full", ETL_REFERENCE_FLAT_SET_FILE_ID"A"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class flat_set_iterator : public flat_set_exception
  {
  public:
 
    flat_set_iterator(string_type file_name_, numeric_type line_number_)
      : flat_set_exception(ETL_ERROR_TEXT("flat_set:iterator", ETL_REFERENCE_FLAT_SET_FILE_ID"B"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TKeyCompare = etl::less<T> >
  class ireference_flat_set
  {
  public:
 
    typedef T                 key_type;
    typedef T                 value_type;
    typedef TKeyCompare       key_compare;
    typedef value_type&       reference;
    typedef const value_type& const_reference;
    typedef value_type*       pointer;
    typedef const value_type* const_pointer;
    typedef size_t            size_type;
 
  protected:
 
    typedef etl::ivector<value_type*> lookup_t;
 
  public:
 
    //*************************************************************************
    class iterator : public etl::iterator<ETL_OR_STD::bidirectional_iterator_tag, value_type>
    {
    public:
 
      friend class ireference_flat_set;
      friend class const_iterator;
 
      iterator() {}
 
      iterator(typename lookup_t::iterator ilookup_)
        : ilookup(ilookup_)
      {
      }
 
      iterator(const iterator& other)
        : ilookup(other.ilookup)
      {
      }
 
      iterator& operator=(const iterator& other)
      {
        ilookup = other.ilookup;
        return *this;
      }
 
      iterator& operator++()
      {
        ++ilookup;
        return *this;
      }
 
      iterator operator++(int)
      {
        iterator temp(*this);
        ++ilookup;
        return temp;
      }
 
      iterator& operator--()
      {
        --ilookup;
        return *this;
      }
 
      iterator operator--(int)
      {
        iterator temp(*this);
        --ilookup;
        return temp;
      }
 
      reference operator*() const
      {
        return *(*ilookup);
      }
 
      pointer operator&() const
      {
        return etl::addressof(*(*ilookup));
      }
 
      pointer operator->() const
      {
        return etl::addressof(*(*ilookup));
      }
 
      friend bool operator==(const iterator& lhs, const iterator& rhs)
      {
        return lhs.ilookup == rhs.ilookup;
      }
 
      friend bool operator!=(const iterator& lhs, const iterator& rhs)
      {
        return !(lhs == rhs);
      }
 
    private:
 
      typename lookup_t::iterator ilookup;
    };
 
    //*************************************************************************
    class const_iterator : public etl::iterator<ETL_OR_STD::bidirectional_iterator_tag, const value_type>
    {
    public:
 
      friend class ireference_flat_set;
 
      const_iterator() {}
 
      const_iterator(typename lookup_t::const_iterator ilookup_)
        : ilookup(ilookup_)
      {
      }
 
      const_iterator(const typename ireference_flat_set::iterator& other)
        : ilookup(other.ilookup)
      {
      }
 
      const_iterator(const const_iterator& other)
        : ilookup(other.ilookup)
      {
      }
 
      const_iterator& operator=(const iterator& other)
      {
        ilookup = other.ilookup;
        return *this;
      }
 
      const_iterator& operator=(const const_iterator& other)
      {
        ilookup = other.ilookup;
        return *this;
      }
 
      const_iterator& operator++()
      {
        ++ilookup;
        return *this;
      }
 
      const_iterator operator++(int)
      {
        const_iterator temp(*this);
        ++ilookup;
        return temp;
      }
 
      const_iterator& operator--()
      {
        --ilookup;
        return *this;
      }
 
      const_iterator operator--(int)
      {
        const_iterator temp(*this);
        --ilookup;
        return temp;
      }
 
      const_reference operator*() const
      {
        return *(*ilookup);
      }
 
      const_pointer operator&() const
      {
        return etl::addressof(*(*ilookup));
      }
 
      const_pointer operator->() const
      {
        return etl::addressof(*(*ilookup));
      }
 
      friend bool operator==(const const_iterator& lhs, const const_iterator& rhs)
      {
        return lhs.ilookup == rhs.ilookup;
      }
 
      friend bool operator!=(const const_iterator& lhs, const const_iterator& rhs)
      {
        return !(lhs == rhs);
      }
 
    private:
 
      typename lookup_t::const_iterator ilookup;
    };
 
  protected:
 
    typedef typename etl::parameter_type<T>::type parameter_t;
 
  public:
 
    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;
 
    //*********************************************************************
    //*********************************************************************
    iterator begin()
    {
      return iterator(lookup.begin());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator begin() const
    {
      return const_iterator(lookup.begin());
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator end()
    {
      return iterator(lookup.end());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator end() const
    {
      return const_iterator(lookup.end());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator cbegin() const
    {
      return const_iterator(lookup.cbegin());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_iterator cend() const
    {
      return const_iterator(lookup.cend());
    }
 
    //*********************************************************************
    //*********************************************************************
    reverse_iterator rbegin()
    {
      return reverse_iterator(lookup.rbegin());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rbegin() const
    {
      return const_reverse_iterator(lookup.rbegin());
    }
 
    //*********************************************************************
    //*********************************************************************
    reverse_iterator rend()
    {
      return reverse_iterator(lookup.rend());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator rend() const
    {
      return const_reverse_iterator(lookup.rend());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crbegin() const
    {
      return const_reverse_iterator(lookup.crbegin());
    }
 
    //*********************************************************************
    //*********************************************************************
    const_reverse_iterator crend() const
    {
      return const_reverse_iterator(lookup.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_set_full));
#endif
 
      clear();
 
      while (first != last)
      {
        insert(*first);
        ++first;
      }
    }
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, bool> insert(reference value)
    {
      iterator i_element = lower_bound(value);
 
      return insert_at(i_element, value);
    }
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, bool> emplace(reference value)
    {
      return insert(value);
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator insert(const_iterator /*position*/, reference value)
    {
      return insert(value).first;
    }
 
    //*********************************************************************
    //*********************************************************************
    template <class TIterator>
    void insert(TIterator first, TIterator last)
    {
      while (first != last)
      {
        insert(*first);
        ++first;
      }
    }
 
    //*********************************************************************
    //*********************************************************************
    size_t erase(parameter_t key)
    {
      iterator i_element = find(key);
 
      if (i_element == end())
      {
        return 0;
      }
      else
      {
        lookup.erase(i_element.ilookup);
        return 1;
      }
    }
 
    //*********************************************************************
#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)
    {
      iterator i_element = find(etl::forward<K>(key));
 
      if (i_element == end())
      {
        return 0;
      }
      else
      {
        lookup.erase(i_element.ilookup);
        return 1;
      }
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(iterator i_element)
    {
      return lookup.erase(i_element.ilookup);
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(const_iterator i_element)
    {
      return lookup.erase(i_element.ilookup);
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator erase(const_iterator first, const_iterator last)
    {
      return lookup.erase(first.ilookup, last.ilookup);
    }
 
    //*************************************************************************
    //*************************************************************************
    void clear()
    {
      lookup.clear();
    }
 
    //*********************************************************************
    //*********************************************************************
    iterator find(parameter_t key)
    {
      iterator itr = etl::lower_bound(begin(), end(), key, compare);
 
      if (itr != end())
      {
        if (!key_compare()(*itr, key) && !key_compare()(key, *itr))
        {
          return itr;
        }
        else
        {
          return end();
        }
      }
 
      return end();
    }
 
#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)
    {
      iterator itr = etl::lower_bound(begin(), end(), key, compare);
 
      if (itr != end())
      {
        if (!key_compare()(*itr, key) && !key_compare()(key, *itr))
        {
          return itr;
        }
        else
        {
          return end();
        }
      }
 
      return end();
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator find(parameter_t key) const
    {
      const_iterator itr = etl::lower_bound(begin(), end(), key, compare);
 
      if (itr != end())
      {
        if (!key_compare()(*itr, key) && !key_compare()(key, *itr))
        {
          return itr;
        }
        else
        {
          return end();
        }
      }
 
      return end();
    }
 
#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
    {
      const_iterator itr = etl::lower_bound(begin(), end(), key, compare);
 
      if (itr != end())
      {
        if (!key_compare()(*itr, key) && !key_compare()(key, *itr))
        {
          return itr;
        }
        else
        {
          return end();
        }
      }
 
      return end();
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    size_t count(parameter_t key) const
    {
      return (find(key) == end()) ? 0 : 1;
    }
 
#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 (find(key) == end()) ? 0 : 1;
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator lower_bound(parameter_t key)
    {
      return etl::lower_bound(begin(), end(), key, compare);
    }
 
#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 etl::lower_bound(begin(), end(), key, compare);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator lower_bound(parameter_t key) const
    {
      return etl::lower_bound(cbegin(), cend(), key, compare);
    }
 
#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 etl::lower_bound(cbegin(), cend(), key, compare);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    iterator upper_bound(parameter_t key)
    {
      return etl::upper_bound(begin(), end(), key, compare);
    }
 
#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 etl::upper_bound(begin(), end(), key, compare);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    const_iterator upper_bound(parameter_t key) const
    {
      return etl::upper_bound(cbegin(), cend(), key, compare);
    }
 
#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 etl::upper_bound(cbegin(), cend(), key, compare);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, iterator> equal_range(parameter_t key)
    {
      return etl::equal_range(begin(), end(), key, compare);
    }
 
#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 etl::equal_range(begin(), end(), key, compare);
    }
#endif
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<const_iterator, const_iterator> equal_range(parameter_t key) const
    {
      return etl::upper_bound(cbegin(), cend(), key, compare);
    }
 
#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 etl::upper_bound(cbegin(), cend(), key, compare);
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    bool contains(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
 
    //*************************************************************************
    //*************************************************************************
    size_type size() const
    {
      return lookup.size();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return lookup.empty();
    }
 
    //*************************************************************************
    //*************************************************************************
    bool full() const
    {
      return lookup.full();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type capacity() const
    {
      return lookup.capacity();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type max_size() const
    {
      return lookup.max_size();
    }
 
    //*************************************************************************
    //*************************************************************************
    size_t available() const
    {
      return lookup.available();
    }
 
  protected:
 
    //*********************************************************************
    //*********************************************************************
    ireference_flat_set(lookup_t& lookup_)
      : lookup(lookup_)
    {
    }
 
    //*********************************************************************
    //*********************************************************************
    ETL_OR_STD::pair<iterator, bool> insert_at(iterator i_element, reference value)
    {
      ETL_OR_STD::pair<iterator, bool> result(end(), false);
 
      if (i_element == end())
      {
        // At the end.
        ETL_ASSERT(!lookup.full(), ETL_ERROR(flat_set_full));
 
        lookup.push_back(&value);
        result.first  = --end();
        result.second = true;
      }
      else
      {
        // Not at the end.
        result.first = i_element;
 
        // Existing element?
        if (compare(value, *i_element) || compare(*i_element, value))
        {
          // A new one.
          ETL_ASSERT(!lookup.full(), ETL_ERROR(flat_set_full));
          lookup.insert(i_element.ilookup, &value);
          result.second = true;
        }
      }
 
      return result;
    }
 
  private:
 
    // Disable copy construction.
    ireference_flat_set(const ireference_flat_set&);
    ireference_flat_set& operator=(const ireference_flat_set&);
 
    lookup_t& lookup;
 
    TKeyCompare compare;
 
    //*************************************************************************
    //*************************************************************************
#if defined(ETL_POLYMORPHIC_REFERENCE_FLAT_SET) || defined(ETL_POLYMORPHIC_CONTAINERS)
 
  public:
 
    virtual ~ireference_flat_set() {}
#else
 
  protected:
 
    ~ireference_flat_set() {}
#endif
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename TKey, const size_t MAX_SIZE_, typename TKeyCompare = etl::less<TKey> >
  class reference_flat_set : public ireference_flat_set<TKey, TKeyCompare>
  {
  public:
 
    static ETL_CONSTANT size_t MAX_SIZE = MAX_SIZE_;
 
    using typename ireference_flat_set<TKey, TKeyCompare>::value_type;
 
    //*************************************************************************
    //*************************************************************************
    reference_flat_set()
      : ireference_flat_set<TKey, TKeyCompare>(lookup)
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    reference_flat_set(const reference_flat_set& other)
      : ireference_flat_set<TKey, TKeyCompare>(lookup)
    {
      ireference_flat_set<TKey, TKeyCompare>::assign(other.cbegin(), other.cend());
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    reference_flat_set(TIterator first, TIterator last)
      : ireference_flat_set<TKey, TKeyCompare>(lookup)
    {
      ireference_flat_set<TKey, TKeyCompare>::assign(first, last);
    }
 
    //*************************************************************************
    //*************************************************************************
    ~reference_flat_set()
    {
      ireference_flat_set<TKey, TKeyCompare>::clear();
    }
 
  private:
 
    // The vector that stores pointers to the nodes.
    etl::vector<value_type*, MAX_SIZE> lookup;
  };
 
  template <typename TKey, const size_t MAX_SIZE_, typename TCompare>
  ETL_CONSTANT size_t reference_flat_set<TKey, MAX_SIZE_, TCompare>::MAX_SIZE;
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_CPP17 && ETL_HAS_INITIALIZER_LIST
  template <typename... T>
  reference_flat_set(T...) -> reference_flat_set<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_reference_flat_set(T&&... keys) -> etl::reference_flat_set<TKey, sizeof...(T), TKeyCompare>
  {
    return {etl::forward<T>(keys)...};
  }
#endif
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename TKeyCompare>
  bool operator==(const etl::ireference_flat_set<T, TKeyCompare>& lhs, const etl::ireference_flat_set<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::ireference_flat_set<T, TKeyCompare>& lhs, const etl::ireference_flat_set<T, TKeyCompare>& rhs)
  {
    return !(lhs == rhs);
  }
} // namespace etl
 
#endif