STX B+ Tree Template Classes 0.8.6
Public Types | Public Member Functions | Private Attributes | Friends

stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator Class Reference

STL-like iterator object for B+ tree items. More...

#include <btree.h>

List of all members.

Public Types

typedef btree::key_type key_type
 The key type of the btree. Returned by key().
typedef btree::data_type data_type
 The data type of the btree. Returned by data().
typedef btree::value_type value_type
 The value type of the btree. Returned by operator*().
typedef btree::pair_type pair_type
 The pair type of the btree.
typedef value_typereference
 Reference to the value_type. STL required.
typedef value_typepointer
 Pointer to the value_type. STL required.
typedef
std::bidirectional_iterator_tag 
iterator_category
 STL-magic iterator category.
typedef ptrdiff_t difference_type
 STL-magic.
typedef iterator self
 Our own type.

Public Member Functions

 iterator ()
 Default-Constructor of a mutable iterator.
 iterator (typename btree::leaf_node *l, unsigned short s)
 Initializing-Constructor of a mutable iterator.
 iterator (const reverse_iterator &it)
 Copy-constructor from a reverse iterator.
reference operator* () const
 Dereference the iterator, this is not a value_type& because key and value are not stored together.
pointer operator-> () const
 Dereference the iterator.
const key_typekey () const
 Key of the current slot.
data_typedata () const
 Writable reference to the current data object.
selfoperator++ ()
 Prefix++ advance the iterator to the next slot.
self operator++ (int)
 Postfix++ advance the iterator to the next slot.
selfoperator-- ()
 Prefix-- backstep the iterator to the last slot.
self operator-- (int)
 Postfix-- backstep the iterator to the last slot.
bool operator== (const self &x) const
 Equality of iterators.
bool operator!= (const self &x) const
 Inequality of iterators.

Private Attributes

btree::leaf_nodecurrnode
 The currently referenced leaf node of the tree.
unsigned short currslot
 Current key/data slot referenced.
value_type temp_value
 Evil! A temporary value_type to STL-correctly deliver operator* and operator->

Friends

class const_iterator
 Friendly to the const_iterator, so it may access the two data items directly.
class reverse_iterator
 Also friendly to the reverse_iterator, so it may access the two data items directly.
class const_reverse_iterator
 Also friendly to the const_reverse_iterator, so it may access the two data items directly.
class btree< key_type, data_type, value_type, key_compare, traits, allow_duplicates >
 Also friendly to the base btree class, because erase_iter() needs to read the currnode and currslot values directly.

Detailed Description

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
class stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator

STL-like iterator object for B+ tree items.

The iterator points to a specific slot number in a leaf.

Definition at line 378 of file btree.h.


Member Typedef Documentation

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef btree::data_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::data_type

The data type of the btree. Returned by data().

Definition at line 387 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef ptrdiff_t stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::difference_type

STL-magic.

Definition at line 405 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef std::bidirectional_iterator_tag stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::iterator_category

STL-magic iterator category.

Definition at line 402 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef btree::key_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::key_type

The key type of the btree. Returned by key().

Definition at line 384 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef btree::pair_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::pair_type

The pair type of the btree.

Definition at line 393 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef value_type* stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::pointer

Pointer to the value_type. STL required.

Definition at line 399 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef value_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::reference

Reference to the value_type. STL required.

Definition at line 396 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef iterator stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::self

Our own type.

Definition at line 408 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
typedef btree::value_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::value_type

The value type of the btree. Returned by operator*().

Definition at line 390 of file btree.h.


Constructor & Destructor Documentation

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::iterator ( ) [inline]

Default-Constructor of a mutable iterator.

Definition at line 445 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::iterator ( typename btree::leaf_node l,
unsigned short  s 
) [inline]

Initializing-Constructor of a mutable iterator.

Definition at line 450 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::iterator ( const reverse_iterator it) [inline]

Copy-constructor from a reverse iterator.

Definition at line 455 of file btree.h.


Member Function Documentation

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
data_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::data ( ) const [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
const key_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::key ( ) const [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
bool stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator!= ( const self x) const [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
reference stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator* ( ) const [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
self& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator++ ( ) [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
self stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator++ ( int  ) [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
self& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator-- ( ) [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
self stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator-- ( int  ) [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
pointer stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator-> ( ) const [inline]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
bool stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::operator== ( const self x) const [inline]

Friends And Related Function Documentation

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
friend class btree< key_type, data_type, value_type, key_compare, traits, allow_duplicates > [friend]

Also friendly to the base btree class, because erase_iter() needs to read the currnode and currslot values directly.

Definition at line 430 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
friend class const_iterator [friend]

Friendly to the const_iterator, so it may access the two data items directly.

Definition at line 420 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
friend class const_reverse_iterator [friend]

Also friendly to the const_reverse_iterator, so it may access the two data items directly.

Definition at line 426 of file btree.h.

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
friend class reverse_iterator [friend]

Also friendly to the reverse_iterator, so it may access the two data items directly.

Definition at line 423 of file btree.h.


Member Data Documentation

template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
btree::leaf_node* stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::currnode [private]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
unsigned short stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::currslot [private]
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false, typename _Alloc = std::allocator<_Value>>
value_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates, _Alloc >::iterator::temp_value [mutable, private]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines