LLVM  6.0.0svn
Public Types | Public Member Functions | Friends | List of all members
llvm::ImutAVLTree< ImutInfo > Class Template Reference

#include "llvm/ADT/ImmutableSet.h"

Public Types

using key_type_ref = typename ImutInfo::key_type_ref
 
using value_type = typename ImutInfo::value_type
 
using value_type_ref = typename ImutInfo::value_type_ref
 
using Factory = ImutAVLFactory< ImutInfo >
 
using iterator = ImutAVLTreeInOrderIterator< ImutInfo >
 

Public Member Functions

ImutAVLTreegetLeft () const
 Return a pointer to the left subtree. More...
 
ImutAVLTreegetRight () const
 Return a pointer to the right subtree. More...
 
unsigned getHeight () const
 getHeight - Returns the height of the tree. More...
 
const value_typegetValue () const
 getValue - Returns the data value associated with the tree node. More...
 
ImutAVLTreefind (key_type_ref K)
 find - Finds the subtree associated with the specified key value. More...
 
ImutAVLTreegetMaxElement ()
 getMaxElement - Find the subtree associated with the highest ranged key value. More...
 
unsigned size () const
 size - Returns the number of nodes in the tree, which includes both leaves and non-leaf nodes. More...
 
iterator begin () const
 begin - Returns an iterator that iterates over the nodes of the tree in an inorder traversal. More...
 
iterator end () const
 end - Returns an iterator for the tree that denotes the end of an inorder traversal. More...
 
bool isElementEqual (value_type_ref V) const
 
bool isElementEqual (const ImutAVLTree *RHS) const
 
bool isEqual (const ImutAVLTree &RHS) const
 isEqual - Compares two trees for structural equality and returns true if they are equal. More...
 
bool isNotEqual (const ImutAVLTree &RHS) const
 isNotEqual - Compares two trees for structural inequality. More...
 
bool contains (key_type_ref K)
 contains - Returns true if this tree contains a subtree (node) that has an data element that matches the specified key. More...
 
template<typename Callback >
void foreach (Callback &C)
 foreach - A member template the accepts invokes operator() on a functor object (specifed by Callback) for every node/subtree in the tree. More...
 
unsigned validateTree () const
 validateTree - A utility method that checks that the balancing and ordering invariants of the tree are satisifed. More...
 
void retain ()
 
void release ()
 
void destroy ()
 

Friends

class ImutAVLFactory< ImutInfo >
 
class ImutIntervalAVLFactory< ImutInfo >
 
class ImutAVLTreeGenericIterator< ImutInfo >
 

Detailed Description

template<typename ImutInfo>
class llvm::ImutAVLTree< ImutInfo >

Definition at line 42 of file ImmutableSet.h.

Member Typedef Documentation

◆ Factory

template<typename ImutInfo >
using llvm::ImutAVLTree< ImutInfo >::Factory = ImutAVLFactory<ImutInfo>

Definition at line 47 of file ImmutableSet.h.

◆ iterator

template<typename ImutInfo >
using llvm::ImutAVLTree< ImutInfo >::iterator = ImutAVLTreeInOrderIterator<ImutInfo>

Definition at line 48 of file ImmutableSet.h.

◆ key_type_ref

template<typename ImutInfo >
using llvm::ImutAVLTree< ImutInfo >::key_type_ref = typename ImutInfo::key_type_ref

Definition at line 44 of file ImmutableSet.h.

◆ value_type

template<typename ImutInfo >
using llvm::ImutAVLTree< ImutInfo >::value_type = typename ImutInfo::value_type

Definition at line 45 of file ImmutableSet.h.

◆ value_type_ref

template<typename ImutInfo >
using llvm::ImutAVLTree< ImutInfo >::value_type_ref = typename ImutInfo::value_type_ref

Definition at line 46 of file ImmutableSet.h.

Member Function Documentation

◆ begin()

