LLVM  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::ImmutableSetRef< ValT, ValInfo > Class Template Reference

#include "llvm/ADT/ImmutableSet.h"

Public Types

using value_type = typename ValInfo::value_type
 
using value_type_ref = typename ValInfo::value_type_ref
 
using TreeTy = ImutAVLTree< ValInfo >
 
using FactoryTy = typename TreeTy::Factory
 
using iterator = ImutAVLValueIterator< ImmutableSetRef >
 

Public Member Functions

 ImmutableSetRef (TreeTy *R, FactoryTy *F)
 Constructs a set from a pointer to a tree root. More...
 
ImmutableSetRef add (value_type_ref V)
 
ImmutableSetRef remove (value_type_ref V)
 
bool contains (value_type_ref V) const
 Returns true if the set contains the specified value. More...
 
ImmutableSet< ValTasImmutableSet (bool canonicalize=true) const
 
TreeTygetRootWithoutRetain () const
 
bool operator== (const ImmutableSetRef &RHS) const
 
bool operator!= (const ImmutableSetRef &RHS) const
 
bool isEmpty () const
 isEmpty - Return true if the set contains no elements. More...
 
bool isSingleton () const
 isSingleton - Return true if the set contains exactly one element. More...
 
iterator begin () const
 
iterator end () const
 
unsigned getHeight () const
 
void Profile (FoldingSetNodeID &ID) const
 
void validateTree () const
 

Static Public Member Functions

static ImmutableSetRef getEmptySet (FactoryTy *F)
 
static void Profile (FoldingSetNodeID &ID, const ImmutableSetRef &S)
 

Detailed Description

template<typename ValT, typename ValInfo = ImutContainerInfo<ValT>>
class llvm::ImmutableSetRef< ValT, ValInfo >

Definition at line 1102 of file ImmutableSet.h.

Member Typedef Documentation

◆ FactoryTy

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
using llvm::ImmutableSetRef< ValT, ValInfo >::FactoryTy = typename TreeTy::Factory

Definition at line 1107 of file ImmutableSet.h.

◆ iterator

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
using llvm::ImmutableSetRef< ValT, ValInfo >::iterator = ImutAVLValueIterator<ImmutableSetRef>

Definition at line 1164 of file ImmutableSet.h.

◆ TreeTy

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
using llvm::ImmutableSetRef< ValT, ValInfo >::TreeTy = ImutAVLTree<ValInfo>

Definition at line 1106 of file ImmutableSet.h.

◆ value_type

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
using llvm::ImmutableSetRef< ValT, ValInfo >::value_type = typename ValInfo::value_type

Definition at line 1104 of file ImmutableSet.h.

◆ value_type_ref

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
using llvm::ImmutableSetRef< ValT, ValInfo >::value_type_ref = typename ValInfo::value_type_ref

Definition at line 1105 of file ImmutableSet.h.

Constructor & Destructor Documentation

◆ ImmutableSetRef()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
llvm::ImmutableSetRef< ValT, ValInfo >::ImmutableSetRef ( TreeTy R,
FactoryTy F 
)
inline

Constructs a set from a pointer to a tree root.

In general one should use a Factory object to create sets instead of directly invoking the constructor, but there are cases where make this constructor public is useful.

Definition at line 1118 of file ImmutableSet.h.

Referenced by llvm::ImmutableSetRef< ValT, ValInfo >::add(), llvm::ImmutableSetRef< ValT, ValInfo >::getEmptySet(), and llvm::ImmutableSetRef< ValT, ValInfo >::remove().

Member Function Documentation

◆ add()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
ImmutableSetRef llvm::ImmutableSetRef< ValT, ValInfo >::add ( value_type_ref  V)
inline

◆ asImmutableSet()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
ImmutableSet<ValT> llvm::ImmutableSetRef< ValT, ValInfo >::asImmutableSet ( bool  canonicalize = true) const
inline

Definition at line 1137 of file ImmutableSet.h.

References llvm::IntrusiveRefCntPtr< T >::get().

◆ begin()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
iterator llvm::ImmutableSetRef< ValT, ValInfo >::begin ( ) const
inline

Definition at line 1166 of file ImmutableSet.h.

References llvm::IntrusiveRefCntPtr< T >::get().

◆ contains()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
bool llvm::ImmutableSetRef< ValT, ValInfo >::contains ( value_type_ref  V) const
inline

Returns true if the set contains the specified value.

Definition at line 1133 of file ImmutableSet.h.

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

◆ end()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
iterator llvm::ImmutableSetRef< ValT, ValInfo >::end ( ) const
inline

Definition at line 1167 of file ImmutableSet.h.

◆ getEmptySet()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
static ImmutableSetRef llvm::ImmutableSetRef< ValT, ValInfo >::getEmptySet ( FactoryTy F)
inlinestatic

◆ getHeight()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
unsigned llvm::ImmutableSetRef< ValT, ValInfo >::getHeight ( ) const
inline

◆ getRootWithoutRetain()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
TreeTy* llvm::ImmutableSetRef< ValT, ValInfo >::getRootWithoutRetain ( ) const
inline

Definition at line 1142 of file ImmutableSet.h.

References llvm::IntrusiveRefCntPtr< T >::get().

◆ isEmpty()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
bool llvm::ImmutableSetRef< ValT, ValInfo >::isEmpty ( ) const
inline

isEmpty - Return true if the set contains no elements.

Definition at line 1154 of file ImmutableSet.h.

◆ isSingleton()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
bool llvm::ImmutableSetRef< ValT, ValInfo >::isSingleton ( ) const
inline

isSingleton - Return true if the set contains exactly one element.

This method runs in constant time.

Definition at line 1158 of file ImmutableSet.h.

References llvm::ImmutableSetRef< ValT, ValInfo >::getHeight().

◆ operator!=()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
bool llvm::ImmutableSetRef< ValT, ValInfo >::operator!= ( const ImmutableSetRef< ValT, ValInfo > &  RHS) const
inline

Definition at line 1148 of file ImmutableSet.h.

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

◆ operator==()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
bool llvm::ImmutableSetRef< ValT, ValInfo >::operator== ( const ImmutableSetRef< ValT, ValInfo > &  RHS) const
inline

Definition at line 1144 of file ImmutableSet.h.

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

◆ Profile() [1/2]

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
void llvm::ImmutableSetRef< ValT, ValInfo >::Profile ( FoldingSetNodeID ID) const
inline

◆ Profile() [2/2]

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
static void llvm::ImmutableSetRef< ValT, ValInfo >::Profile ( FoldingSetNodeID ID,
const ImmutableSetRef< ValT, ValInfo > &  S 
)
inlinestatic

Definition at line 1175 of file ImmutableSet.h.

References S.

◆ remove()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
ImmutableSetRef llvm::ImmutableSetRef< ValT, ValInfo >::remove ( value_type_ref  V)
inline

◆ validateTree()

template<typename ValT , typename ValInfo = ImutContainerInfo<ValT>>
void llvm::ImmutableSetRef< ValT, ValInfo >::validateTree ( ) const
inline

Definition at line 1185 of file ImmutableSet.h.

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


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