__gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >(3)
                                                      Library Functions Manual

NAME
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer > - Safe
       iterator wrapper.


SYNOPSIS
       #include <safe_local_iterator.h>

       Inherits .

   Public Types
       typedef _Traits::difference_type difference_type
       typedef _Traits::iterator_category iterator_category
       typedef _Iterator iterator_type
       typedef _Traits::pointer pointer
       typedef _Traits::reference reference
       typedef _Traits::value_type value_type

   Public Member Functions
       _Safe_local_iterator () noexcept
       _Safe_local_iterator (_Iterator __i, const
           _Safe_unordered_container_base *__cont)
           Safe iterator construction from an unsafe iterator and its
           unordered container.
       _Safe_local_iterator (_Safe_local_iterator &&__x) noexcept
           Move construction.
       _Safe_local_iterator (const _Safe_local_iterator &__x) noexcept
           Copy construction.
       template<typename _MutableIterator> _Safe_local_iterator (const
           _Safe_local_iterator< _MutableIterator, typename
           __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same<
           _MutableIterator, _OtherIterator >::__value, _UContainer >::__type
           > &__x) noexcept
           Converting constructor from a mutable iterator to a constant
           iterator.
       void _M_attach (const _Safe_unordered_container_base *__cont)
       void _M_attach_single (const _Safe_unordered_container_base *__cont)
       bool _M_attached_to (const _Safe_sequence_base *__seq) const
       bool _M_can_compare (const _Safe_iterator_base &__x) const noexcept
       bool _M_dereferenceable () const
           Is the iterator dereferenceable?
       _Distance_traits< _Iterator >::__type _M_get_distance_to (const
           _Safe_local_iterator &__rhs) const
       std::__conditional_t< _IsConstant::__value, const _UContainer *,
           _UContainer * > _M_get_ucontainer () const
       template<typename _Other> bool _M_in_same_bucket (const
           _Safe_local_iterator< _Other, _UContainer > &__other) const
           Is this iterator part of the same bucket as the other one?
       bool _M_incrementable () const
           Is the iterator incrementable?
       void _M_invalidate ()
       bool _M_is_begin () const
           Is this iterator equal to the container's begin(bucket) iterator?
       bool _M_is_end () const
           Is this iterator equal to the container's end(bucket) iterator?
       void _M_reset () noexcept
       const _Safe_unordered_container_base * _M_safe_container () const
           noexcept
       bool _M_singular () const noexcept
       void _M_unlink () noexcept
       bool _M_valid_range (const _Safe_local_iterator &__rhs, std::pair<
           difference_type, _Distance_precision > &__dist_info) const
       bool _M_value_initialized () const
           Is the iterator value-initialized?
       const _Iterator & base () const noexcept
       _Iterator & base () noexcept
           Return the underlying iterator.
       size_type bucket () const
           Return the bucket.
       operator _Iterator () const
           Conversion to underlying non-debug iterator to allow better
           interaction with non-debug containers.
       reference operator* () const
           Iterator dereference.
       _Safe_local_iterator & operator++ ()
           Iterator preincrement.
       _Safe_local_iterator operator++ (int)
           Iterator postincrement.
       pointer operator-> () const
           Iterator dereference.
       _Safe_local_iterator & operator= (_Safe_local_iterator &&__x) noexcept
           Move assignment.
       _Safe_local_iterator & operator= (const _Safe_local_iterator &__x)
           Copy assignment.

   Static Public Member Functions
       static constexpr bool _S_constant ()
           Determine if this is a constant iterator.

   Public Attributes
       _Safe_iterator_base * _M_next
       _Safe_iterator_base * _M_prior
       const _Safe_sequence_base * _M_sequence
       unsigned int _M_version

   Protected Member Functions
       void _M_attach (const _Safe_sequence_base *__seq, bool __constant)
       void _M_attach (const _Safe_unordered_container_base *__cont, bool
           __constant)
       void _M_attach_single (const _Safe_sequence_base *__seq, bool
           __constant) noexcept
       void _M_attach_single (const _Safe_unordered_container_base *__cont,
           bool __constant) noexcept
       void _M_detach ()
       void _M_detach_single () noexcept
       __gnu_cxx::__mutex & _M_get_mutex () noexcept

   Friends
       bool operator!= (const _Self &__lhs, const _OtherSelf &__rhs) noexcept
       bool operator!= (const _Self &__lhs, const _Self &__rhs) noexcept
       bool operator== (const _Self &__lhs, const _OtherSelf &__rhs) noexcept
       bool operator== (const _Self &__lhs, const _Self &__rhs) noexcept

