stx::btree_multimap< _Key, _Data, _Compare, _Traits > Class Template Reference

Specialized B+ tree template class implementing STL's multimap container. More...

#include <btree_multimap.h>

List of all members.

Public Types

typedef _Key key_type
 First template parameter: The key type of the btree.
typedef _Data data_type
 Second template parameter: The data type associated with each key.
typedef _Compare key_compare
 Third template parameter: Key comparison function object.
typedef _Traits traits
 Fourth template parameter: Traits object used to define more parameters of the B+ tree.
typedef btree_multimap
< key_type, data_type,
key_compare, traits
self
 Typedef of our own type.
typedef std::pair< key_type,
data_type
value_type
 Construct the STL-required value_type as a composition pair of key and data types.
typedef stx::btree< key_type,
data_type, value_type,
key_compare, traits, true > 
btree_impl
 Implementation type of the btree_base.
typedef btree_impl::value_compare value_compare
 Function class comparing two value_type pairs.
typedef btree_impl::size_type size_type
 Size type used to count keys.
typedef btree_impl::tree_stats tree_stats
 Small structure containing statistics about the tree.
typedef btree_impl::iterator iterator
 STL-like iterator object for B+ tree items.
typedef btree_impl::const_iterator const_iterator
 STL-like iterator object for B+ tree items.
typedef
btree_impl::reverse_iterator 
reverse_iterator
 create mutable reverse iterator by using STL magic
typedef
btree_impl::const_reverse_iterator 
const_reverse_iterator
 create constant reverse iterator by using STL magic

Public Member Functions

 btree_multimap ()
 Default constructor initializing an empty B+ tree with the standard key comparison function.
 btree_multimap (const key_compare &kcf)
 Constructor initializing an empty B+ tree with a special key comparison object.
template<class InputIterator>
 btree_multimap (InputIterator first, InputIterator last)
 Constructor initializing a B+ tree with the range [first,last).
template<class InputIterator>
 btree_multimap (InputIterator first, InputIterator last, const key_compare &kcf)
 Constructor initializing a B+ tree with the range [first,last) and a special key comparison object.
 ~btree_multimap ()
 Frees up all used B+ tree memory pages.
void swap (self &from)
 Fast swapping of two identical B+ tree objects.
key_compare key_comp () const
 Constant access to the key comparison object sorting the B+ tree.
value_compare value_comp () const
 Constant access to a constructed value_type comparison object.
void clear ()
 Frees all key/data pairs and all nodes of the tree.
iterator begin ()
 Constructs a read/data-write iterator that points to the first slot in the first leaf of the B+ tree.
iterator end ()
 Constructs a read/data-write iterator that points to the first invalid slot in the last leaf of the B+ tree.
const_iterator begin () const
 Constructs a read-only constant iterator that points to the first slot in the first leaf of the B+ tree.
const_iterator end () const
 Constructs a read-only constant iterator that points to the first invalid slot in the last leaf of the B+ tree.
reverse_iterator rbegin ()
 Constructs a read/data-write reverse iterator that points to the first invalid slot in the last leaf of the B+ tree.
reverse_iterator rend ()
 Constructs a read/data-write reverse iterator that points to the first slot in the first leaf of the B+ tree.
const_reverse_iterator rbegin () const
 Constructs a read-only reverse iterator that points to the first invalid slot in the last leaf of the B+ tree.
const_reverse_iterator rend () const
 Constructs a read-only reverse iterator that points to the first slot in the first leaf of the B+ tree.
size_type size () const
 Return the number of key/data pairs in the B+ tree.
bool empty () const
 Returns true if there is at least one key/data pair in the B+ tree.
size_type max_size () const
 Returns the largest possible size of the B+ Tree.
const tree_statsget_stats () const
 Return a const reference to the current statistics.
bool exists (const key_type &key) const
 Non-STL function checking whether a key is in the B+ tree.
iterator find (const key_type &key)
 Tries to locate a key in the B+ tree and returns an iterator to the key/data slot if found.
const_iterator find (const key_type &key) const
 Tries to locate a key in the B+ tree and returns an constant iterator to the key/data slot if found.
