LLVM 23.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.
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.
ImmutableSet< ValT > asImmutableSet (bool canonicalize=true) const
TreeTy * getRootWithoutRetain () const
bool operator== (const ImmutableSetRef &RHS) const
bool operator!= (const ImmutableSetRef &RHS) const
bool isEmpty () const
 Return true if the set contains no elements.
bool isSingleton () const
 Return true if the set contains exactly one element.
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 1097 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 1102 of file ImmutableSet.h.

◆ iterator

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

Definition at line 1159 of file ImmutableSet.h.

◆ TreeTy

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

Definition at line 1101 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 1099 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 1100 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 1113 of file ImmutableSet.h.

References F.

Referenced by add(), getEmptySet(), operator!=(), operator==(), Profile(), and remove().

Member Function Documentation

◆ add()

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

Definition at line 1119 of file ImmutableSet.h.

References ImmutableSetRef().

◆ asImmutableSet()

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

Definition at line 1132 of file ImmutableSet.h.

◆ begin()

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

Definition at line 1161 of file ImmutableSet.h.

◆ 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 1128 of file ImmutableSet.h.

◆ end()

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

Definition at line 1162 of file ImmutableSet.h.

◆ getEmptySet()

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

Definition at line 1115 of file ImmutableSet.h.

References F, and ImmutableSetRef().

◆ getHeight()

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

Definition at line 1168 of file ImmutableSet.h.

Referenced by isSingleton().

◆ getRootWithoutRetain()

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

Definition at line 1137 of file ImmutableSet.h.

◆ isEmpty()

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

Return true if the set contains no elements.

Definition at line 1149 of file ImmutableSet.h.

◆ isSingleton()

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

Return true if the set contains exactly one element.

This method runs in constant time.

Definition at line 1153 of file ImmutableSet.h.

References 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 1143 of file ImmutableSet.h.

References ImmutableSetRef(), and RHS.

◆ operator==()

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

Definition at line 1139 of file ImmutableSet.h.

References ImmutableSetRef(), and RHS.

◆ Profile() [1/2]

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

Definition at line 1174 of file ImmutableSet.h.

References Profile().

Referenced by Profile().

◆ Profile() [2/2]

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

Definition at line 1170 of file ImmutableSet.h.

References ImmutableSetRef().

◆ remove()

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

Definition at line 1123 of file ImmutableSet.h.

References ImmutableSetRef().

◆ validateTree()

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

Definition at line 1180 of file ImmutableSet.h.

The documentation for this class was generated from the following file:
Generated on for LLVM by doxygen 1.14.0