Detailed Description
   template<typename _Iterator, typename _UContainer>
       class __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >"Safe
       iterator wrapper.

       The class template _Safe_local_iterator is a wrapper around an iterator
       that tracks the iterator's movement among unordered containers and
       checks that operations performed on the "safe" iterator are legal. In
       additional to the basic iterator operations (which are validated, and
       then passed to the underlying iterator), _Safe_local_iterator has
       member functions for iterator invalidation, attaching/detaching the
       iterator from unordered containers, and querying the iterator's state.

Constructor & Destructor Documentation
   template<typename _Iterator, typename _UContainer>
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_Safe_local_iterator () [inline],  [noexcept]
       Postcondition
           the iterator is singular and unattached

   template<typename _Iterator, typename _UContainer>
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_Safe_local_iterator (_Iterator __i, const
       _Safe_unordered_container_base * __cont) [inline]
       Safe iterator construction from an unsafe iterator and its unordered
       container.

       Precondition
           cont is not NULL

       Postcondition
           this is not singular

   template<typename _Iterator, typename _UContainer>
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_Safe_local_iterator (const _Safe_local_iterator< _Iterator,
       _UContainer > & __x) [inline],  [noexcept]
       Copy construction.

   template<typename _Iterator, typename _UContainer>
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_Safe_local_iterator (_Safe_local_iterator< _Iterator, _UContainer >
       && __x) [inline],  [noexcept]
       Move construction.

       Postcondition
           __x is singular and unattached

   template<typename _Iterator, typename _UContainer> template<typename
       _MutableIterator> __gnu_debug::_Safe_local_iterator< _Iterator,
       _UContainer >::_Safe_local_iterator (const _Safe_local_iterator<
       _MutableIterator, typename __gnu_cxx::__enable_if< _IsConstant::__value
       &&std::__are_same< _MutableIterator, _OtherIterator >::__value,
       _UContainer >::__type > & __x) [inline],  [noexcept]
       Converting constructor from a mutable iterator to a constant iterator.

