Containers (STL-compatible) StateMachines MessageBus and more for Embedded Systems. See www.etlcpp.com

Revision:
0:b47c2a7920c2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/unordered_multiset.h	Fri Mar 16 16:34:18 2018 +0000
@@ -0,0 +1,1300 @@
+///\file
+
+/******************************************************************************
+The MIT License(MIT)
+
+Embedded Template Library.
+https://github.com/ETLCPP/etl
+http://www.etlcpp.com
+
+Copyright(c) 2016 jwellbelove
+
+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_UNORDERED_MULTISET__
+#define __ETL_UNORDERED_MULTISET__
+
+#include <stddef.h>
+#include <iterator>
+#include <functional>
+#include <iterator>
+#include <algorithm>
+#include <utility>
+
+#include "platform.h"
+#include "container.h"
+#include "pool.h"
+#include "vector.h"
+#include "intrusive_forward_list.h"
+#include "hash.h"
+#include "type_traits.h"
+#include "parameter_type.h"
+#include "nullptr.h"
+#include "error_handler.h"
+#include "exception.h"
+#include "debug_count.h"
+
+#undef ETL_FILE
+#define ETL_FILE "26"
+
+//*****************************************************************************
+///\defgroup unordered_multiset unordered_multiset
+/// A unordered_multiset with the capacity defined at compile time.
+///\ingroup containers
+//*****************************************************************************
+
+namespace etl
+{
+  //***************************************************************************
+  /// Exception for the unordered_multiset.
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  class unordered_multiset_exception : public etl::exception
+  {
+  public:
+
+    unordered_multiset_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
+      : etl::exception(reason_, file_name_, line_number_)
+    {
+    }
+  };
+
+  //***************************************************************************
+  /// Full exception for the unordered_multiset.
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  class unordered_multiset_full : public etl::unordered_multiset_exception
+  {
+  public:
+
+    unordered_multiset_full(string_type file_name_, numeric_type line_number_)
+      : etl::unordered_multiset_exception(ETL_ERROR_TEXT("unordered_multiset:full", ETL_FILE"A"), file_name_, line_number_)
+    {
+    }
+  };
+
+  //***************************************************************************
+  /// Out of range exception for the unordered_multiset.
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  class unordered_multiset_out_of_range : public etl::unordered_multiset_exception
+  {
+  public:
+
+    unordered_multiset_out_of_range(string_type file_name_, numeric_type line_number_)
+      : etl::unordered_multiset_exception(ETL_ERROR_TEXT("unordered_multiset:range", ETL_FILE"B"), file_name_, line_number_)
+    {}
+  };
+
+  //***************************************************************************
+  /// Iterator exception for the unordered_multiset.
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  class unordered_multiset_iterator : public etl::unordered_multiset_exception
+  {
+  public:
+
+    unordered_multiset_iterator(string_type file_name_, numeric_type line_number_)
+      : etl::unordered_multiset_exception(ETL_ERROR_TEXT("unordered_multiset:iterator", ETL_FILE"C"), file_name_, line_number_)
+    {
+    }
+  };
+
+  //***************************************************************************
+  /// The base class for specifically sized unordered_multiset.
+  /// Can be used as a reference type for all unordered_multiset containing a specific type.
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  template <typename TKey, typename THash = etl::hash<TKey>, typename TKeyEqual = std::equal_to<TKey> >
+  class iunordered_multiset
+  {
+  public:
+
+    typedef TKey              value_type;
+    typedef TKey              key_type;
+    typedef THash             hasher;
+    typedef TKeyEqual         key_equal;
+    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;
+
+    typedef typename etl::parameter_type<TKey>::type key_parameter_t;
+
+    typedef etl::forward_link<0> link_t;
+
+    // The nodes that store the elements.
+    struct node_t : public link_t
+    {
+      node_t(const value_type& key_)
+        : key(key_)
+      {
+      }
+
+      value_type key;
+    };
+
+  private:
+
+    typedef etl::intrusive_forward_list<node_t, link_t> bucket_t;
+    typedef etl::ipool pool_t;
+
+  public:
+
+    // Local iterators iterate over one bucket.
+    typedef typename bucket_t::iterator       local_iterator;
+    typedef typename bucket_t::const_iterator local_const_iterator;
+
+    //*********************************************************************
+    class iterator : public std::iterator<std::forward_iterator_tag, TKey>
+    {
+    public:
+
+      typedef typename iunordered_multiset::value_type      value_type;
+      typedef typename iunordered_multiset::key_type        key_type;
+      typedef typename iunordered_multiset::hasher          hasher;
+      typedef typename iunordered_multiset::key_equal       key_equal;
+      typedef typename iunordered_multiset::reference       reference;
+      typedef typename iunordered_multiset::const_reference const_reference;
+      typedef typename iunordered_multiset::pointer         pointer;
+      typedef typename iunordered_multiset::const_pointer   const_pointer;
+      typedef typename iunordered_multiset::size_type       size_type;
+
+      friend class iunordered_multiset;
+
+      //*********************************
+      iterator()
+      {
+      }
+
+      //*********************************
+      iterator(const iterator& other)
+        : pbuckets_end(other.pbuckets_end),
+        pbucket(other.pbucket),
+        inode(other.inode)
+      {
+      }
+
+      //*********************************
+      iterator& operator ++()
+      {
+        ++inode;
+
+        // The end of this node list?
+        if (inode == pbucket->end())
+        {
+          // Search for the next non-empty bucket.
+          ++pbucket;
+          while ((pbucket != pbuckets_end) && (pbucket->empty()))
+          {
+            ++pbucket;
+          }
+
+          // If not past the end, get the first node in the bucket.
+          if (pbucket != pbuckets_end)
+          {
+            inode = pbucket->begin();
+          }
+        }
+
+        return *this;
+      }
+
+      //*********************************
+      iterator operator ++(int)
+      {
+        iterator temp(*this);
+        operator++();
+        return temp;
+      }
+
+      //*********************************
+      iterator operator =(const iterator& other)
+      {
+        pbuckets_end = other.pbuckets_end;
+        pbucket = other.pbucket;
+        inode = other.inode;
+        return *this;
+      }
+
+      //*********************************
+      reference operator *()
+      {
+        return inode->key;
+      }
+
+      //*********************************
+      const_reference operator *() const
+      {
+        return inode->key;
+      }
+
+      //*********************************
+      pointer operator &()
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      const_pointer operator &() const
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      pointer operator ->()
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      const_pointer operator ->() const
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      friend bool operator == (const iterator& lhs, const iterator& rhs)
+      {
+        return lhs.compare(rhs);
+      }
+
+      //*********************************
+      friend bool operator != (const iterator& lhs, const iterator& rhs)
+      {
+        return !(lhs == rhs);
+      }
+
+    private:
+
+      //*********************************
+      iterator(bucket_t* pbuckets_end_, bucket_t* pbucket_, local_iterator inode_)
+        : pbuckets_end(pbuckets_end_),
+          pbucket(pbucket_),
+          inode(inode_)
+      {
+      }
+
+      //*********************************
+      bool compare(const iterator& rhs) const
+      {
+        return rhs.inode == inode;
+      }
+
+      //*********************************
+      bucket_t& get_bucket()
+      {
+        return *pbucket;
+      }
+
+      //*********************************
+      bucket_t*& get_bucket_list_iterator()
+      {
+        return pbucket;
+      }
+
+      //*********************************
+      local_iterator get_local_iterator()
+      {
+        return inode;
+      }
+
+      bucket_t* pbuckets_end;
+      bucket_t* pbucket;
+      local_iterator inode;
+    };
+
+    //*********************************************************************
+    class const_iterator : public std::iterator<std::forward_iterator_tag, const TKey>
+    {
+    public:
+
+      typedef typename iunordered_multiset::value_type      value_type;
+      typedef typename iunordered_multiset::key_type        key_type;
+      typedef typename iunordered_multiset::hasher          hasher;
+      typedef typename iunordered_multiset::key_equal       key_equal;
+      typedef typename iunordered_multiset::reference       reference;
+      typedef typename iunordered_multiset::const_reference const_reference;
+      typedef typename iunordered_multiset::pointer         pointer;
+      typedef typename iunordered_multiset::const_pointer   const_pointer;
+      typedef typename iunordered_multiset::size_type       size_type;
+
+      friend class iunordered_multiset;
+      friend class iterator;
+
+      //*********************************
+      const_iterator()
+      {
+      }
+
+      //*********************************
+      const_iterator(const typename iunordered_multiset::iterator& other)
+        : pbuckets_end(other.pbuckets_end),
+        pbucket(other.pbucket),
+        inode(other.inode)
+      {
+      }
+
+      //*********************************
+      const_iterator(const const_iterator& other)
+        : pbuckets_end(other.pbuckets_end),
+        pbucket(other.pbucket),
+        inode(other.inode)
+      {
+      }
+
+      //*********************************
+      const_iterator& operator ++()
+      {
+        ++inode;
+
+        // The end of this node list?
+        if (inode == pbucket->end())
+        {
+          // Search for the next non-empty bucket.
+
+          ++pbucket;
+          while ((pbucket != pbuckets_end) && (pbucket->empty()))
+          {
+            ++pbucket;
+          }
+
+          // If not past the end, get the first node in the bucket.
+          if (pbucket != pbuckets_end)
+          {
+            inode = pbucket->begin();
+          }
+        }
+
+        return *this;
+      }
+
+      //*********************************
+      const_iterator operator ++(int)
+      {
+        const_iterator temp(*this);
+        operator++();
+        return temp;
+      }
+
+      //*********************************
+      const_iterator operator =(const const_iterator& other)
+      {
+        pbuckets_end = other.pbuckets_end;
+        pbucket = other.pbucket;
+        inode = other.inode;
+        return *this;
+      }
+
+      //*********************************
+      const_reference operator *() const
+      {
+        return inode->key;
+      }
+
+      //*********************************
+      const_pointer operator &() const
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      const_pointer operator ->() const
+      {
+        return &(inode->key);
+      }
+
+      //*********************************
+      friend bool operator == (const const_iterator& lhs, const const_iterator& rhs)
+      {
+        return lhs.compare(rhs);
+      }
+
+      //*********************************
+      friend bool operator != (const const_iterator& lhs, const const_iterator& rhs)
+      {
+        return !(lhs == rhs);
+      }
+
+    private:
+
+      //*********************************
+      const_iterator(bucket_t* pbuckets_end_, bucket_t* pbucket_, local_iterator inode_)
+        : pbuckets_end(pbuckets_end_),
+          pbucket(pbucket_),
+          inode(inode_)
+      {
+      }
+
+      //*********************************
+      bool compare(const const_iterator& rhs) const
+      {
+        return rhs.inode == inode;
+      }
+
+      //*********************************
+      bucket_t& get_bucket()
+      {
+        return *pbucket;
+      }
+
+      //*********************************
+      bucket_t*& get_bucket_list_iterator()
+      {
+        return pbucket;
+      }
+
+      //*********************************
+      local_iterator get_local_iterator()
+      {
+        return inode;
+      }
+
+      bucket_t* pbuckets_end;
+      bucket_t* pbucket;
+      local_iterator inode;
+    };
+
+    typedef typename std::iterator_traits<iterator>::difference_type difference_type;
+
+    //*********************************************************************
+    /// Returns an iterator to the beginning of the unordered_multiset.
+    ///\return An iterator to the beginning of the unordered_multiset.
+    //*********************************************************************
+    iterator begin()
+    {
+      return iterator((pbuckets + number_of_buckets), first, first->begin());
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the beginning of the unordered_multiset.
+    ///\return A const iterator to the beginning of the unordered_multiset.
+    //*********************************************************************
+    const_iterator begin() const
+    {
+      return const_iterator((pbuckets + number_of_buckets), first, first->begin());
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the beginning of the unordered_multiset.
+    ///\return A const iterator to the beginning of the unordered_multiset.
+    //*********************************************************************
+    const_iterator cbegin() const
+    {
+      return const_iterator((pbuckets + number_of_buckets), first, first->begin());
+    }
+
+    //*********************************************************************
+    /// Returns an iterator to the beginning of the unordered_multiset bucket.
+    ///\return An iterator to the beginning of the unordered_multiset bucket.
+    //*********************************************************************
+    local_iterator begin(size_t i)
+    {
+      return pbuckets[i].begin();
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the beginning of the unordered_multiset bucket.
+    ///\return A const iterator to the beginning of the unordered_multiset bucket.
+    //*********************************************************************
+    local_const_iterator begin(size_t i) const
+    {
+      return pbuckets[i].cbegin();
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the beginning of the unordered_multiset bucket.
+    ///\return A const iterator to the beginning of the unordered_multiset bucket.
+    //*********************************************************************
+    local_const_iterator cbegin(size_t i) const
+    {
+      return pbuckets[i].cbegin();
+    }
+
+    //*********************************************************************
+    /// Returns an iterator to the end of the unordered_multiset.
+    ///\return An iterator to the end of the unordered_multiset.
+    //*********************************************************************
+    iterator end()
+    {
+      return iterator((pbuckets + number_of_buckets), last, last->end());
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the end of the unordered_multiset.
+    ///\return A const iterator to the end of the unordered_multiset.
+    //*********************************************************************
+    const_iterator end() const
+    {
+      return const_iterator((pbuckets + number_of_buckets), last, last->end());
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the end of the unordered_multiset.
+    ///\return A const iterator to the end of the unordered_multiset.
+    //*********************************************************************
+    const_iterator cend() const
+    {
+      return const_iterator((pbuckets + number_of_buckets), last, last->end());
+    }
+
+    //*********************************************************************
+    /// Returns an iterator to the end of the unordered_multiset bucket.
+    ///\return An iterator to the end of the unordered_multiset bucket.
+    //*********************************************************************
+    local_iterator end(size_t i)
+    {
+      return pbuckets[i].end();
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the end of the unordered_multiset bucket.
+    ///\return A const iterator to the end of the unordered_multiset bucket.
+    //*********************************************************************
+    local_const_iterator end(size_t i) const
+    {
+      return pbuckets[i].cend();
+    }
+
+    //*********************************************************************
+    /// Returns a const_iterator to the end of the unordered_multiset bucket.
+    ///\return A const iterator to the end of the unordered_multiset bucket.
+    //*********************************************************************
+    local_const_iterator cend(size_t i) const
+    {
+      return pbuckets[i].cend();
+    }
+
+    //*********************************************************************
+    /// Returns the bucket index for the key.
+    ///\return The bucket index for the key.
+    //*********************************************************************
+    size_type get_bucket_index(key_parameter_t key) const
+    {
+      return key_hash_function(key) % number_of_buckets;
+    }
+
+    //*********************************************************************
+    /// Returns the size of the bucket key.
+    ///\return The bucket size of the bucket key.
+    //*********************************************************************
+    size_type bucket_size(key_parameter_t key) const
+    {
+      size_t index = bucket(key);
+
+      return std::distance(pbuckets[index].begin(), pbuckets[index].end());
+    }
+
+    //*********************************************************************
+    /// Returns the maximum number of the buckets the container can hold.
+    ///\return The maximum number of the buckets the container can hold.
+    //*********************************************************************
+    size_type max_bucket_count() const
+    {
+      return number_of_buckets;
+    }
+
+    //*********************************************************************
+    /// Returns the number of the buckets the container holds.
+    ///\return The number of the buckets the container holds.
+    //*********************************************************************
+    size_type bucket_count() const
+    {
+      return number_of_buckets;
+    }
+
+    //*********************************************************************
+    /// Assigns values to the unordered_multiset.
+    /// If asserts or exceptions are enabled, emits unordered_multiset_full if the unordered_multiset does not have enough free space.
+    /// If asserts or exceptions are enabled, emits unordered_multiset_iterator if the iterators are reversed.
+    ///\param first The iterator to the first element.
+    ///\param last  The iterator to the last element + 1.
+    //*********************************************************************
+    template <typename TIterator>
+    void assign(TIterator first_, TIterator last_)
+    {
+#if defined(ETL_DEBUG)
+      difference_type d = std::distance(first_, last_);
+      ETL_ASSERT(d >= 0, ETL_ERROR(unordered_multiset_iterator));
+      ETL_ASSERT(size_t(d) <= max_size(), ETL_ERROR(unordered_multiset_full));
+#endif
+
+      clear();
+
+      while (first_ != last_)
+      {
+        insert(*first_++);
+      }
+    }
+
+    //*********************************************************************
+    /// Inserts a value to the unordered_multiset.
+    /// If asserts or exceptions are enabled, emits unordered_multiset_full if the unordered_multiset is already full.
+    ///\param value The value to insert.
+    //*********************************************************************
+    std::pair<iterator, bool> insert(const value_type& key)
+    {
+      std::pair<iterator, bool> result(end(), false);
+
+      ETL_ASSERT(!full(), ETL_ERROR(unordered_multiset_full));
+
+      // Get the hash index.
+      size_t index = get_bucket_index(key);
+
+      // Get the bucket & bucket iterator.
+      bucket_t* pbucket = pbuckets + index;
+      bucket_t& bucket = *pbucket;
+
+      // The first one in the bucket?
+      if (bucket.empty())
+      {
+        // Get a new node.
+        node_t& node = *pnodepool->allocate<node_t>();
+        ::new (&node.key) value_type(key);
+        ++construct_count;
+
+        // Just add the pointer to the bucket;
+        bucket.insert_after(bucket.before_begin(), node);
+
+        result.first = iterator((pbuckets + number_of_buckets), pbucket, pbucket->begin());
+        result.second = true;
+
+        adjust_first_last_markers(pbucket);
+      }
+      else
+      {
+        // Step though the bucket looking for a place to insert.
+        local_iterator inode_previous = bucket.before_begin();
+        local_iterator inode = bucket.begin();
+
+        while (inode != bucket.end())
+        {
+          // Do we already have this key?
+          if (inode->key == key)
+          {
+            break;
+          }
+
+          ++inode_previous;
+          ++inode;
+        }
+
+        // Get a new node.
+        node_t& node = *pnodepool->allocate<node_t>();
+        ::new (&node.key) value_type(key);
+        ++construct_count;
+
+        // Add the node to the end of the bucket;
+        bucket.insert_after(inode_previous, node);
+        ++inode_previous;
+
+        result.first = iterator((pbuckets + number_of_buckets), pbucket, inode_previous);
+        result.second = true;
+      }
+
+      return result;
+    }
+
+    //*********************************************************************
+    /// Inserts a value to the unordered_multiset.
+    /// If asserts or exceptions are enabled, emits unordered_multiset_full if the unordered_multiset is already full.
+    ///\param position The position to insert at.
+    ///\param value    The value to insert.
+    //*********************************************************************
+    iterator insert(const_iterator position, const value_type& key)
+    {
+      return insert(key).first;
+    }
+
+    //*********************************************************************
+    /// Inserts a range of values to the unordered_multiset.
+    /// If asserts or exceptions are enabled, emits unordered_multiset_full if the unordered_multiset does not have enough free space.
+    ///\param position The position to insert at.
+    ///\param first    The first element to add.
+    ///\param last     The last + 1 element to add.
+    //*********************************************************************
+    template <class TIterator>
+    void insert(TIterator first_, TIterator last_)
+    {
+      while (first_ != last_)
+      {
+        insert(*first_++);
+      }
+    }
+
+    //*********************************************************************
+    /// Erases an element.
+    ///\param key The key to erase.
+    ///\return The number of elements erased.
+    //*********************************************************************
+    size_t erase(key_parameter_t key)
+    {
+      size_t n = 0;
+      size_t bucket_id = get_bucket_index(key);
+
+      bucket_t& bucket = pbuckets[bucket_id];
+
+      local_iterator iprevious = bucket.before_begin();
+      local_iterator icurrent = bucket.begin();
+
+      while (icurrent != bucket.end())
+      {
+        if (icurrent->key == key)
+        {
+          bucket.erase_after(iprevious);  // Unlink from the bucket.
+          icurrent->key.~value_type();    // Destroy the value.
+          pnodepool->release(&*icurrent); // Release it back to the pool.
+          ++n;
+          icurrent = iprevious;
+          --construct_count;
+        }
+        else
+        {
+          ++iprevious;
+        }
+
+        ++icurrent;
+      }
+
+      return n;
+    }
+
+    //*********************************************************************
+    /// Erases an element.
+    ///\param ielement Iterator to the element.
+    //*********************************************************************
+    iterator erase(const_iterator ielement)
+    {
+      // Make a note of the next one.
+      iterator inext((pbuckets + number_of_buckets), ielement.get_bucket_list_iterator(), ielement.get_local_iterator());
+      ++inext;
+
+      bucket_t&      bucket = ielement.get_bucket();
+      local_iterator iprevious = bucket.before_begin();
+      local_iterator icurrent = ielement.get_local_iterator();
+
+      // Find the node previous to the one we're interested in.
+      while (iprevious->etl_next != &*icurrent)
+      {
+        ++iprevious;
+      }
+
+      bucket.erase_after(iprevious);  // Unlink from the bucket.
+      icurrent->key.~value_type();    // Destroy the value.
+      pnodepool->release(&*icurrent); // Release it back to the pool.
+      --construct_count;
+
+      return inext;
+    }
+
+    //*********************************************************************
+    /// Erases a range of elements.
+    /// The range includes all the elements between first and last, including the
+    /// element pointed by first, but not the one pointed to by last.
+    ///\param first Iterator to the first element.
+    ///\param last  Iterator to the last element.
+    //*********************************************************************
+    iterator erase(const_iterator first_, const_iterator last_)
+    {
+      // Make a note of the last.
+      iterator result((pbuckets + number_of_buckets), last_.get_bucket_list_iterator(), last_.get_local_iterator());
+
+      // Get the starting point.
+      bucket_t*      pbucket   = first_.get_bucket_list_iterator();
+      local_iterator iprevious = pbucket->before_begin();
+      local_iterator icurrent  = first_.get_local_iterator();
+      local_iterator iend      = last_.get_local_iterator(); // Note: May not be in the same bucket as icurrent.
+
+                                                       // Find the node previous to the first one.
+      while (iprevious->etl_next != &*icurrent)
+      {
+        ++iprevious;
+      }
+
+      while (icurrent != iend)
+      {
+
+        local_iterator inext = pbucket->erase_after(iprevious); // Unlink from the bucket.
+        icurrent->key.~value_type();    // Destroy the value.
+        pnodepool->release(&*icurrent); // Release it back to the pool.
+        --construct_count;
+
+        icurrent = inext;
+
+        // Are we there yet?
+        if (icurrent != iend)
+        {
+          // At the end of this bucket?
+          if ((icurrent == pbucket->end()))
+          {
+            // Find the next non-empty one.
+            do
+            {
+              ++pbucket;
+            } while (pbucket->empty());
+
+            iprevious = pbucket->before_begin();
+            icurrent = pbucket->begin();
+          }
+        }
+      }
+
+      return result;
+    }
+
+    //*************************************************************************
+    /// Clears the unordered_multiset.
+    //*************************************************************************
+    void clear()
+    {
+      initialise();
+    }
+
+    //*********************************************************************
+    /// Counts an element.
+    ///\param key The key to search for.
+    ///\return 1 if the key exists, otherwise 0.
+    //*********************************************************************
+    size_t count(key_parameter_t key) const
+    {
+      size_t n = 0;
+      const_iterator f = find(key);
+      const_iterator l = f;
+
+      if (l != end())
+      {
+        ++l;
+        ++n;
+
+        while ((l != end()) && (key == *l))
+        {
+          ++l;
+          ++n;
+        }
+      }
+
+      return n;
+    }
+
+    //*********************************************************************
+    /// Finds an element.
+    ///\param key The key to search for.
+    ///\return An iterator to the element if the key exists, otherwise end().
+    //*********************************************************************
+    iterator find(key_parameter_t key)
+    {
+      size_t index = get_bucket_index(key);
+
+      bucket_t* pbucket = pbuckets + index;
+      bucket_t& bucket = *pbucket;
+
+      // Is the bucket not empty?
+      if (!bucket.empty())
+      {
+        // Step though the list until we find the end or an equivalent key.
+        local_iterator inode = bucket.begin();
+        local_iterator iend = bucket.end();
+
+        while (inode != iend)
+        {
+          // Do we have this one?
+          if (key_equal_function(key, inode->key))
+          {
+            return iterator((pbuckets + number_of_buckets), pbucket, inode);
+          }
+
+          ++inode;
+        }
+      }
+
+      return end();
+    }
+
+    //*********************************************************************
+    /// Finds an element.
+    ///\param key The key to search for.
+    ///\return An iterator to the element if the key exists, otherwise end().
+    //*********************************************************************
+    const_iterator find(key_parameter_t key) const
+    {
+      size_t index = get_bucket_index(key);
+
+      bucket_t* pbucket = pbuckets + index;
+      bucket_t& bucket = *pbucket;
+
+      // Is the bucket not empty?
+      if (!bucket.empty())
+      {
+        // Step though the list until we find the end or an equivalent key.
+        local_iterator inode = bucket.begin();
+        local_iterator iend = bucket.end();
+
+        while (inode != iend)
+        {
+          // Do we have this one?
+          if (key_equal_function(key, inode->key))
+          {
+            return iterator((pbuckets + number_of_buckets), pbucket, inode);
+          }
+
+          ++inode;
+        }
+      }
+
+      return end();
+    }
+
+    //*********************************************************************
+    /// Returns a range containing all elements with key key in the container.
+    /// The range is defined by two iterators, the first pointing to the first
+    /// element of the wanted range and the second pointing past the last
+    /// element of the range.
+    ///\param key The key to search for.
+    ///\return An iterator pair to the range of elements if the key exists, otherwise end().
+    //*********************************************************************
+    std::pair<iterator, iterator> equal_range(key_parameter_t key)
+    {
+      iterator f = find(key);
+      iterator l = f;
+
+      if (l != end())
+      {
+        ++l;
+
+        while ((l != end()) && (key == *l))
+        {
+          ++l;
+        }
+      }
+
+      return std::pair<iterator, iterator>(f, l);
+    }
+
+    //*********************************************************************
+    /// Returns a range containing all elements with key key in the container.
+    /// The range is defined by two iterators, the first pointing to the first
+    /// element of the wanted range and the second pointing past the last
+    /// element of the range.
+    ///\param key The key to search for.
+    ///\return A const iterator pair to the range of elements if the key exists, otherwise end().
+    //*********************************************************************
+    std::pair<const_iterator, const_iterator> equal_range(key_parameter_t key) const
+    {
+      const_iterator f = find(key);
+      const_iterator l = f;
+
+      if (l != end())
+      {
+        ++l;
+
+        while ((l != end()) && (key == *l))
+        {
+          ++l;
+        }
+      }
+
+      return std::pair<const_iterator, const_iterator>(f, l);
+    }
+
+    //*************************************************************************
+    /// Gets the size of the unordered_multiset.
+    //*************************************************************************
+    size_type size() const
+    {
+      return pnodepool->size();
+    }
+
+    //*************************************************************************
+    /// Gets the maximum possible size of the unordered_multiset.
+    //*************************************************************************
+    size_type max_size() const
+    {
+      return pnodepool->max_size();
+    }
+
+    //*************************************************************************
+    /// Checks to see if the unordered_multiset is empty.
+    //*************************************************************************
+    bool empty() const
+    {
+      return pnodepool->empty();
+    }
+
+    //*************************************************************************
+    /// Checks to see if the unordered_multiset is full.
+    //*************************************************************************
+    bool full() const
+    {
+      return pnodepool->full();
+    }
+
+    //*************************************************************************
+    /// Returns the remaining capacity.
+    ///\return The remaining capacity.
+    //*************************************************************************
+    size_t available() const
+    {
+      return pnodepool->available();
+    }
+
+    //*************************************************************************
+    /// Returns the load factor = size / bucket_count.
+    ///\return The load factor = size / bucket_count.
+    //*************************************************************************
+    float load_factor() const
+    {
+      return static_cast<float>(size()) / static_cast<float>(bucket_count());
+    }
+
+    //*************************************************************************
+    /// Returns the function that hashes the keys.
+    ///\return The function that hashes the keys..
+    //*************************************************************************
+    hasher hash_function() const
+    {
+      return key_hash_function;
+    }
+
+    //*************************************************************************
+    /// Returns the function that compares the keys.
+    ///\return The function that compares the keys..
+    //*************************************************************************
+    key_equal key_eq() const
+    {
+      return key_equal_function;
+    }
+
+    //*************************************************************************
+    /// Assignment operator.
+    //*************************************************************************
+    iunordered_multiset& operator = (const iunordered_multiset& rhs)
+    {
+      // Skip if doing self assignment
+      if (this != &rhs)
+      {
+        assign(rhs.cbegin(), rhs.cend());
+      }
+
+      return *this;
+    }
+
+  protected:
+
+    //*********************************************************************
+    /// Constructor.
+    //*********************************************************************
+    iunordered_multiset(pool_t& node_pool_, bucket_t* pbuckets_, size_t number_of_buckets_)
+      : pnodepool(&node_pool_),
+        pbuckets(pbuckets_),
+        number_of_buckets(number_of_buckets_)
+    {
+    }
+
+    //*********************************************************************
+    /// Initialise the unordered_multiset.
+    //*********************************************************************
+    void initialise()
+    {
+      if (!empty())
+      {
+        // For each bucket...
+        for (size_t i = 0; i < number_of_buckets; ++i)
+        {
+          bucket_t& bucket = pbuckets[i];
+
+          if (!bucket.empty())
+          {
+            // For each item in the bucket...
+            local_iterator it = bucket.begin();
+
+            while (it != bucket.end())
+            {
+              // Destroy the value contents.
+              it->key.~value_type();
+              ++it;
+              --construct_count;
+            }
+
+            // Now it's safe to clear the bucket.
+            bucket.clear();
+          }
+        }
+
+        // Now it's safe to clear the entire pool in one go.
+        pnodepool->release_all();
+      }
+
+      first = pbuckets;
+      last = first;
+    }
+
+  private:
+
+    //*********************************************************************
+    /// Adjust the first and last markers according to the new entry.
+    //*********************************************************************
+    void adjust_first_last_markers(bucket_t* pbucket)
+    {
+      if (pbucket < first)
+      {
+        first = pbucket;
+      }
+      else if (pbucket > last)
+      {
+        last = pbucket;
+      }
+    }
+
+    // Disable copy construction.
+    iunordered_multiset(const iunordered_multiset&);
+
+    /// The pool of data nodes used in the list.
+    pool_t* pnodepool;
+
+    /// The bucket list.
+    bucket_t* pbuckets;
+
+    /// The number of buckets.
+    const size_t number_of_buckets;
+
+    /// The first and last iterators to buckets with values.
+    bucket_t* first;
+    bucket_t* last;
+
+    /// The function that creates the hashes.
+    hasher key_hash_function;
+
+    /// The function that compares the keys for equality.
+    key_equal key_equal_function;
+
+    /// For library debugging purposes only.
+    etl::debug_count construct_count;
+  };
+
+  //***************************************************************************
+  /// Equal operator.
+  ///\param lhs Reference to the first unordered_multiset.
+  ///\param rhs Reference to the second unordered_multiset.
+  ///\return <b>true</b> if the arrays are equal, otherwise <b>false</b>
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  template <typename TKey, typename TMapped, typename TKeyCompare>
+  bool operator ==(const etl::iunordered_multiset<TKey, TMapped, TKeyCompare>& lhs, const etl::iunordered_multiset<TKey, TMapped, TKeyCompare>& rhs)
+  {
+    return (lhs.size() == rhs.size()) && std::equal(lhs.begin(), lhs.end(), rhs.begin());
+  }
+
+  //***************************************************************************
+  /// Not equal operator.
+  ///\param lhs Reference to the first unordered_multiset.
+  ///\param rhs Reference to the second unordered_multiset.
+  ///\return <b>true</b> if the arrays are not equal, otherwise <b>false</b>
+  ///\ingroup unordered_multiset
+  //***************************************************************************
+  template <typename TKey, typename TMapped, typename TKeyCompare>
+  bool operator !=(const etl::iunordered_multiset<TKey, TMapped, TKeyCompare>& lhs, const etl::iunordered_multiset<TKey, TMapped, TKeyCompare>& rhs)
+  {
+    return !(lhs == rhs);
+  }
+
+  //*************************************************************************
+  /// A templated unordered_multiset implementation that uses a fixed size buffer.
+  //*************************************************************************
+  template <typename TKey, const size_t MAX_SIZE_, size_t MAX_BUCKETS_ = MAX_SIZE_, typename THash = etl::hash<TKey>, typename TKeyEqual = std::equal_to<TKey> >
+  class unordered_multiset : public etl::iunordered_multiset<TKey, THash, TKeyEqual>
+  {
+  private:
+
+    typedef etl::iunordered_multiset<TKey, THash, TKeyEqual> base;
+
+  public:
+
+    static const size_t MAX_SIZE = MAX_SIZE_;
+    static const size_t MAX_BUCKETS = MAX_BUCKETS_;
+
+
+    //*************************************************************************
+    /// Default constructor.
+    //*************************************************************************
+    unordered_multiset()
+      : base(node_pool, buckets, MAX_BUCKETS)
+    {
+      base::initialise();
+    }
+
+    //*************************************************************************
+    /// Copy constructor.
+    //*************************************************************************
+    unordered_multiset(const unordered_multiset& other)
+      : base(node_pool, buckets, MAX_BUCKETS)
+    {
+      base::assign(other.cbegin(), other.cend());
+    }
+
+    //*************************************************************************
+    /// Constructor, from an iterator range.
+    ///\tparam TIterator The iterator type.
+    ///\param first The iterator to the first element.
+    ///\param last  The iterator to the last element + 1.
+    //*************************************************************************
+    template <typename TIterator>
+    unordered_multiset(TIterator first_, TIterator last_)
+      : base(node_pool, buckets, MAX_BUCKETS)
+    {
+      base::assign(first_, last_);
+    }
+
+    //*************************************************************************
+    /// Destructor.
+    //*************************************************************************
+    ~unordered_multiset()
+    {
+      base::initialise();
+    }
+
+    //*************************************************************************
+    /// Assignment operator.
+    //*************************************************************************
+    unordered_multiset& operator = (const unordered_multiset& rhs)
+    {
+      // Skip if doing self assignment
+      if (this != &rhs)
+      {
+        base::assign(rhs.cbegin(), rhs.cend());
+      }
+
+      return *this;
+    }
+
+  private:
+
+    /// The pool of nodes used for the unordered_multiset.
+    etl::pool<typename base::node_t, MAX_SIZE> node_pool;
+
+    /// The buckets of node lists.
+    etl::intrusive_forward_list<typename base::node_t> buckets[MAX_BUCKETS_];
+  };
+}
+
+#undef ETL_FILE
+
+#endif
+