LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
llvm::ImmutableMap< KeyT, ValT, ValInfo > Class Template Reference

#include <ImmutableMap.h>

Inheritance diagram for llvm::ImmutableMap< KeyT, ValT, ValInfo >:
Inheritance graph
[legend]
Collaboration diagram for llvm::ImmutableMap< KeyT, ValT, ValInfo >:
Collaboration graph
[legend]

Classes

class  Factory
 
class  iterator
 

Public Types

typedef ValInfo::value_type value_type
 
typedef ValInfo::value_type_ref value_type_ref
 
typedef ValInfo::key_type key_type
 
typedef ValInfo::key_type_ref key_type_ref
 
typedef ValInfo::data_type data_type
 
typedef ValInfo::data_type_ref data_type_ref
 
typedef ImutAVLTree< ValInfo > TreeTy
 

Public Member Functions

 ImmutableMap (const TreeTy *R)
 
 ImmutableMap (const ImmutableMap &X)
 
ImmutableMap & operator= (const ImmutableMap &X)
 
 ~ImmutableMap ()
 
bool contains (key_type_ref K) const
 
bool operator== (const ImmutableMap &RHS) const
 
bool operator!= (const ImmutableMap &RHS) const
 
TreeTy * getRoot () const
 
TreeTy * getRootWithoutRetain () const
 
void manualRetain ()
 
void manualRelease ()
 
bool isEmpty () const
 
template<typename Callback >
void foreach (Callback &C)
 
template<typename Callback >
void foreach ()
 
void verify () const
 
iterator begin () const
 
iterator end () const
 
data_type * lookup (key_type_ref K) const
 
value_type * getMaxElement () const
 
unsigned getHeight () const
 
void Profile (FoldingSetNodeID &ID) const
 

Static Public Member Functions

static void Profile (FoldingSetNodeID &ID, const ImmutableMap &M)
 

Protected Attributes

TreeTy * Root
 

Detailed Description

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
class llvm::ImmutableMap< KeyT, ValT, ValInfo >

Definition at line 61 of file ImmutableMap.h.

Member Typedef Documentation

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::data_type llvm::ImmutableMap< KeyT, ValT, ValInfo >::data_type

Definition at line 67 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::data_type_ref llvm::ImmutableMap< KeyT, ValT, ValInfo >::data_type_ref

Definition at line 68 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::key_type llvm::ImmutableMap< KeyT, ValT, ValInfo >::key_type

Definition at line 65 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::key_type_ref llvm::ImmutableMap< KeyT, ValT, ValInfo >::key_type_ref

Definition at line 66 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ImutAVLTree<ValInfo> llvm::ImmutableMap< KeyT, ValT, ValInfo >::TreeTy

Definition at line 69 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::value_type llvm::ImmutableMap< KeyT, ValT, ValInfo >::value_type

Definition at line 63 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
typedef ValInfo::value_type_ref llvm::ImmutableMap< KeyT, ValT, ValInfo >::value_type_ref

Definition at line 64 of file ImmutableMap.h.

Constructor & Destructor Documentation

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
llvm::ImmutableMap< KeyT, ValT, ValInfo >::ImmutableMap ( const TreeTy *  R)
inlineexplicit

Constructs a map from a pointer to a tree root. In general one should use a Factory object to create maps instead of directly invoking the constructor, but there are cases where make this constructor public is useful.

Definition at line 79 of file ImmutableMap.h.

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::Factory::add(), llvm::ImmutableMap< KeyT, ValT, ValInfo >::Factory::getEmptyMap(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Factory::remove().

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
llvm::ImmutableMap< KeyT, ValT, ValInfo >::ImmutableMap ( const ImmutableMap< KeyT, ValT, ValInfo > &  X)
inline

Definition at line 82 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
llvm::ImmutableMap< KeyT, ValT, ValInfo >::~ImmutableMap ( )
inline

Definition at line 93 of file ImmutableMap.h.

Member Function Documentation

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
iterator llvm::ImmutableMap< KeyT, ValT, ValInfo >::begin ( ) const
inline

Definition at line 235 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
bool llvm::ImmutableMap< KeyT, ValT, ValInfo >::contains ( key_type_ref  K) const
inline

Definition at line 129 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
iterator llvm::ImmutableMap< KeyT, ValT, ValInfo >::end ( ) const
inline

Definition at line 236 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
template<typename Callback >
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::foreach ( Callback &  C)
inline

Definition at line 181 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
template<typename Callback >
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::foreach ( )
inline

Definition at line 189 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
unsigned llvm::ImmutableMap< KeyT, ValT, ValInfo >::getHeight ( ) const
inline

Definition at line 258 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
value_type* llvm::ImmutableMap< KeyT, ValT, ValInfo >::getMaxElement ( ) const
inline

getMaxElement - Returns the <key,value> pair in the ImmutableMap for which key is the highest in the ordering of keys in the map. This method returns NULL if the map is empty.

Definition at line 250 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::getRoot ( ) const
inline

Definition at line 141 of file ImmutableMap.h.

Referenced by llvm::ImmutableIntervalMap< ValT >::Factory::lookup().

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::getRootWithoutRetain ( ) const
inline

Definition at line 146 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
bool llvm::ImmutableMap< KeyT, ValT, ValInfo >::isEmpty ( ) const
inline

Definition at line 158 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
data_type* llvm::ImmutableMap< KeyT, ValT, ValInfo >::lookup ( key_type_ref  K) const
inline

Definition at line 238 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::manualRelease ( )
inline

Definition at line 154 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::manualRetain ( )
inline

Definition at line 150 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
bool llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator!= ( const ImmutableMap< KeyT, ValT, ValInfo > &  RHS) const
inline

Definition at line 137 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
ImmutableMap& llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator= ( const ImmutableMap< KeyT, ValT, ValInfo > &  X)
inline

Definition at line 85 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
bool llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator== ( const ImmutableMap< KeyT, ValT, ValInfo > &  RHS) const
inline

Definition at line 133 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
static void llvm::ImmutableMap< KeyT, ValT, ValInfo >::Profile ( FoldingSetNodeID &  ID,
const ImmutableMap< KeyT, ValT, ValInfo > &  M 
)
inlinestatic

Definition at line 260 of file ImmutableMap.h.

Referenced by llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::Profile().

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::Profile ( FoldingSetNodeID &  ID) const
inline

Definition at line 264 of file ImmutableMap.h.

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
void llvm::ImmutableMap< KeyT, ValT, ValInfo >::verify ( ) const
inline

Definition at line 200 of file ImmutableMap.h.

Member Data Documentation

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>
TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root
protected

Definition at line 72 of file ImmutableMap.h.

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::Factory::add(), llvm::ImmutableIntervalMap< ValT >::Factory::add(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::begin(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::contains(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::foreach(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::getHeight(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::getMaxElement(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::getRoot(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::getRootWithoutRetain(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::ImmutableMap(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::isEmpty(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::lookup(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::manualRelease(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::manualRetain(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::operator!=(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::operator=(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::operator==(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::Profile(), llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::verify(), and llvm::ImmutableMap< Interval, ValT, ImutIntervalInfo< ValT > >::~ImmutableMap().

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

Generated on Tue Mar 18 2014 10:39:57 for LLVM by Doxygen1.8.6
Copyright © 2003-2013 University of Illinois at Urbana-Champaign. All Rights Reserved.