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 >::iterator

STL-like iterator object for B+ tree items. The iterator points to a specific slot number in a leaf.

Definition at line 333 of file btree.hpp.

Collaboration diagram for BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::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 value_type *	pointer
	Pointer to the value_type. STL required. More...

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

typedef 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
	iterator ()
	Default-Constructor of a mutable iterator. More...

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
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 354 of file btree.hpp.

◆ iterator_category

typedef std::bidirectional_iterator_tag iterator_category

STL-magic iterator category.

Definition at line 351 of file btree.hpp.

◆ key_type

typedef BTree::key_type key_type

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

Definition at line 339 of file btree.hpp.

◆ pointer

typedef value_type* pointer

Pointer to the value_type. STL required.

Definition at line 348 of file btree.hpp.

◆ reference

typedef value_type& reference

Reference to the value_type. STL required.

Definition at line 345 of file btree.hpp.

◆ self

typedef iterator self

Our own type.

Definition at line 357 of file btree.hpp.

◆ value_type

typedef BTree::value_type value_type

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

Definition at line 342 of file btree.hpp.

Constructor & Destructor Documentation

◆ iterator() [1/3]

iterator ( )

inline

Default-Constructor of a mutable iterator.

Definition at line 394 of file btree.hpp.

◆ iterator() [2/3]

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

inline

Initializing-Constructor of a mutable iterator.

Definition at line 399 of file btree.hpp.

◆ iterator() [3/3]

iterator ( const reverse_iterator & it )

inline

Copy-constructor from a reverse iterator.

Definition at line 404 of file btree.hpp.

Member Function Documentation

◆ key()

const key_type& key ( ) const

inline

Key of the current slot.

Definition at line 419 of file btree.hpp.

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

◆ operator!=()

bool operator!= ( const iterator & x ) const

inline

Inequality of iterators.

Definition at line 501 of file btree.hpp.

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

◆ operator*()

reference operator* ( ) const

inline

Dereference the iterator.

Definition at line 409 of file btree.hpp.

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

◆ operator++() [1/2]

iterator& operator++ ( )

inline

Prefix++ advance the iterator to the next slot.

Definition at line 424 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]

iterator operator++ ( int )

inline

Postfix++ advance the iterator to the next slot.

Definition at line 441 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]

iterator& operator-- ( )

inline

Prefix– backstep the iterator to the last slot.

Definition at line 460 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]

iterator operator-- ( int )

inline

Postfix– backstep the iterator to the last slot.

Definition at line 477 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 414 of file btree.hpp.

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

◆ operator==()

bool operator== ( const iterator & x ) const

inline

Equality of iterators.

Definition at line 496 of file btree.hpp.

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

Member Data Documentation

◆ curr_leaf

BTree::LeafNode* curr_leaf

private

The currently referenced leaf node of the tree.

Definition at line 363 of file btree.hpp.

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

◆ curr_slot

unsigned short curr_slot

private

Current key/data slot referenced.

Definition at line 366 of file btree.hpp.

Referenced by BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::iterator::operator!=(), and BTree< Key, Value, KeyOfValue, Compare, Traits, Duplicates, Allocator >::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

◆ iterator() [1/3]

◆ iterator() [2/3]

◆ iterator() [3/3]

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