size_type count (const key_type &key) const
 Tries to locate a key in the B+ tree and returns the number of identical key entries found.
iterator lower_bound (const key_type &key)
 Searches the B+ tree and returns an iterator to the first key less or equal to the parameter.
const_iterator lower_bound (const key_type &key) const
 Searches the B+ tree and returns an constant iterator to the first key less or equal to the parameter.
iterator upper_bound (const key_type &key)
 Searches the B+ tree and returns an iterator to the first key greater than the parameter.
const_iterator upper_bound (const key_type &key) const
 Searches the B+ tree and returns an constant iterator to the first key greater than the parameter.
std::pair< iterator, iteratorequal_range (const key_type &key)
 Searches the B+ tree and returns both lower_bound() and upper_bound().
std::pair< const_iterator,
const_iterator
equal_range (const key_type &key) const
 Searches the B+ tree and returns both lower_bound() and upper_bound().
bool operator== (const self &other) const
 Equality relation of B+ trees of the same type.
bool operator!= (const self &other) const
 Inequality relation. Based on operator==.
bool operator< (const self &other) const
 Total ordering relation of B+ trees of the same type.
bool operator> (const self &other) const
 Greater relation. Based on operator<.
bool operator<= (const self &other) const
 Less-equal relation. Based on operator<.
bool operator>= (const self &other) const
 Greater-equal relation. Based on operator<.
selfoperator= (const self &other)
 *** Fast Copy: Assign Operator and Copy Constructors
 btree_multimap (const self &other)
 Copy constructor.
iterator insert (const value_type &x)
 Attempt to insert a key/data pair into the B+ tree.
iterator insert (const key_type &key, const data_type &data)
 Attempt to insert a key/data pair into the B+ tree.
iterator insert2 (const key_type &key, const data_type &data)
 Attempt to insert a key/data pair into the B+ tree.
iterator insert (iterator hint, const value_type &x)
 Attempt to insert a key/data pair into the B+ tree.
iterator insert2 (iterator hint, const key_type &key, const data_type &data)
 Attempt to insert a key/data pair into the B+ tree.
template<typename InputIterator>
void insert (InputIterator first, InputIterator last)
 Attempt to insert the range [first,last) of value_type pairs into the B+ tree.
bool erase_one (const key_type &key)
 Erases one (the first) of the key/data pairs associated with the given key.
size_type erase (const key_type &key)
 Erases all the key/data pairs associated with the given key.
void erase (iterator iter)
 Erase the key/data pair referenced by the iterator.
void erase (iterator, iterator)
 Erase all key/data pairs in the range [first,last).
void print (std::ostream &os) const
 Print out the B+ tree structure with keys onto the given ostream.
void print_leaves (std::ostream &os) const
 Print out only the leaves via the double linked list.
void verify () const
 Run a thorough verification of all B+ tree invariants.
void dump (std::ostream &os) const
 Dump the contents of the B+ tree out onto an ostream as a binary image.
bool restore (std::istream &is)
 Restore a binary image of a dumped B+ tree from an istream.

Static Public Attributes

static const unsigned short leafslotmax = btree_impl::leafslotmax
 Base B+ tree parameter: The number of key/data slots in each leaf.
static const unsigned short innerslotmax = btree_impl::innerslotmax
 Base B+ tree parameter: The number of key slots in each inner node, this can differ from slots in each leaf.
static const unsigned short minleafslots = btree_impl::minleafslots
 Computed B+ tree parameter: The minimum number of key/data slots used in a leaf.
static const unsigned short mininnerslots = btree_impl::mininnerslots
 Computed B+ tree parameter: The minimum number of key slots used in an inner node.
static const bool selfverify = btree_impl::selfverify
 Debug parameter: Enables expensive and thorough checking of the B+ tree invariants after each insert/erase operation.
static const bool debug = btree_impl::debug
 Debug parameter: Prints out lots of debug information about how the algorithms change the tree.
static const bool allow_duplicates = btree_impl::allow_duplicates
 Operational parameter: Allow duplicate keys in the btree.

Private Attributes

