#include "llvm/ADT/ImmutableMap.h"

Collaboration diagram for llvm::ImmutableMap< KeyT, ValT, ValInfo >:

Classes
class	Factory

class	iterator

Public Types
using	value_type = typename ValInfo::value_type

using	value_type_ref = typename ValInfo::value_type_ref

using	key_type = typename ValInfo::key_type

using	key_type_ref = typename ValInfo::key_type_ref

using	data_type = typename ValInfo::data_type

using	data_type_ref = typename ValInfo::data_type_ref

using	TreeTy = ImutAVLTree< ValInfo >

Public Member Functions
	ImmutableMap (const TreeTy *R)
	Constructs a map from a pointer to a tree root. More...

	ImmutableMap (const ImmutableMap &X)

	~ImmutableMap ()

ImmutableMap &	operator= (const ImmutableMap &X)

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
	getMaxElement - Returns the <key,value> pair in the ImmutableMap for which key is the highest in the ordering of keys in the map. More...

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 63 of file ImmutableMap.h.

Member Typedef Documentation

◆ data_type

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::data_type = typename ValInfo::data_type

Definition at line 69 of file ImmutableMap.h.

◆ data_type_ref

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::data_type_ref = typename ValInfo::data_type_ref

Definition at line 70 of file ImmutableMap.h.

◆ key_type

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::key_type = typename ValInfo::key_type

Definition at line 67 of file ImmutableMap.h.

◆ key_type_ref

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::key_type_ref = typename ValInfo::key_type_ref

Definition at line 68 of file ImmutableMap.h.

◆ TreeTy

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::TreeTy = ImutAVLTree<ValInfo>

Definition at line 71 of file ImmutableMap.h.

◆ value_type

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::value_type = typename ValInfo::value_type

Definition at line 65 of file ImmutableMap.h.

◆ value_type_ref

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

using llvm::ImmutableMap< KeyT, ValT, ValInfo >::value_type_ref = typename ValInfo::value_type_ref

Definition at line 66 of file ImmutableMap.h.

Constructor & Destructor Documentation

◆ ImmutableMap() [1/2]

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 81 of file ImmutableMap.h.

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

◆ ImmutableMap() [2/2]

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 85 of file ImmutableMap.h.

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

◆ ~ImmutableMap()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

llvm::ImmutableMap< KeyT, ValT, ValInfo >::~ImmutableMap ( )

inline

Definition at line 89 of file ImmutableMap.h.

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

Member Function Documentation

◆ begin()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

iterator llvm::ImmutableMap< KeyT, ValT, ValInfo >::begin ( ) const

inline

Definition at line 221 of file ImmutableMap.h.

◆ contains()

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 133 of file ImmutableMap.h.

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

◆ end()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

iterator llvm::ImmutableMap< KeyT, ValT, ValInfo >::end ( ) const

inline

Definition at line 222 of file ImmutableMap.h.

◆ foreach() [1/2]

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 185 of file ImmutableMap.h.

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

◆ foreach() [2/2]

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

template<typename Callback >

void llvm::ImmutableMap< KeyT, ValT, ValInfo >::foreach ( )

inline

Definition at line 193 of file ImmutableMap.h.

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

◆ getHeight()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

unsigned llvm::ImmutableMap< KeyT, ValT, ValInfo >::getHeight ( ) const

inline

Definition at line 244 of file ImmutableMap.h.

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

◆ getMaxElement()

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 236 of file ImmutableMap.h.

References llvm::ImutAVLTree< ImutInfo >::getMaxElement(), and llvm::ImutAVLTree< ImutInfo >::getValue().

◆ getRoot()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::getRoot ( ) const

inline

Definition at line 145 of file ImmutableMap.h.

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

◆ getRootWithoutRetain()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::getRootWithoutRetain ( ) const

inline

Definition at line 150 of file ImmutableMap.h.

◆ isEmpty()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

bool llvm::ImmutableMap< KeyT, ValT, ValInfo >::isEmpty ( ) const

inline

Definition at line 160 of file ImmutableMap.h.

References C.

◆ lookup()

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 224 of file ImmutableMap.h.

References llvm::ImutAVLTree< ImutInfo >::find(), and llvm::ImutAVLTree< ImutInfo >::getValue().

◆ manualRelease()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

void llvm::ImmutableMap< KeyT, ValT, ValInfo >::manualRelease ( )

inline

Definition at line 156 of file ImmutableMap.h.

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

◆ manualRetain()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

void llvm::ImmutableMap< KeyT, ValT, ValInfo >::manualRetain ( )

inline

Definition at line 152 of file ImmutableMap.h.

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

◆ operator!=()

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 141 of file ImmutableMap.h.

References llvm::ImutAVLTree< ImutInfo >::isNotEqual(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root.

◆ operator=()

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 93 of file ImmutableMap.h.

References llvm::ImutAVLTree< ImutInfo >::release(), llvm::ImutAVLTree< ImutInfo >::retain(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root.

◆ operator==()

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.

References llvm::ImutAVLTree< ImutInfo >::isEqual(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root.

◆ Profile() [1/2]

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 246 of file ImmutableMap.h.

References llvm::FoldingSetNodeID::AddPointer(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root.

◆ Profile() [2/2]

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

void llvm::ImmutableMap< KeyT, ValT, ValInfo >::Profile ( FoldingSetNodeID & ID ) const

inline

Definition at line 250 of file ImmutableMap.h.

References llvm::ImutKeyValueInfo< T, S >::Profile().

◆ verify()

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

void llvm::ImmutableMap< KeyT, ValT, ValInfo >::verify ( ) const

inline

Definition at line 204 of file ImmutableMap.h.

Member Data Documentation

◆ Root

template<typename KeyT, typename ValT, typename ValInfo = ImutKeyValueInfo<KeyT,ValT>>

TreeTy* llvm::ImmutableMap< KeyT, ValT, ValInfo >::Root

protected

Definition at line 74 of file ImmutableMap.h.

Referenced by llvm::ImmutableMap< KeyT, ValT, ValInfo >::Factory::add(), llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator!=(), llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator=(), llvm::ImmutableMap< KeyT, ValT, ValInfo >::operator==(), and llvm::ImmutableMap< KeyT, ValT, ValInfo >::Profile().

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

include/llvm/ADT/ImmutableMap.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ data_type

◆ data_type_ref

◆ key_type

◆ key_type_ref

◆ TreeTy

◆ value_type

◆ value_type_ref

Constructor & Destructor Documentation

◆ ImmutableMap() [1/2]

◆ ImmutableMap() [2/2]

◆ ~ImmutableMap()

Member Function Documentation

◆ begin()

◆ contains()

◆ end()

◆ foreach() [1/2]

◆ foreach() [2/2]

◆ getHeight()

◆ getMaxElement()

◆ getRoot()

◆ getRootWithoutRetain()

◆ isEmpty()

◆ lookup()

◆ manualRelease()

◆ manualRetain()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ Profile() [1/2]

◆ Profile() [2/2]

◆ verify()

Member Data Documentation

◆ Root

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