LLVM 22.0.0git
llvm::ImmutableSet< ValT, ValInfo > Class Template Reference

#include "llvm/ADT/ImmutableSet.h"

Classes

class  Factory

Public Types

using value_type = typename ValInfo::value_type
using value_type_ref = typename ValInfo::value_type_ref
using TreeTy = ImutAVLTree<ValInfo>
using iterator = ImutAVLValueIterator<ImmutableSet>

Public Member Functions

 ImmutableSet (TreeTy *R)
 Constructs a set from a pointer to a tree root.
bool contains (value_type_ref V) const
 Returns true if the set contains the specified value.
bool operator== (const ImmutableSet &RHS) const
bool operator!= (const ImmutableSet &RHS) const
TreeTygetRoot ()
TreeTygetRootWithoutRetain () const
bool isEmpty () const
 isEmpty - Return true if the set contains no elements.
bool isSingleton () const
 isSingleton - 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 void Profile (FoldingSetNodeID &ID, const ImmutableSet &S)

Friends

class Factory

Detailed Description

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

Definition at line 984 of file ImmutableSet.h.

Member Typedef Documentation

◆ iterator

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

Definition at line 1084 of file ImmutableSet.h.

◆ TreeTy

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

Definition at line 988 of file ImmutableSet.h.

◆ value_type

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

Definition at line 986 of file ImmutableSet.h.

◆ value_type_ref

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

Definition at line 987 of file ImmutableSet.h.

Constructor & Destructor Documentation

◆ ImmutableSet()

template<typename ValT, typename ValInfo = ImutContainerInfo<ValT>>
llvm::ImmutableSet< ValT, ValInfo >::ImmutableSet ( TreeTy * R)
inlineexplicit

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

Referenced by llvm::ImmutableSet< ValT, ValInfo >::Factory::add(), llvm::ImmutableSet< ValT, ValInfo >::Factory::getEmptySet(), operator!=(), operator==(), Profile(), and llvm::ImmutableSet< ValT, ValInfo >::Factory::remove().

Member Function Documentation

◆ begin()

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

Definition at line 1086 of file ImmutableSet.h.

◆ contains()

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

Returns true if the set contains the specified value.

Definition at line 1053 of file ImmutableSet.h.

◆ end()

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

Definition at line 1087 of file ImmutableSet.h.

◆ getHeight()

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

Definition at line 1093 of file ImmutableSet.h.

Referenced by isSingleton().

◆ getRoot()

template<typename ValT, typename ValInfo = ImutContainerInfo<ValT>>
TreeTy * llvm::ImmutableSet< ValT, ValInfo >::getRoot ( )
inline

Definition at line 1066 of file ImmutableSet.h.

◆ getRootWithoutRetain()

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

Definition at line 1071 of file ImmutableSet.h.

◆ isEmpty()

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

isEmpty - Return true if the set contains no elements.

Definition at line 1074 of file ImmutableSet.h.

◆ isSingleton()

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

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

This method runs in constant time.

Definition at line 1078 of file ImmutableSet.h.

References getHeight().

◆ operator!=()

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

Definition at line 1061 of file ImmutableSet.h.

References ImmutableSet(), and RHS.

◆ operator==()

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

Definition at line 1057 of file ImmutableSet.h.

References ImmutableSet(), and RHS.

◆ Profile() [1/2]

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

Definition at line 1099 of file ImmutableSet.h.

References Profile().

Referenced by Profile().

◆ Profile() [2/2]

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

Definition at line 1095 of file ImmutableSet.h.

References ImmutableSet().

◆ validateTree()

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

Definition at line 1105 of file ImmutableSet.h.

◆ Factory

template<typename ValT, typename ValInfo = ImutContainerInfo<ValT>>
friend class Factory
friend

Definition at line 1050 of file ImmutableSet.h.


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