Member Function Documentation
   void __gnu_debug::_Safe_iterator_base::_M_attach (const _Safe_sequence_base
       * __seq, bool __constant) [protected],  [inherited]
       Attaches this iterator to the given sequence, detaching it from
       whatever sequence it was attached to originally. If the new sequence is
       the NULL pointer, the iterator is left unattached.

       References _M_attach().

       Referenced by _Safe_iterator_base(), _Safe_iterator_base(),
       __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach(), and
       _M_attach().

   template<typename _Iterator, typename _UContainer> void
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::_M_attach
       (const _Safe_unordered_container_base * __cont) [inline]
       Attach iterator to the given unordered container.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator=().

   void __gnu_debug::_Safe_local_iterator_base::_M_attach (const
       _Safe_unordered_container_base * __cont, bool __constant) [protected],
       [inherited]
       Attaches this iterator to the given container, detaching it from
       whatever container it was attached to originally. If the new container
       is the NULL pointer, the iterator is left unattached.

       Referenced by _Safe_local_iterator_base(), _Safe_local_iterator_base(),
       and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_M_attach().

   void __gnu_debug::_Safe_iterator_base::_M_attach_single (const
       _Safe_sequence_base * __seq, bool __constant) [protected],  [noexcept],
       [inherited]
       Likewise, but not thread-safe.

       References _M_attach_single().

       Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_M_attach_single(), and _M_attach_single().

   template<typename _Iterator, typename _UContainer> void
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_attach_single (const _Safe_unordered_container_base * __cont)
       [inline]
       Likewise, but not thread-safe.

   void __gnu_debug::_Safe_local_iterator_base::_M_attach_single (const
       _Safe_unordered_container_base * __cont, bool __constant) [protected],
       [noexcept],  [inherited]
       Likewise, but not thread-safe.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_M_attach_single().

   bool __gnu_debug::_Safe_iterator_base::_M_attached_to (const
       _Safe_sequence_base * __seq) const [inline],  [inherited]
       Determines if we are attached to the given sequence.

       References _M_attached_to(), and _M_sequence.

       Referenced by _M_attached_to().

   bool __gnu_debug::_Safe_iterator_base::_M_can_compare (const
       _Safe_iterator_base & __x) const [noexcept],  [inherited]
       Can we compare this iterator to the given iterator __x? Returns true if
       both iterators are nonsingular and reference the same sequence.

       References _Safe_iterator_base(), and _M_can_compare().

       Referenced by _M_can_compare().

   template<typename _Iterator, typename _UContainer> bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_dereferenceable () const [inline]
       Is the iterator dereferenceable?

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator*(), and __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator->().

   void __gnu_debug::_Safe_local_iterator_base::_M_detach () [protected],
       [inherited]
       Detach the iterator for whatever container it is attached to, if any.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator=().

   void __gnu_debug::_Safe_local_iterator_base::_M_detach_single ()
       [protected],  [noexcept],  [inherited]
       Likewise, but not thread-safe.

   __gnu_cxx::__mutex & __gnu_debug::_Safe_iterator_base::_M_get_mutex ()
       [protected],  [noexcept],  [inherited]
       For use in _Safe_iterator.

       Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::operator++(), __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator++(), __gnu_debug::_Safe_iterator<
       _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator<
       _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator=(), and
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=().

   template<typename _Iterator, typename _UContainer> template<typename
       _Other> bool __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_in_same_bucket (const _Safe_local_iterator< _Other, _UContainer >
       & __other) const [inline]
       Is this iterator part of the same bucket as the other one?

   template<typename _Iterator, typename _UContainer> bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_incrementable () const [inline]
       Is the iterator incrementable?

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator++(), and __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator++().

   void __gnu_debug::_Safe_iterator_base::_M_invalidate () [inline],
       [inherited]
       Invalidate the iterator, making it singular.

       References _M_invalidate(), and _M_version.

       Referenced by _M_invalidate().

   template<typename _Iterator, typename _UContainer> bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_is_begin () const [inline]
       Is this iterator equal to the container's begin(bucket) iterator?

   template<typename _Iterator, typename _UContainer> bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::_M_is_end
       () const [inline]
       Is this iterator equal to the container's end(bucket) iterator?

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_M_dereferenceable(), and
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_M_incrementable().

   void __gnu_debug::_Safe_iterator_base::_M_reset () [noexcept],  [inherited]
       Reset all member variables

   bool __gnu_debug::_Safe_iterator_base::_M_singular () const [noexcept],
       [inherited]
       Is this iterator singular?

       Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_Safe_local_iterator(),
       __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator<
       _Base_iterator, map >::_M_dereferenceable(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator,
       map >::_M_incrementable(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_M_incrementable(),
       __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(),
       __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator=().

   void __gnu_debug::_Safe_iterator_base::_M_unlink () [inline],  [noexcept],
       [inherited]
       Unlink itself

       References _M_next, _M_prior, and _M_unlink().

       Referenced by _M_unlink().

   template<typename _Iterator, typename _UContainer> bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_M_value_initialized () const [inline]
       Is the iterator value-initialized?

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator=().

   template<typename _Iterator, typename _UContainer> constexpr bool
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer
       >::_S_constant () [inline],  [static],  [constexpr]
       Determine if this is a constant iterator.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_M_attach(), and __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_M_attach_single().

   template<typename _Iterator, typename _UContainer> _Iterator &
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::base ()
       [inline],  [noexcept]
       Return the underlying iterator.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_Safe_local_iterator(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_M_is_begin(), __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_M_is_end(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_M_value_initialized(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::bucket(), __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator*(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator++(),
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator->(), __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator=().

   template<typename _Iterator, typename _UContainer> size_type
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::bucket ()
       const [inline]
       Return the bucket.

       Referenced by __gnu_debug::_Safe_local_iterator< _OtherIterator,
       _UContainer >::_M_in_same_bucket(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::_M_is_begin(), and
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::_M_is_end().

   template<typename _Iterator, typename _UContainer>
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator
       _Iterator () const [inline]
       Conversion to underlying non-debug iterator to allow better interaction
       with non-debug containers.

   template<typename _Iterator, typename _UContainer> reference
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator*
       () const [inline]
       Iterator dereference.

       Precondition
           iterator is dereferenceable

   template<typename _Iterator, typename _UContainer> _Safe_local_iterator &
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator++
       () [inline]
       Iterator preincrement.

       Precondition
           iterator is incrementable

   template<typename _Iterator, typename _UContainer> _Safe_local_iterator
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator++
       (int ) [inline]
       Iterator postincrement.

       Precondition
           iterator is incrementable

   template<typename _Iterator, typename _UContainer> pointer
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator->
       () const [inline]
       Iterator dereference.

       Precondition
           iterator is dereferenceable

   template<typename _Iterator, typename _UContainer> _Safe_local_iterator &
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator=
       (_Safe_local_iterator< _Iterator, _UContainer > && __x) [inline],
       [noexcept]
       Move assignment.

       Postcondition
           __x is singular and unattached

   template<typename _Iterator, typename _UContainer> _Safe_local_iterator &
       __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >::operator=
       (const _Safe_local_iterator< _Iterator, _UContainer > & __x) [inline]
       Copy assignment.

Member Data Documentation
   _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_next [inherited]
       Pointer to the next iterator in the sequence's list of iterators. Only
       valid when _M_sequence != NULL.

       Referenced by _Safe_iterator_base(), _Safe_iterator_base(),
       _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence
       >::_M_transfer_from_if(), and _M_unlink().

   _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_prior [inherited]
       Pointer to the previous iterator in the sequence's list of iterators.
       Only valid when _M_sequence != NULL.

       Referenced by _Safe_iterator_base(), _Safe_iterator_base(),
       _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence
       >::_M_transfer_from_if(), and _M_unlink().

   const _Safe_sequence_base* __gnu_debug::_Safe_iterator_base::_M_sequence
       [inherited]
       The sequence this iterator references; may be NULL to indicate a
       singular iterator. Stored as pointer-to-const because sequence could be
       declared as const.

       Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map
       >::_Safe_iterator(), _Safe_iterator_base(), _Safe_iterator_base(),
       _Safe_iterator_base(), _M_attached_to(), __gnu_debug::_Safe_sequence<
       _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_iterator<
       _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator<
       _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator<
       _OtherIterator, _UContainer >::operator=(), and
       __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer
       >::operator=().

   unsigned int __gnu_debug::_Safe_iterator_base::_M_version [inherited]
       The version number of this iterator. The sentinel value 0 is used to
       indicate an invalidated iterator (i.e., one that is singular because of
       an operation on the container). This version number must equal the
       version number in the sequence referenced by _M_sequence for the
       iterator to be non-singular.

       Referenced by _Safe_iterator_base(), _Safe_iterator_base(),
       _Safe_iterator_base(), _M_invalidate(), and
       __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().


Author
       Generated automatically by Doxygen for libstdc++ from the source code.

                                   libstdc++
                __gnu_debug::_Safe_local_iterator< _Iterator, _UContainer >(3)