template<typename ImutInfo >
iterator llvm::ImutAVLTree< ImutInfo >::begin ( ) const
inline

begin - Returns an iterator that iterates over the nodes of the tree in an inorder traversal.

The returned iterator thus refers to the the tree node with the minimum data element.

Definition at line 112 of file ImmutableSet.h.

Referenced by llvm::ImutAVLFactory< ImutInfo >::compareTreeWithSection(), llvm::ImutAVLFactory< ImutInfo >::getCanonicalTree(), and llvm::ImutAVLTree< ImutInfo >::isEqual().

◆ contains()

template<typename ImutInfo >
bool llvm::ImutAVLTree< ImutInfo >::contains ( key_type_ref  K)
inline

contains - Returns true if this tree contains a subtree (node) that has an data element that matches the specified key.

Complexity is logarithmic in the size of the tree.

Definition at line 170 of file ImmutableSet.h.

References llvm::ImutAVLTree< ImutInfo >::find().

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::contains(), llvm::ImmutableMapRef< KeyT, ValT, ValInfo >::contains(), llvm::ImmutableSet< ValT, ValInfo >::contains(), and llvm::ImmutableSetRef< ValT, ValInfo >::contains().

◆ destroy()

template<typename ImutInfo >
void llvm::ImutAVLTree< ImutInfo >::destroy ( )
inline

◆ end()

template<typename ImutInfo >
iterator llvm::ImutAVLTree< ImutInfo >::end ( ) const
inline

end - Returns an iterator for the tree that denotes the end of an inorder traversal.

Definition at line 116 of file ImmutableSet.h.

Referenced by llvm::ImutAVLFactory< ImutInfo >::compareTreeWithSection(), llvm::ImutAVLFactory< ImutInfo >::getCanonicalTree(), and llvm::ImutAVLTree< ImutInfo >::isEqual().

◆ find()

template<typename ImutInfo >
ImutAVLTree* llvm::ImutAVLTree< ImutInfo >::find ( key_type_ref  K)
inline

find - Finds the subtree associated with the specified key value.

This method returns NULL if no matching subtree is found.

Definition at line 75 of file ImmutableSet.h.

References llvm::ImutAVLTree< ImutInfo >::getLeft(), llvm::ImutAVLTree< ImutInfo >::getRight(), llvm::ImutAVLTree< ImutInfo >::getValue(), and isEqual().

Referenced by llvm::ImutAVLTree< ImutInfo >::contains(), llvm::ImmutableMap< KeyT, ValT, ValInfo >::lookup(), and llvm::ImmutableMapRef< KeyT, ValT, ValInfo >::lookup().

◆ foreach()

template<typename ImutInfo >
template<typename Callback >
void llvm::ImutAVLTree< ImutInfo >::foreach ( Callback &  C)
inline

foreach - A member template the accepts invokes operator() on a functor object (specifed by Callback) for every node/subtree in the tree.

Nodes are visited using an inorder traversal.

Definition at line 176 of file ImmutableSet.h.

References C, llvm::ImutAVLTree< ImutInfo >::getLeft(), llvm::ImutAVLTree< ImutInfo >::getRight(), and llvm::RISCVFenceField::R.

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::foreach(), and llvm::ImmutableSet< ValT, ValInfo >::foreach().

◆ getHeight()

template<typename ImutInfo >
unsigned llvm::ImutAVLTree< ImutInfo >::getHeight ( ) const
inline

◆ getLeft()

template<typename ImutInfo >
ImutAVLTree* llvm::ImutAVLTree< ImutInfo >::getLeft ( ) const
inline

◆ getMaxElement()

template<typename ImutInfo >
ImutAVLTree* llvm::ImutAVLTree< ImutInfo >::getMaxElement ( )
inline

getMaxElement - Find the subtree associated with the highest ranged key value.

Definition at line 91 of file ImmutableSet.h.

