csRedBlackTree< K > Class Template Reference
[Containers]
A red-black-tree.
More...
#include <csutil/redblacktree.h>
Public Member Functions | |
| bool | Contains (const K &key) const |
| Check whether a key is in the tree. | |
| csRedBlackTree (const csRedBlackTree &other) | |
| csRedBlackTree (size_t allocatorBlockSize=4096) | |
| Construct a new tree. | |
| bool | Delete (const K &key) |
| Delete a key. | |
| void | DeleteAll () |
| Delete all keys. | |
| void | Empty () |
| Delete all the keys. (Idiomatic alias for DeleteAll().). | |
| bool | In (const K &key) const |
| Check whether a key is in the tree. | |
| const K * | Insert (const K &key) |
| Insert a key. | |
| bool | IsEmpty () const |
| Returns whether this tree has no nodes. | |
| template<typename K2> | |
| const K & | Find (const K2 &other, const K &fallback) const |
| template<typename K2> | |
| const K * | Find (const K2 &other) const |
| Locate key that is equal to 'other'. | |
| template<typename CB> | |
| void | TraverseInOrder (CB &callback) const |
| Traverse tree. | |
Protected Types | |
| enum | NodeColor |
Protected Member Functions | |
| void | DeleteFixup (Node *node) |
| Fix up the RB tree after a deletion. | |
| void | DeleteNode (Node *node) |
| Delete a node from the tree. | |
| void | InsertFixup (Node *node) |
| Fix up the RB tree after an insert. | |
| bool | IsBlack (Node *node) const |
| Check whether a node is black. Note that 0 nodes are by definition black. | |
| bool | IsRed (Node *node) const |
| Check whether a node is red. | |
| Node * | LocateNode (Node *node, const K &key) const |
| Find the node for a key. | |
| void | RecursiveCopy (Node *&to, Node *parent, const Node *from) |
| Duplicate a subtree. | |
| Node * | RecursiveInsert (Node *parent, Node *&node, const K &key) |
| Locate the place where a new node needs to be inserted. | |
| template<typename CB> | |
| void | RecursiveTraverseInOrder (Node *node, CB &callback) const |
| Traverse tree. | |
| void | RotateLeft (Node *pivot) |
| Left-rotate subtree around 'pivot'. | |
| void | RotateRight (Node *pivot) |
| Right-rotate subtree around 'pivot'. | |
| Node * | Successor (Node *node) const |
| Return smallest node with a key greater than 'node's. | |
| template<typename K2> | |
| K & | Find (const K2 &other, K &fallback) |
| template<typename K2> | |
| K * | Find (const K2 &other) |
| Locate key that is equal to 'other'. | |
| template<typename K2> | |
| K & | RecursiveFind (Node *node, const K2 &other, K &fallback) |
| template<typename K2> | |
| const K & | RecursiveFind (Node *node, const K2 &other, const K &fallback) const |
| template<typename K2> | |
| K * | RecursiveFind (Node *node, const K2 &other) |
| template<typename K2> | |
| const K * | RecursiveFind (Node *node, const K2 &other) const |
| Locate key that is equal to 'other'. | |
Protected Attributes | |
| csBlockAllocator< Node, CS::Memory::AllocatorAlign< 2 > > | nodeAlloc |
| Node * | root |
Classes | |
| struct | Node |
| A node in the tree. More... | |
Detailed Description
template<typename K>
class csRedBlackTree< K >
A red-black-tree.
- Remarks:
- Does not allow duplicate keys.
Uses csComparator<> for key comparisons.
Only stores keys. If you need a key-value-map, look at csRedBlackTreeMap.
Definition at line 47 of file redblacktree.h.
Constructor & Destructor Documentation
| csRedBlackTree< K >::csRedBlackTree | ( | size_t | allocatorBlockSize = 4096 |
) | [inline] |
Construct a new tree.
- Parameters:
-
allocatorBlockSize Block size in bytes used by the internal block allocator for nodes.
Definition at line 439 of file redblacktree.h.
Member Function Documentation
| bool csRedBlackTree< K >::Contains | ( | const K & | key | ) | const [inline] |
Check whether a key is in the tree.
- Remarks:
- This is rigidly equivalent to Contains(key), but may be considered more idiomatic by some.
Definition at line 481 of file redblacktree.h.
| bool csRedBlackTree< K >::Delete | ( | const K & | key | ) | [inline] |
Delete a key.
- Returns:
- Whether the deletion was successful. Fails if the key is not in the tree.
Definition at line 464 of file redblacktree.h.
| void csRedBlackTree< K >::DeleteAll | ( | ) | [inline] |
Delete all keys.
Reimplemented in csRedBlackTreeMap< K, T >.
Definition at line 498 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Empty().
| void csRedBlackTree< K >::DeleteFixup | ( | Node * | node | ) | [inline, protected] |
Fix up the RB tree after a deletion.
Definition at line 243 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteNode().
| void csRedBlackTree< K >::DeleteNode | ( | Node * | node | ) | [inline, protected] |
Delete a node from the tree.
Definition at line 210 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Delete().
| void csRedBlackTree< K >::Empty | ( | ) | [inline] |
Delete all the keys. (Idiomatic alias for DeleteAll().).
Reimplemented in csRedBlackTreeMap< K, T >.
Definition at line 504 of file redblacktree.h.
| const K* csRedBlackTree< K >::Find | ( | const K2 & | other | ) | const [inline] |
| K* csRedBlackTree< K >::Find | ( | const K2 & | other | ) | [inline, protected] |
| bool csRedBlackTree< K >::In | ( | const K & | key | ) | const [inline] |
Check whether a key is in the tree.
Definition at line 472 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Contains().
| const K* csRedBlackTree< K >::Insert | ( | const K & | key | ) | [inline] |
Insert a key.
- Returns:
- A pointer to the copy of the key stored in the tree, or 0 if the key already exists.
Definition at line 452 of file redblacktree.h.
| void csRedBlackTree< K >::InsertFixup | ( | Node * | node | ) | [inline, protected] |
Fix up the RB tree after an insert.
Definition at line 149 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Insert().
| bool csRedBlackTree< K >::IsBlack | ( | Node * | node | ) | const [inline, protected] |
Check whether a node is black. Note that 0 nodes are by definition black.
Definition at line 143 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteFixup().
| bool csRedBlackTree< K >::IsEmpty | ( | ) | const [inline] |
Returns whether this tree has no nodes.
Reimplemented in csRedBlackTreeMap< K, T >.
Definition at line 506 of file redblacktree.h.
| bool csRedBlackTree< K >::IsRed | ( | Node * | node | ) | const [inline, protected] |
Check whether a node is red.
Definition at line 146 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteFixup(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::InsertFixup().
| Node* csRedBlackTree< K >::LocateNode | ( | Node * | node, | |
| const K & | key | |||
| ) | const [inline, protected] |
Find the node for a key.
Definition at line 314 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Delete(), csRedBlackTree< csRedBlackTreePayload< K, T > >::In(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::LocateNode().
| void csRedBlackTree< K >::RecursiveCopy | ( | Node *& | to, | |
| Node * | parent, | |||
| const Node * | from | |||
| ) | [inline, protected] |
Duplicate a subtree.
Definition at line 419 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::csRedBlackTree(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::RecursiveCopy().
| const K* csRedBlackTree< K >::RecursiveFind | ( | Node * | node, | |
| const K2 & | other | |||
| ) | const [inline, protected] |
Locate key that is equal to 'other'.
Definition at line 347 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Find(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::RecursiveFind().
| Node* csRedBlackTree< K >::RecursiveInsert | ( | Node * | parent, | |
| Node *& | node, | |||
| const K & | key | |||
| ) | [inline, protected] |
Locate the place where a new node needs to be inserted.
Definition at line 82 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::Insert(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::RecursiveInsert().
| void csRedBlackTree< K >::RecursiveTraverseInOrder | ( | Node * | node, | |
| CB & | callback | |||
| ) | const [inline, protected] |
Traverse tree.
Definition at line 397 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::RecursiveTraverseInOrder(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::TraverseInOrder().
| void csRedBlackTree< K >::RotateLeft | ( | Node * | pivot | ) | [inline, protected] |
Left-rotate subtree around 'pivot'.
Definition at line 105 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteFixup(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::InsertFixup().
| void csRedBlackTree< K >::RotateRight | ( | Node * | pivot | ) | [inline, protected] |
Right-rotate subtree around 'pivot'.
Definition at line 124 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteFixup(), and csRedBlackTree< csRedBlackTreePayload< K, T > >::InsertFixup().
| Node* csRedBlackTree< K >::Successor | ( | Node * | node | ) | const [inline, protected] |
Return smallest node with a key greater than 'node's.
Definition at line 327 of file redblacktree.h.
Referenced by csRedBlackTree< csRedBlackTreePayload< K, T > >::DeleteNode().
| void csRedBlackTree< K >::TraverseInOrder | ( | CB & | callback | ) | const [inline] |
Traverse tree.
Reimplemented in csRedBlackTreeMap< K, T >.
Definition at line 511 of file redblacktree.h.
The documentation for this class was generated from the following file:
- csutil/redblacktree.h
Generated for Crystal Space by doxygen 1.4.7