Detailed Description

template<typename Key, typename Value, typename KeyOfValue, typename Compare = std::less<Key>, typename Traits = btree_default_traits<Key, Value>, bool Duplicates = false, typename Allocator = std::allocator<Value>>
class tlx::BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::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 508 of file btree.hpp.

Collaboration diagram for BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator:

#include <btree.hpp>

Public Types
typedef ptrdiff_t	difference_type
	STL-magic. More...

typedef std::bidirectional_iterator_tag	iterator_category
	STL-magic iterator category. More...

typedef BTree::key_type	key_type
	The key type of the btree. Returned by key(). More...

typedef const value_type *	pointer
	Pointer to the value_type. STL required. More...

typedef const value_type &	reference
	Reference to the value_type. STL required. More...

typedef const_iterator	self
	Our own type. More...

typedef BTree::value_type	value_type
	The value type of the btree. Returned by operator*(). More...

Public Member Functions
	const_iterator ()
	Default-Constructor of a const iterator. More...

	const_iterator (const typename BTree::LeafNode *l, unsigned short s)
	Initializing-Constructor of a const iterator. More...

	const_iterator (const iterator &it)
	Copy-constructor from a mutable iterator. More...

	const_iterator (const reverse_iterator &it)
	Copy-constructor from a mutable reverse iterator. More...

	const_iterator (const const_reverse_iterator &it)
	Copy-constructor from a const reverse iterator. More...

const key_type &	key () const
	Key of the current slot. More...

bool	operator!= (const const_iterator &x) const
	Inequality of iterators. More...

reference	operator* () const
	Dereference the iterator. More...

const_iterator &	operator++ ()
	Prefix++ advance the iterator to the next slot. More...

const_iterator	operator++ (int)
	Postfix++ advance the iterator to the next slot. More...

const_iterator &	operator-- ()
	Prefix– backstep the iterator to the last slot. More...

const_iterator	operator-- (int)
	Postfix– backstep the iterator to the last slot. More...

pointer	operator-> () const
	Dereference the iterator. More...

bool	operator== (const const_iterator &x) const
	Equality of iterators. More...

Private Attributes
const BTree::LeafNode *	curr_leaf
	The currently referenced leaf node of the tree. More...

unsigned short	curr_slot
	Current key/data slot referenced. More...

Member Typedef Documentation

◆ difference_type

typedef ptrdiff_t difference_type

STL-magic.

Definition at line 529 of file btree.hpp.

◆ iterator_category

typedef std::bidirectional_iterator_tag iterator_category

STL-magic iterator category.

Definition at line 526 of file btree.hpp.

◆ key_type

typedef BTree::key_type key_type

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

Definition at line 514 of file btree.hpp.

◆ pointer

typedef const value_type* pointer

Pointer to the value_type. STL required.

Definition at line 523 of file btree.hpp.

◆ reference

typedef const value_type& reference

Reference to the value_type. STL required.

Definition at line 520 of file btree.hpp.

◆ self

typedef const_iterator self

Our own type.

Definition at line 532 of file btree.hpp.

◆ value_type

typedef BTree::value_type value_type

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

Definition at line 517 of file btree.hpp.

Constructor & Destructor Documentation

◆ const_iterator() [1/5]

const_iterator ( )

inline

Default-Constructor of a const iterator.

Definition at line 556 of file btree.hpp.

◆ const_iterator() [2/5]

const_iterator	(	const typename BTree::LeafNode *	l,
		unsigned short	s
	)

inline

Initializing-Constructor of a const iterator.

Definition at line 561 of file btree.hpp.

◆ const_iterator() [3/5]

const_iterator ( const iterator & it )

inline

Copy-constructor from a mutable iterator.

Definition at line 566 of file btree.hpp.

◆ const_iterator() [4/5]

const_iterator ( const reverse_iterator & it )

inline

Copy-constructor from a mutable reverse iterator.

Definition at line 571 of file btree.hpp.

◆ const_iterator() [5/5]

const_iterator ( const const_reverse_iterator & it )

inline

Copy-constructor from a const reverse iterator.

Definition at line 576 of file btree.hpp.

Member Function Documentation

◆ key()

const key_type& key ( ) const

inline

Key of the current slot.

Definition at line 591 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::key().

◆ operator!=()

bool operator!= ( const const_iterator & x ) const

inline

Inequality of iterators.

Definition at line 673 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::curr_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::curr_slot.

◆ operator*()

reference operator* ( ) const

inline

Dereference the iterator.

Definition at line 581 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::slotdata.

◆ operator++() [1/2]

const_iterator& operator++ ( )

inline

Prefix++ advance the iterator to the next slot.

Definition at line 596 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::next_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::node::slotuse.

◆ operator++() [2/2]

const_iterator operator++ ( int )

inline

Postfix++ advance the iterator to the next slot.

Definition at line 613 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::next_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::node::slotuse.

◆ operator--() [1/2]

const_iterator& operator-- ( )

inline

Prefix– backstep the iterator to the last slot.

Definition at line 632 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::prev_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::node::slotuse.

◆ operator--() [2/2]

const_iterator operator-- ( int )

inline

Postfix– backstep the iterator to the last slot.

Definition at line 649 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::prev_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::node::slotuse.

◆ operator->()

pointer operator-> ( ) const

inline

Dereference the iterator.

Definition at line 586 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::LeafNode::slotdata.

◆ operator==()

bool operator== ( const const_iterator & x ) const

inline

Equality of iterators.

Definition at line 668 of file btree.hpp.

References BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::curr_leaf, and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::curr_slot.

Member Data Documentation

◆ curr_leaf

const BTree::LeafNode* curr_leaf

private

The currently referenced leaf node of the tree.

Definition at line 538 of file btree.hpp.

Referenced by BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::operator!=(), and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::operator==().

◆ curr_slot

unsigned short curr_slot

private

Current key/data slot referenced.

Definition at line 541 of file btree.hpp.

Referenced by BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::operator!=(), and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::const_iterator::operator==().

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

extlib/tlx/tlx/container/btree.hpp

Detailed Description

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ key_type

◆ pointer

◆ reference

◆ self

◆ value_type

Constructor & Destructor Documentation

◆ const_iterator() [1/5]

◆ const_iterator() [2/5]

◆ const_iterator() [3/5]

◆ const_iterator() [4/5]

◆ const_iterator() [5/5]

Member Function Documentation

◆ key()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator->()

◆ operator==()

Member Data Documentation

◆ curr_leaf

◆ curr_slot