References llvm::ImutAVLTree< ImutInfo >::getRight(), llvm::Right, and T.

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::getMaxElement(), and llvm::ImmutableMapRef< KeyT, ValT, ValInfo >::getMaxElement().

◆ getRight()

template<typename ImutInfo >
ImutAVLTree* llvm::ImutAVLTree< ImutInfo >::getRight ( ) const
inline

◆ getValue()

template<typename ImutInfo >
const value_type& llvm::ImutAVLTree< ImutInfo >::getValue ( ) const
inline

◆ isElementEqual() [1/2]

template<typename ImutInfo >
bool llvm::ImutAVLTree< ImutInfo >::isElementEqual ( value_type_ref  V) const
inline

◆ isElementEqual() [2/2]

template<typename ImutInfo >
bool llvm::ImutAVLTree< ImutInfo >::isElementEqual ( const ImutAVLTree< ImutInfo > *  RHS) const
inline

◆ isEqual()

template<typename ImutInfo >
bool llvm::ImutAVLTree< ImutInfo >::isEqual ( const ImutAVLTree< ImutInfo > &  RHS) const
inline

◆ isNotEqual()

template<typename ImutInfo >
bool llvm::ImutAVLTree< ImutInfo >::isNotEqual ( const ImutAVLTree< ImutInfo > &  RHS) const
inline

◆ release()

template<typename ImutInfo >
void llvm::ImutAVLTree< ImutInfo >::release ( )
inline

◆ retain()

template<typename ImutInfo >
void llvm::ImutAVLTree< ImutInfo >::retain ( )
inline

◆ size()

template<typename ImutInfo >
unsigned llvm::ImutAVLTree< ImutInfo >::size ( ) const
inline

size - Returns the number of nodes in the tree, which includes both leaves and non-leaf nodes.

Definition at line 100 of file ImmutableSet.h.

References llvm::ImutAVLTree< ImutInfo >::getLeft(), llvm::ImutAVLTree< ImutInfo >::getRight(), and llvm::RISCVFenceField::R.

◆ validateTree()

template<typename ImutInfo >
unsigned llvm::ImutAVLTree< ImutInfo >::validateTree ( ) const
inline

validateTree - A utility method that checks that the balancing and ordering invariants of the tree are satisifed.

It is a recursive method that returns the height of the tree, which is then consumed by the enclosing validateTree call. External callers should ignore the return value. An invalid tree will cause an assertion to fire in a debug build.

Definition at line 192 of file ImmutableSet.h.

References assert(), llvm::FoldingSetNodeID::ComputeHash(), llvm::ImutAVLTree< ImutInfo >::getHeight(), llvm::ImutAVLTree< ImutInfo >::getLeft(), llvm::ImutAVLTree< ImutInfo >::getRight(), llvm::ImutAVLTree< ImutInfo >::getValue(), llvm::RISCVFenceField::R, llvm::ImutAVLTree< ImutInfo >::retain(), llvm::ImutAVLTree< ImutInfo >::validateTree(), and X.

Referenced by llvm::ImutAVLTree< ImutInfo >::validateTree(), llvm::ImmutableSet< ValT, ValInfo >::validateTree(), and llvm::ImmutableSetRef< ValT, ValInfo >::validateTree().

Friends And Related Function Documentation

◆ ImutAVLFactory< ImutInfo >

template<typename ImutInfo >
friend class ImutAVLFactory< ImutInfo >
friend

Definition at line 50 of file ImmutableSet.h.

◆ ImutAVLTreeGenericIterator< ImutInfo >

template<typename ImutInfo >
friend class ImutAVLTreeGenericIterator< ImutInfo >
friend

Definition at line 52 of file ImmutableSet.h.

◆ ImutIntervalAVLFactory< ImutInfo >

template<typename ImutInfo >
friend class ImutIntervalAVLFactory< ImutInfo >
friend

Definition at line 51 of file ImmutableSet.h.


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