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

STL-like read-only 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 const value_type &	reference
	Reference to the value_type. Required by the reverse_iterator.
typedef const value_type *	pointer
	Pointer to the value_type. Required by the reverse_iterator.
typedef std::bidirectional_iterator_tag	iterator_category
	STL-magic iterator category.
typedef ptrdiff_t	difference_type
	STL-magic.
typedef const_iterator	self
	Our own type.
Public Member Functions
	const_iterator (const typename btree::leaf_node *l, unsigned short s)
	Constructor of a const iterator.
	const_iterator (const iterator &it)
	Copy-constructor from a mutable const iterator.
reference	operator * () const
	Dereference the iterator.
pointer	operator-> () const
	Dereference the iterator.
const key_type &	key () const
	Key of the current slot.
const data_type &	data () const
	Read-only reference to the current data object.
self &	operator++ ()
	Prefix++ advance the iterator to the next slot.
self	operator++ (int)
	Postfix++ advance the iterator to the next slot.
self &	operator-- ()
	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
const btree::leaf_node *	currnode
	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->.

---

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>
class stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator

STL-like read-only iterator object for B+ tree items.

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

Definition at line 546 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>

typedef btree::key_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::key_type

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

Definition at line 552 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>

typedef btree::data_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::data_type

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

Definition at line 555 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>

typedef btree::value_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::value_type

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

Definition at line 558 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>

typedef btree::pair_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::pair_type

The pair type of the btree.

Definition at line 561 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>

typedef const value_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::reference

Reference to the value_type. Required by the reverse_iterator.

Definition at line 564 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>

typedef const value_type* stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::pointer

Pointer to the value_type. Required by the reverse_iterator.

Definition at line 567 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>

typedef std::bidirectional_iterator_tag stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::iterator_category

STL-magic iterator category.

Definition at line 570 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>

typedef ptrdiff_t stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::difference_type

STL-magic.

Definition at line 573 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>

typedef const_iterator stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::self

Our own type.

Definition at line 576 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>

stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::const_iterator	(	const typename btree::leaf_node *	l,
		unsigned short	s
	)			[inline]

Constructor of a const iterator.

Definition at line 600 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>

stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::const_iterator

(

const iterator &

it

)

[inline]

Copy-constructor from a mutable const iterator.

Definition at line 605 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>

reference stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator *

(

)

const [inline]

Dereference the iterator.

Do not use this if possible, use key() and data() instead. The B+ tree does not stored key and data together.

Definition at line 612 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>

pointer stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator->

(

)

const [inline]

Dereference the iterator.

Do not use this if possible, use key() and data() instead. The B+ tree does not stored key and data together.

Definition at line 622 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>

const key_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::key

(

)

const [inline]

Key of the current slot.

Definition at line 630 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>

const data_type& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::data

(

)

const [inline]

Read-only reference to the current data object.

Definition at line 636 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>

self& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator++

(

)

[inline]

Prefix++ advance the iterator to the next slot.

Definition at line 642 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>

self stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator++

(

int

)

[inline]

Postfix++ advance the iterator to the next slot.

Definition at line 660 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>

self& stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator--

(

)

[inline]

Prefix-- backstep the iterator to the last slot.

Definition at line 680 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>

self stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator--

(

int

)

[inline]

Postfix-- backstep the iterator to the last slot.

Definition at line 698 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>

bool stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator==

(

const self &

x

)

const [inline]

Equality of iterators.

Definition at line 718 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>

bool stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::operator!=

(

const self &

x

)

const [inline]

Inequality of iterators.

Definition at line 724 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>

const btree::leaf_node* stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::currnode [private]

The currently referenced leaf node of the tree.

Definition at line 582 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>

unsigned short stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::currslot [private]

Current key/data slot referenced.

Definition at line 585 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>

value_type stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::const_iterator::temp_value [mutable, private]

Evil! A temporary value_type to STL-correctly deliver operator* and operator->.

Definition at line 589 of file btree.h.

---

The documentation for this class was generated from the following file:

• stx/btree.h

---