Pigweed
C/C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
pw::containers::internal::KeyedAATree< K > Class Template Reference
Inheritance diagram for pw::containers::internal::KeyedAATree< K >:
pw::containers::internal::GenericAATree pw::containers::internal::AATree< Key, T > pw::containers::internal::AATree< const T &, T > pw::containers::internal::AATree< size_t, pw::allocator::FastSortedItem< BestFitBlock< uintptr_t > > > pw::containers::internal::AATree< size_t, pw::allocator::FastSortedItem< BlockType > > pw::containers::internal::AATree< size_t, pw::allocator::FastSortedItem< WorstFitBlock< uintptr_t > > > pw::containers::internal::AATree< K, V >

Public Types

using Key = K
 
using Compare = Function< bool(Key, Key)>
 
using GetKey = Function< Key(const AATreeItem &)>
 
using iterator = AATreeIterator<>
 
- Public Types inherited from pw::containers::internal::GenericAATree
using iterator = AATreeIterator<>
 

Public Member Functions

constexpr KeyedAATree (bool unique_keys, Compare &&compare, GetKey &&get_key)
 
void SetCompare (Compare &&compare)
 
void SetGetKey (GetKey &&get_key)
 
std::pair< iterator, bool > insert (AATreeItem &item)
 
template<class Iterator >
void insert (Iterator first, Iterator last)
 
size_t erase_all (Key key)
 
void merge (KeyedAATree< K > &other)
 
size_t count (Key key)
 
iterator find (Key key)
 
std::pair< iterator, iterator > equal_range (Key key)
 
iterator lower_bound (Key key)
 
iterator upper_bound (Key key)
 
iterator erase_one (AATreeItem &item)
 
iterator erase_range (AATreeItem &first, AATreeItem &last)
 
- Public Member Functions inherited from pw::containers::internal::GenericAATree
constexpr GenericAATree (bool unique_keys)
 
 ~GenericAATree ()
 Destructor.
 
 GenericAATree (const GenericAATree &)=delete
 
GenericAATreeoperator= (const GenericAATree &)=delete
 
constexpr bool unique_keys () const
 
void SetRoot (AATreeItem *item)
 Sets the tree's root item.
 
constexpr iterator begin () noexcept
 Returns a pointer to the first item, if any.
 
constexpr iterator end () noexcept
 Returns a pointer to the last item, if any.
 
constexpr bool empty () const
 Returns whether the tree has zero items or not.
 
size_t size () const
 Returns the number of items in the tree.
 
constexpr size_t max_size () const noexcept
 
void clear ()
 
iterator erase_one (AATreeItem &item)
 
iterator erase_range (AATreeItem &first, AATreeItem &last)
 
void swap (GenericAATree &other)
 Exchanges this tree's items with the other tree's items.
 

Detailed Description

template<typename K>
class pw::containers::internal::KeyedAATree< K >

Base type for an AA tree that templated on the key type only.

This class includes methods that compare keys, but treats all values in the map as simply AATreeItems. This results in less template expansion between maps that share key type, such as size_t. This class should not be used directly. Instead, see the AATree class that is templated on both key and value types.

Template Parameters
KKey type.

Constructor & Destructor Documentation

◆ KeyedAATree()

template<typename K >
constexpr pw::containers::internal::KeyedAATree< K >::KeyedAATree ( bool  unique_keys,
Compare &&  compare,
GetKey &&  get_key 
)
inlineexplicitconstexpr

Constructs an empty AA tree.

Parameters
unique_keysIndicates if this tree requires unique keys or allows duplicate keys.

Member Function Documentation

◆ count()

template<typename K >
size_t pw::containers::internal::KeyedAATree< K >::count ( Key  key)

Returns the number of items in the tree with the given key.

If the tree requires unique keys, this simply 0 or 1.

◆ equal_range()

template<typename K >
std::pair< GenericAATree::iterator, GenericAATree::iterator > pw::containers::internal::KeyedAATree< K >::equal_range ( Key  key)

Returns a pair of items where the first points to the item with the smallest key that is not less than the given key, and the second points to the item with the smallest key that is greater than the given key.

◆ erase_all()

template<typename K >
size_t pw::containers::internal::KeyedAATree< K >::erase_all ( Key  key)

Removes items that match the given key, and returns an iterator to the item after the removed items and the number of items removed.

◆ erase_one()

template<typename K >
iterator pw::containers::internal::GenericAATree::erase_one ( AATreeItem &  item)

Removes an item from the tree and returns an iterator to the item after the removed item.

The items themselves are not destructed.

◆ erase_range()

template<typename K >
iterator pw::containers::internal::GenericAATree::erase_range ( AATreeItem &  first,
AATreeItem &  last 
)

Removes the items from first, inclusive, to last, exclusive from the tree and returns an iterator to the item after the last removed item.

The items themselves are not destructed.

◆ find()

template<typename K >
GenericAATree::iterator pw::containers::internal::KeyedAATree< K >::find ( Key  key)

Returns a pointer to an item with the given key, or null if the tree does not contain such an item.

◆ insert() [1/2]

template<typename K >
std::pair< GenericAATree::iterator, bool > pw::containers::internal::KeyedAATree< K >::insert ( AATreeItem &  item)

Attempts to add the given item to the tree.

The item will be added if the tree does not already contain an item with the given item's key or if the tree does not require unique keys.

Precondition
The item must not be a part of any tree.
Returns
A pointer to the inserted item and true, or a pointer to the existing item with same key and false.

◆ insert() [2/2]

template<typename K >
template<class Iterator >
void pw::containers::internal::KeyedAATree< K >::insert ( Iterator  first,
Iterator  last 
)

Inserts each item from first, inclusive, to last, exclusive. If the tree does not all duplicates and an equivalent item is already in the tree, the item is ignored.

◆ lower_bound()

template<typename K >
GenericAATree::iterator pw::containers::internal::KeyedAATree< K >::lower_bound ( Key  key)

Returns the item in the tree with the smallest key that is greater than or equal to the given key, or null if the tree is empty.

◆ merge()

template<typename K >
void pw::containers::internal::KeyedAATree< K >::merge ( KeyedAATree< K > &  other)

Splices items from the other tree into this one.

The receiving tree's Compare and GetKey functions are used when inserting items.

◆ upper_bound()

template<typename K >
GenericAATree::iterator pw::containers::internal::KeyedAATree< K >::upper_bound ( Key  key)

Returns the item in the tree with the smallest key that is strictly greater than the given key, or null if the tree is empty.


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