btree_impl tree
 The contained implementation object.


Detailed Description

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
class stx::btree_multimap< _Key, _Data, _Compare, _Traits >

Specialized B+ tree template class implementing STL's multimap container.

Implements the STL multimap using a B+ tree. It can be used as a drop-in replacement for std::multimap. Not all asymptotic time requirements are met in theory. There is no allocator template parameter, instead the class has a traits class defining B+ tree properties like slots and self-verification.

Most noteworthy difference to the default red-black implementation of std::multimap is that the B+ tree does not hold key and data pair together in memory. Instead each B+ tree node has two arrays of keys and data values. This design directly generates many problems in implementing the iterator's operator's which return value_type composition pairs.

Definition at line 49 of file btree_multimap.h.


Member Typedef Documentation

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef _Key stx::btree_multimap< _Key, _Data, _Compare, _Traits >::key_type

First template parameter: The key type of the btree.

This is stored in inner nodes and leaves

Definition at line 56 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef _Data stx::btree_multimap< _Key, _Data, _Compare, _Traits >::data_type

Second template parameter: The data type associated with each key.

Stored in the B+ tree's leaves

Definition at line 60 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef _Compare stx::btree_multimap< _Key, _Data, _Compare, _Traits >::key_compare

Third template parameter: Key comparison function object.

Definition at line 63 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef _Traits stx::btree_multimap< _Key, _Data, _Compare, _Traits >::traits

Fourth template parameter: Traits object used to define more parameters of the B+ tree.

Definition at line 67 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_multimap<key_type, data_type, key_compare, traits> stx::btree_multimap< _Key, _Data, _Compare, _Traits >::self

Typedef of our own type.

Definition at line 78 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef std::pair<key_type, data_type> stx::btree_multimap< _Key, _Data, _Compare, _Traits >::value_type

Construct the STL-required value_type as a composition pair of key and data types.

Definition at line 82 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef stx::btree<key_type, data_type, value_type, key_compare, traits, true> stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_impl

Implementation type of the btree_base.

Definition at line 85 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::value_compare stx::btree_multimap< _Key, _Data, _Compare, _Traits >::value_compare

Function class comparing two value_type pairs.

Definition at line 88 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::size_type stx::btree_multimap< _Key, _Data, _Compare, _Traits >::size_type

Size type used to count keys.

Definition at line 91 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::tree_stats stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree_stats

Small structure containing statistics about the tree.

Definition at line 94 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::iterator

STL-like iterator object for B+ tree items.

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

Definition at line 133 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::const_iterator

STL-like iterator object for B+ tree items.

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

Definition at line 137 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::reverse_iterator

create mutable reverse iterator by using STL magic

Definition at line 140 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
typedef btree_impl::const_reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::const_reverse_iterator

create constant reverse iterator by using STL magic

Definition at line 143 of file btree_multimap.h.


Constructor & Destructor Documentation

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_multimap (  )  [inline]

Default constructor initializing an empty B+ tree with the standard key comparison function.

Definition at line 156 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_multimap ( const key_compare kcf  )  [inline]

Constructor initializing an empty B+ tree with a special key comparison object.

Definition at line 163 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
template<class InputIterator>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_multimap ( InputIterator  first,
InputIterator  last 
) [inline]

Constructor initializing a B+ tree with the range [first,last).

Definition at line 170 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
template<class InputIterator>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_multimap ( InputIterator  first,
InputIterator  last,
const key_compare kcf 
) [inline]

Constructor initializing a B+ tree with the range [first,last) and a special key comparison object.

Definition at line 178 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::~btree_multimap (  )  [inline]

Frees up all used B+ tree memory pages.

Definition at line 184 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
stx::btree_multimap< _Key, _Data, _Compare, _Traits >::btree_multimap ( const self other  )  [inline]

Copy constructor.

The newly initialized B+ tree object will contain a copy or all key/data pairs.

Definition at line 434 of file btree_multimap.h.


Member Function Documentation

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::swap ( self from  )  [inline]

Fast swapping of two identical B+ tree objects.

