mcrl2::utilities::unordered_set::unordered_set_iterator
===============================================================================


Include file:

.. code-block:: c++

   #include "mcrl2/utilities/unordered_set.h

.. cpp:class:: mcrl2::utilities::unordered_set::unordered_set_iterator

  An iterator over all elements in the unordered set. 

  

Private types
-------------------------------------------------------------------------------

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::bucket_it

  typedef for :cpp:type:`typename std::vector\< Bucket >::const_iterator`
  
  

  

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::key_it_type

  typedef for :cpp:type:`typename Bucket::const_iterator`
  
  

  

Public types
-------------------------------------------------------------------------------

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::difference_type

  typedef for :cpp:type:`std::ptrdiff_t`
  
  

  

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::iterator_category

  typedef for :cpp:type:`std::forward_iterator_tag`
  
  

  

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::pointer

  typedef for :cpp:type:`typename std::conditional\< Constant, const Key *, Key * >::type`
  
  

  

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::reference

  typedef for :cpp:type:`typename std::conditional\< Constant, const Key &, Key & >::type`
  
  

  

.. cpp:type:: mcrl2::utilities::unordered_set::unordered_set_iterator::value_type

  typedef for :cpp:type:`Key`
  
  

  

Friends
-------------------------------------------------------------------------------

friend class :cpp:type:`mcrl2::utilities::unordered_set::unordered_set_iterator::unordered_map`
  
  

  

friend class :cpp:type:`mcrl2::utilities::unordered_set::unordered_set_iterator::unordered_set`
  
  

  

Private attributes
-------------------------------------------------------------------------------

.. cpp:member:: bucket_it mcrl2::utilities::unordered_set::unordered_set_iterator::m_bucket_end
  
  

  

.. cpp:member:: bucket_it mcrl2::utilities::unordered_set::unordered_set_iterator::m_bucket_it
  
  

  

.. cpp:member:: key_it_type mcrl2::utilities::unordered_set::unordered_set_iterator::m_key_before_it
  
  

  

.. cpp:member:: key_it_type mcrl2::utilities::unordered_set::unordered_set_iterator::m_key_it
  
  

  

Public member functions
-------------------------------------------------------------------------------

.. cpp:function:: operator unordered_set_iterator< Bucket, true >() const
  
  

  

.. cpp:function:: bool operator!=(const unordered_set_iterator &other) const
  
  

  

.. cpp:function:: reference operator*() const
  
  

  

.. cpp:function:: unordered_set_iterator& operator++()
  
  

  

.. cpp:function:: unordered_set_iterator operator++(int)
  
  

  

.. cpp:function:: pointer operator->() const
  
  

  

.. cpp:function:: bool operator==(const unordered_set_iterator &other) const
  
  

  

.. cpp:function:: unordered_set_iterator()=default
  
  

  

Private member functions
-------------------------------------------------------------------------------

.. cpp:function:: bucket_it& get_bucket_it()
  
  

  
      
  **Returns:** A reference to the bucket iterator. 

.. cpp:function:: void goto_next_bucket()
  
  Iterate to the next non-empty bucket. 

  

.. cpp:function:: key_it_type& key_before_it()
  
  

  
      
  **Returns:** A reference to the before key iterator. 

.. cpp:function:: key_it_type& key_it()
  
  

  
      
  **Returns:** A reference to the key iterator. 

.. cpp:function:: operator unordered_set_iterator< Bucket, false >() const
  
  

  

.. cpp:function:: unordered_set_iterator(bucket_it it)
  
  Construct the end iterator. 

  

.. cpp:function:: unordered_set_iterator(bucket_it it, bucket_it end)
  
  Construct the begin iterator (over all elements). 

  

.. cpp:function:: unordered_set_iterator(bucket_it it, bucket_it end, key_it_type before_it, key_it_type key)
  
  Construct an iterator over all keys passed in this bucket and all remaining buckets.