Definition at line 189 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
key_compare stx::btree_multimap< _Key, _Data, _Compare, _Traits >::key_comp (  )  const [inline]

Constant access to the key comparison object sorting the B+ tree.

Definition at line 198 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::key_comp(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
value_compare stx::btree_multimap< _Key, _Data, _Compare, _Traits >::value_comp (  )  const [inline]

Constant access to a constructed value_type comparison object.

required by the STL

Definition at line 205 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree, and stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_comp().

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::clear (  )  [inline]

Frees all key/data pairs and all nodes of the tree.

Definition at line 214 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::clear(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::begin (  )  [inline]

Constructs a read/data-write iterator that points to the first slot in the first leaf of the B+ tree.

Definition at line 224 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::begin(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::end (  )  [inline]

Constructs a read/data-write iterator that points to the first invalid slot in the last leaf of the B+ tree.

Definition at line 231 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::end(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::begin (  )  const [inline]

Constructs a read-only constant iterator that points to the first slot in the first leaf of the B+ tree.

Definition at line 238 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::begin(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::end (  )  const [inline]

Constructs a read-only constant iterator that points to the first invalid slot in the last leaf of the B+ tree.

Definition at line 245 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::end(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rbegin (  )  [inline]

Constructs a read/data-write reverse iterator that points to the first invalid slot in the last leaf of the B+ tree.

Uses STL magic.

Definition at line 252 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::rbegin(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rend (  )  [inline]

Constructs a read/data-write reverse iterator that points to the first slot in the first leaf of the B+ tree.

Uses STL magic.

Definition at line 259 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::rend(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rbegin (  )  const [inline]

Constructs a read-only reverse iterator that points to the first invalid slot in the last leaf of the B+ tree.

Uses STL magic.

Definition at line 266 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::rbegin(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_reverse_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rend (  )  const [inline]

Constructs a read-only reverse iterator that points to the first slot in the first leaf of the B+ tree.

Uses STL magic.

Definition at line 273 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::rend(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
size_type stx::btree_multimap< _Key, _Data, _Compare, _Traits >::size (  )  const [inline]

Return the number of key/data pairs in the B+ tree.

Definition at line 282 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::size(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::empty (  )  const [inline]

Returns true if there is at least one key/data pair in the B+ tree.

Definition at line 288 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::empty(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
size_type stx::btree_multimap< _Key, _Data, _Compare, _Traits >::max_size (  )  const [inline]

Returns the largest possible size of the B+ Tree.

This is just a function required by the STL standard, the B+ Tree can hold more items.

Definition at line 295 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::max_size(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const tree_stats& stx::btree_multimap< _Key, _Data, _Compare, _Traits >::get_stats (  )  const [inline]

Return a const reference to the current statistics.

Definition at line 301 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::get_stats(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::exists ( const key_type key  )  const [inline]

Non-STL function checking whether a key is in the B+ tree.

The same as (find(k) != end()) or (count() != 0).

Definition at line 311 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::exists(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::find ( const key_type key  )  [inline]

Tries to locate a key in the B+ tree and returns an iterator to the key/data slot if found.

If unsuccessful it returns end().

Definition at line 318 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::find(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::find ( const key_type key  )  const [inline]

Tries to locate a key in the B+ tree and returns an constant iterator to the key/data slot if found.

If unsuccessful it returns end().

Definition at line 325 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::find(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
size_type stx::btree_multimap< _Key, _Data, _Compare, _Traits >::count ( const key_type key  )  const [inline]

Tries to locate a key in the B+ tree and returns the number of identical key entries found.

Definition at line 332 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::count(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::lower_bound ( const key_type key  )  [inline]

Searches the B+ tree and returns an iterator to the first key less or equal to the parameter.

If unsuccessful it returns end().

Definition at line 339 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::lower_bound(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::lower_bound ( const key_type key  )  const [inline]

Searches the B+ tree and returns an constant iterator to the first key less or equal to the parameter.

If unsuccessful it returns end().

Definition at line 346 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::lower_bound(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::upper_bound ( const key_type key  )  [inline]

Searches the B+ tree and returns an iterator to the first key greater than the parameter.

If unsuccessful it returns end().

Definition at line 353 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree, and stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::upper_bound().

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const_iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::upper_bound ( const key_type key  )  const [inline]

Searches the B+ tree and returns an constant iterator to the first key greater than the parameter.

If unsuccessful it returns end().

Definition at line 360 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree, and stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::upper_bound().

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
std::pair<iterator, iterator> stx::btree_multimap< _Key, _Data, _Compare, _Traits >::equal_range ( const key_type key  )  [inline]

Searches the B+ tree and returns both lower_bound() and upper_bound().

Definition at line 366 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::equal_range(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
std::pair<const_iterator, const_iterator> stx::btree_multimap< _Key, _Data, _Compare, _Traits >::equal_range ( const key_type key  )  const [inline]

Searches the B+ tree and returns both lower_bound() and upper_bound().

Definition at line 372 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::equal_range(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator== ( const self other  )  const [inline]

Equality relation of B+ trees of the same type.

B+ trees of the same size and equal elements (both key and data) are considered equal. Beware of the random ordering of duplicate keys.

Definition at line 383 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator!= ( const self other  )  const [inline]

Inequality relation. Based on operator==.

Definition at line 389 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator< ( const self other  )  const [inline]

Total ordering relation of B+ trees of the same type.

It uses std::lexicographical_compare() for the actual comparison of elements.

Definition at line 396 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator> ( const self other  )  const [inline]

Greater relation. Based on operator<.

Definition at line 402 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator<= ( const self other  )  const [inline]

Less-equal relation. Based on operator<.

Definition at line 408 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator>= ( const self other  )  const [inline]

Greater-equal relation. Based on operator<.

Definition at line 414 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
self& stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator= ( const self other  )  [inline]

*** Fast Copy: Assign Operator and Copy Constructors

Assignment operator. All the key/data pairs are copied

Definition at line 423 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert ( const value_type x  )  [inline]

Attempt to insert a key/data pair into the B+ tree.

As this tree allows duplicates insertion never fails.

Definition at line 444 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert2(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert ( const key_type key,
const data_type data 
) [inline]

Attempt to insert a key/data pair into the B+ tree.

Beware that if key_type == data_type, then the template iterator insert() is called instead. As this tree allows duplicates insertion never fails.

Definition at line 452 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert2(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert2 ( const key_type key,
const data_type data 
) [inline]

Attempt to insert a key/data pair into the B+ tree.

This function is the same as the other insert, however if key_type == data_type then the non-template function cannot be called. As this tree allows duplicates insertion never fails.

Definition at line 461 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert2(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert ( iterator  hint,
const value_type x 
) [inline]

Attempt to insert a key/data pair into the B+ tree.

The iterator hint is currently ignored by the B+ tree insertion routine.

Definition at line 468 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert2(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
iterator stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert2 ( iterator  hint,
const key_type key,
const data_type data 
) [inline]

Attempt to insert a key/data pair into the B+ tree.

The iterator hint is currently ignored by the B+ tree insertion routine.

Definition at line 475 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert2(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
template<typename InputIterator>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert ( InputIterator  first,
InputIterator  last 
) [inline]

Attempt to insert the range [first,last) of value_type pairs into the B+ tree.

Each key/data pair is inserted individually.

Definition at line 483 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::insert(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase_one ( const key_type key  )  [inline]

Erases one (the first) of the key/data pairs associated with the given key.

Definition at line 493 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::erase_one(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
size_type stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase ( const key_type key  )  [inline]

Erases all the key/data pairs associated with the given key.

This is implemented using erase_one() and thus not very efficient.

Definition at line 500 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::erase(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase ( iterator  iter  )  [inline]

Erase the key/data pair referenced by the iterator.

Definition at line 507 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase ( iterator  ,
iterator   
) [inline]

Erase all key/data pairs in the range [first,last).

This function is currently not implemented by the B+ Tree.

Definition at line 516 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::print ( std::ostream &  os  )  const [inline]

Print out the B+ tree structure with keys onto the given ostream.

This function requires that the header is compiled with BTREE_DEBUG and that key_type is printable via std::ostream.

Definition at line 529 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::print(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::print_leaves ( std::ostream &  os  )  const [inline]

Print out only the leaves via the double linked list.

Definition at line 535 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::print_leaves(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::verify (  )  const [inline]

Run a thorough verification of all B+ tree invariants.

The program aborts via BTREE_ASSERT() if something is wrong.

Definition at line 546 of file btree_multimap.h.

References stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree, and stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::verify().

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
void stx::btree_multimap< _Key, _Data, _Compare, _Traits >::dump ( std::ostream &  os  )  const [inline]

Dump the contents of the B+ tree out onto an ostream as a binary image.

The image contains memory pointers which will be fixed when the image is restored. For this to work your key_type and data_type must be integral types and contain no pointers or references.

Definition at line 557 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::dump(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::restore ( std::istream &  is  )  [inline]

Restore a binary image of a dumped B+ tree from an istream.

The B+ tree pointers are fixed using the dump order. For dump and restore to work your key_type and data_type must be integral types and contain no pointers or references. Returns true if the restore was successful.

Definition at line 566 of file btree_multimap.h.

References stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::restore(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree.


Member Data Documentation

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const unsigned short stx::btree_multimap< _Key, _Data, _Compare, _Traits >::leafslotmax = btree_impl::leafslotmax [static]

Base B+ tree parameter: The number of key/data slots in each leaf.

Definition at line 100 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const unsigned short stx::btree_multimap< _Key, _Data, _Compare, _Traits >::innerslotmax = btree_impl::innerslotmax [static]

Base B+ tree parameter: The number of key slots in each inner node, this can differ from slots in each leaf.

Definition at line 104 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const unsigned short stx::btree_multimap< _Key, _Data, _Compare, _Traits >::minleafslots = btree_impl::minleafslots [static]

Computed B+ tree parameter: The minimum number of key/data slots used in a leaf.

If fewer slots are used, the leaf will be merged or slots shifted from it's siblings.

Definition at line 109 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const unsigned short stx::btree_multimap< _Key, _Data, _Compare, _Traits >::mininnerslots = btree_impl::mininnerslots [static]

Computed B+ tree parameter: The minimum number of key slots used in an inner node.

If fewer slots are used, the inner node will be merged or slots shifted from it's siblings.

Definition at line 114 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::selfverify = btree_impl::selfverify [static]

Debug parameter: Enables expensive and thorough checking of the B+ tree invariants after each insert/erase operation.

Definition at line 118 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::debug = btree_impl::debug [static]

Debug parameter: Prints out lots of debug information about how the algorithms change the tree.

Requires the header file to be compiled with BTREE_DEBUG and the key type must be std::ostream printable.

Definition at line 123 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
const bool stx::btree_multimap< _Key, _Data, _Compare, _Traits >::allow_duplicates = btree_impl::allow_duplicates [static]

Operational parameter: Allow duplicate keys in the btree.

Definition at line 126 of file btree_multimap.h.

template<typename _Key, typename _Data, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>>
btree_impl stx::btree_multimap< _Key, _Data, _Compare, _Traits >::tree [private]

The contained implementation object.

Definition at line 149 of file btree_multimap.h.

Referenced by stx::btree_multimap< _Key, _Data, _Compare, _Traits >::begin(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::clear(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::count(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::dump(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::empty(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::end(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::equal_range(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::erase_one(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::exists(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::find(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::get_stats(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::insert2(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::key_comp(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::lower_bound(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::max_size(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator!=(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator<(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator<=(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator=(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator==(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator>(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::operator>=(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::print(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::print_leaves(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rbegin(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::rend(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::restore(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::size(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::swap(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::upper_bound(), stx::btree_multimap< _Key, _Data, _Compare, _Traits >::value_comp(), and stx::btree_multimap< _Key, _Data, _Compare, _Traits >::verify().


The documentation for this class was generated from the following file:
Generated on Fri Jan 25 13:53:44 2008 for STX B+ Tree Template Classes by  doxygen 1.5.4