A vector that has set insertion semantics. More...

#include "llvm/ADT/SetVector.h"

Inheritance diagram for llvm::SetVector< T, Vector, Set >:

[legend]

Public Types
using	value_type = T

using	key_type = T

using	reference = T &

using	const_reference = const T &

using	set_type = Set

using	vector_type = Vector

using	iterator = typename vector_type::const_iterator

using	const_iterator = typename vector_type::const_iterator

using	reverse_iterator = typename vector_type::const_reverse_iterator

using	const_reverse_iterator = typename vector_type::const_reverse_iterator

using	size_type = typename vector_type::size_type

Public Member Functions
	SetVector ()=default
	Construct an empty SetVector. More...

template<typename It >
	SetVector (It Start, It End)
	Initialize a SetVector with a range of elements. More...

ArrayRef< T >	getArrayRef () const

Vector	takeVector ()
	Clear the SetVector and return the underlying vector. More...

bool	empty () const
	Determine if the SetVector is empty or not. More...

size_type	size () const
	Determine the number of elements in the SetVector. More...

iterator	begin ()
	Get an iterator to the beginning of the SetVector. More...

const_iterator	begin () const
	Get a const_iterator to the beginning of the SetVector. More...

iterator	end ()
	Get an iterator to the end of the SetVector. More...

const_iterator	end () const
	Get a const_iterator to the end of the SetVector. More...

reverse_iterator	rbegin ()
	Get an reverse_iterator to the end of the SetVector. More...

const_reverse_iterator	rbegin () const
	Get a const_reverse_iterator to the end of the SetVector. More...

reverse_iterator	rend ()
	Get a reverse_iterator to the beginning of the SetVector. More...

const_reverse_iterator	rend () const
	Get a const_reverse_iterator to the beginning of the SetVector. More...

const T &	front () const
	Return the first element of the SetVector. More...

const T &	back () const
	Return the last element of the SetVector. More...

const_reference	operator[] (size_type n) const
	Index into the SetVector. More...

bool	insert (const value_type &X)
	Insert a new element into the SetVector. More...

template<typename It >
void	insert (It Start, It End)
	Insert a range of elements into the SetVector. More...

bool	remove (const value_type &X)
	Remove an item from the set vector. More...

iterator	erase (iterator I)
	Erase a single element from the set vector. More...

template<typename UnaryPredicate >
bool	remove_if (UnaryPredicate P)
	Remove items from the set vector based on a predicate function. More...

bool	contains (const key_type &key) const
	Check if the SetVector contains the given key. More...

size_type	count (const key_type &key) const
	Count the number of elements of a given key in the SetVector. More...

void	clear ()
	Completely clear the SetVector. More...

void	pop_back ()
	Remove the last element of the SetVector. More...

LLVM_NODISCARD T	pop_back_val ()

bool	operator== (const SetVector &that) const

bool	operator!= (const SetVector &that) const

template<class STy >
bool	set_union (const STy &S)
	Compute This := This u S, return whether 'This' changed. More...

template<class STy >
void	set_subtract (const STy &S)
	Compute This := This - B TODO: We should be able to use set_subtract from SetOperations.h, but SetVector interface is inconsistent with DenseSet. More...

void	swap (SetVector< T, Vector, Set > &RHS)

Detailed Description

template<typename T, typename Vector = std::vector<T>, typename Set = DenseSet<T>>
class llvm::SetVector< T, Vector, Set >

A vector that has set insertion semantics.

This adapter class provides a way to keep a set of things that also has the property of a deterministic iteration order. The order of iteration is the order of insertion.

Definition at line 40 of file SetVector.h.

Member Typedef Documentation

◆ const_iterator

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::const_iterator = typename vector_type::const_iterator

Definition at line 49 of file SetVector.h.

◆ const_reference

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::const_reference = const T&

Definition at line 45 of file SetVector.h.

◆ const_reverse_iterator

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::const_reverse_iterator = typename vector_type::const_reverse_iterator

Definition at line 51 of file SetVector.h.

◆ iterator

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::iterator = typename vector_type::const_iterator

Definition at line 48 of file SetVector.h.

◆ key_type

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::key_type = T

Definition at line 43 of file SetVector.h.

◆ reference

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::reference = T&

Definition at line 44 of file SetVector.h.

◆ reverse_iterator

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::reverse_iterator = typename vector_type::const_reverse_iterator

Definition at line 50 of file SetVector.h.

◆ set_type

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::set_type = Set

Definition at line 46 of file SetVector.h.

◆ size_type

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::size_type = typename vector_type::size_type

Definition at line 52 of file SetVector.h.

◆ value_type

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::value_type = T

Definition at line 42 of file SetVector.h.

◆ vector_type

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

using llvm::SetVector< T, Vector, Set >::vector_type = Vector

Definition at line 47 of file SetVector.h.

Constructor & Destructor Documentation

◆ SetVector() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

llvm::SetVector< T, Vector, Set >::SetVector ( )

default

Construct an empty SetVector.

◆ SetVector() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

template<typename It >

llvm::SetVector< T, Vector, Set >::SetVector	(	It	Start,
		It	End
	)

inline

Initialize a SetVector with a range of elements.

Definition at line 59 of file SetVector.h.

Member Function Documentation

◆ back()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const T& llvm::SetVector< T, Vector, Set >::back ( ) const

inline

Return the last element of the SetVector.

Definition at line 128 of file SetVector.h.

Referenced by llvm::DGNode< NodeType, EdgeType >::back(), createGuardBlocks(), llvm::SetVector< llvm::ElementCount, SmallVector< llvm::ElementCount, N >, SmallDenseSet< llvm::ElementCount, N > >::pop_back(), llvm::SetVector< llvm::ElementCount, SmallVector< llvm::ElementCount, N >, SmallDenseSet< llvm::ElementCount, N > >::pop_back_val(), llvm::OpenMPOptCGSCCPass::run(), and llvm::AttributorCGSCCPass::run().

◆ begin() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

iterator llvm::SetVector< T, Vector, Set >::begin ( )

inline

Get an iterator to the beginning of the SetVector.

Definition at line 82 of file SetVector.h.

Referenced by llvm::DGNode< NodeType, EdgeType >::begin(), llvm::NodeSet::begin(), llvm::rdf::Liveness::computeLiveIns(), llvm::SetTheory::expand(), findLiveSetAtInst(), and llvm::AttributorCallGraph::optimisticEdgesBegin().

◆ begin() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const_iterator llvm::SetVector< T, Vector, Set >::begin ( ) const

inline

Get a const_iterator to the beginning of the SetVector.

Definition at line 87 of file SetVector.h.

◆ clear()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

void llvm::SetVector< T, Vector, Set >::clear ( )

inline

Completely clear the SetVector.

Definition at line 220 of file SetVector.h.

Referenced by llvm::DGNode< NodeType, EdgeType >::clear(), and llvm::NodeSet::clear().

◆ contains()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::contains ( const key_type & key ) const

inline

Check if the SetVector contains the given key.

Definition at line 209 of file SetVector.h.

Referenced by computePath(), and llvm::VPlanTransforms::mergeReplicateRegions().

◆ count()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

size_type llvm::SetVector< T, Vector, Set >::count ( const key_type & key ) const

inline

Count the number of elements of a given key in the SetVector.

Returns: 0 if the element is not in the SetVector, 1 if it is.

Definition at line 215 of file SetVector.h.

Referenced by addMappingsFromTLI(), llvm::NodeSet::count(), createNaturalLoopInternal(), definedInCaller(), definedInRegion(), eraseLifetimeMarkersOnInputs(), findExtractedInputToOverallInputMapping(), llvm::CodeExtractor::findInputsOutputs(), getCommonExitBlock(), llvm::Attributor::getOrCreateAAFor(), llvm::InformationCache::getSccSize(), llvm::Attributor::isAssumedDead(), llvm::Attributor::isRunOn(), makeReducible(), llvm::NodeSet::NodeSet(), redirectToHub(), and shouldEmitDWARF().

◆ empty()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::empty ( ) const

inline

Determine if the SetVector is empty or not.

Definition at line 72 of file SetVector.h.

◆ end() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

iterator llvm::SetVector< T, Vector, Set >::end ( )

inline

Get an iterator to the end of the SetVector.

Definition at line 92 of file SetVector.h.

Referenced by llvm::rdf::Liveness::computeLiveIns(), llvm::DGNode< NodeType, EdgeType >::end(), llvm::NodeSet::end(), llvm::SetTheory::expand(), findLiveSetAtInst(), llvm::DGNode< NodeType, EdgeType >::hasEdgeTo(), and llvm::AttributorCallGraph::optimisticEdgesEnd().

◆ end() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const_iterator llvm::SetVector< T, Vector, Set >::end ( ) const

inline

Get a const_iterator to the end of the SetVector.

Definition at line 97 of file SetVector.h.

◆ erase()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

iterator llvm::SetVector< T, Vector, Set >::erase ( iterator I )

inline

Erase a single element from the set vector.

Returns: an iterator pointing to the next element that followed the element erased. This is the end of the SetVector if the last element is erased.

Definition at line 171 of file SetVector.h.

◆ front()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const T& llvm::SetVector< T, Vector, Set >::front ( ) const

inline

Return the first element of the SetVector.

Definition at line 122 of file SetVector.h.

Referenced by convertToGuardPredicates(), llvm::DGNode< NodeType, EdgeType >::front(), llvm::Attributor::isModulePass(), and makeReducible().

◆ getArrayRef()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

ArrayRef<T> llvm::SetVector< T, Vector, Set >::getArrayRef ( ) const

inline

Definition at line 63 of file SetVector.h.

Referenced by llvm::CodeExtractor::extractCodeRegion(), and getCodeExtractorArguments().

◆ insert() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::insert ( const value_type & X )

inline

Insert a new element into the SetVector.

Returns: true if the element was inserted into the SetVector.

Definition at line 141 of file SetVector.h.

Referenced by llvm::DGNode< NodeType, EdgeType >::addEdge(), llvm::VPlan::addExternalDef(), llvm::MCContext::addGenDwarfSection(), addIntrinsicToSummary(), addVCallToSet(), llvm::AMDGPU::collectFunctionUses(), computeFunctionSummary(), computeKillSet(), llvm::rdf::Liveness::computeLiveIns(), computeLiveOutSeed(), computePath(), llvm::rdf::Liveness::computePhiInfo(), createNaturalLoopInternal(), llvm::HexagonFrameLowering::determineCalleeSaves(), llvm::DGNode< NodeType, EdgeType >::DGNode(), eraseLifetimeMarkersOnInputs(), llvm::HexagonEvaluator::evaluate(), llvm::SetTheory::evaluate(), llvm::CodeExtractor::findAllocas(), llvm::CodeExtractor::findInputsOutputs(), findRefEdges(), llvm::DWARFYAML::Data::getNonEmptySectionNames(), llvm::NodeSet::insert(), insertIfNamed(), llvm::LiveRangeCalc::isJointlyDominated(), makeReducible(), llvm::VPlanTransforms::mergeReplicateRegions(), llvm::SIInstrInfo::moveToVALU(), remapExtractedInputs(), llvm::AttributorPass::run(), llvm::AttributorCGSCCPass::run(), llvm::SetVector< llvm::ElementCount, SmallVector< llvm::ElementCount, N >, SmallDenseSet< llvm::ElementCount, N > >::set_union(), llvm::VPlanTransforms::sinkScalarOperands(), llvm::InnerLoopVectorizer::sinkScalarOperands(), unifyLoopExits(), and llvm::slpvectorizer::BoUpSLP::vectorizeTree().

◆ insert() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

template<typename It >

void llvm::SetVector< T, Vector, Set >::insert	(	It	Start,
		It	End
	)

inline

Insert a range of elements into the SetVector.

Definition at line 150 of file SetVector.h.

◆ operator!=()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::operator!= ( const SetVector< T, Vector, Set > & that ) const

inline

Definition at line 242 of file SetVector.h.

◆ operator==()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::operator== ( const SetVector< T, Vector, Set > & that ) const

inline

Definition at line 238 of file SetVector.h.

◆ operator[]()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const_reference llvm::SetVector< T, Vector, Set >::operator[] ( size_type n ) const

inline

Index into the SetVector.

Definition at line 134 of file SetVector.h.

◆ pop_back()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

void llvm::SetVector< T, Vector, Set >::pop_back ( )

inline

Remove the last element of the SetVector.

Definition at line 226 of file SetVector.h.

Referenced by llvm::SetVector< llvm::ElementCount, SmallVector< llvm::ElementCount, N >, SmallDenseSet< llvm::ElementCount, N > >::pop_back_val().

◆ pop_back_val()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

LLVM_NODISCARD T llvm::SetVector< T, Vector, Set >::pop_back_val ( )

inline

Definition at line 232 of file SetVector.h.

Referenced by llvm::LiveRangeEdit::eliminateDeadDefs(), llvm::SIInstrInfo::moveToVALU(), llvm::VPlanTransforms::sinkScalarOperands(), and llvm::InnerLoopVectorizer::sinkScalarOperands().

◆ rbegin() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

reverse_iterator llvm::SetVector< T, Vector, Set >::rbegin ( )

inline

Get an reverse_iterator to the end of the SetVector.

Definition at line 102 of file SetVector.h.

◆ rbegin() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const_reverse_iterator llvm::SetVector< T, Vector, Set >::rbegin ( ) const

inline

Get a const_reverse_iterator to the end of the SetVector.

Definition at line 107 of file SetVector.h.

◆ remove()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

bool llvm::SetVector< T, Vector, Set >::remove ( const value_type & X )

inline

Remove an item from the set vector.

Definition at line 157 of file SetVector.h.

Referenced by computeFunctionSummary(), findLiveSetAtInst(), llvm::DGNode< NodeType, EdgeType >::removeEdge(), and llvm::SetVector< llvm::ElementCount, SmallVector< llvm::ElementCount, N >, SmallDenseSet< llvm::ElementCount, N > >::set_subtract().

◆ remove_if()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

template<typename UnaryPredicate >

bool llvm::SetVector< T, Vector, Set >::remove_if ( UnaryPredicate P )

inline

Remove items from the set vector based on a predicate function.

This is intended to be equivalent to the following code, if we could write it:

V.erase(remove_if(V, P), V.end());

However, SetVector doesn't expose non-const iterators, making any algorithm like remove_if impossible to use.

Returns: true if any element is removed.

Definition at line 199 of file SetVector.h.

Referenced by llvm::NodeSet::remove_if().

◆ rend() [1/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

reverse_iterator llvm::SetVector< T, Vector, Set >::rend ( )

inline

Get a reverse_iterator to the beginning of the SetVector.

Definition at line 112 of file SetVector.h.

◆ rend() [2/2]

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

const_reverse_iterator llvm::SetVector< T, Vector, Set >::rend ( ) const

inline

Get a const_reverse_iterator to the beginning of the SetVector.

Definition at line 117 of file SetVector.h.

◆ set_subtract()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

template<class STy >

void llvm::SetVector< T, Vector, Set >::set_subtract ( const STy & S )

inline

Compute This := This - B TODO: We should be able to use set_subtract from SetOperations.h, but SetVector interface is inconsistent with DenseSet.

Definition at line 265 of file SetVector.h.

Referenced by computeLiveInValues().

◆ set_union()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

template<class STy >

bool llvm::SetVector< T, Vector, Set >::set_union ( const STy & S )

inline

Compute This := This u S, return whether 'This' changed.

TODO: We should be able to use set_union from SetOperations.h, but SetVector interface is inconsistent with DenseSet.

Definition at line 250 of file SetVector.h.

Referenced by computeLiveInValues().

◆ size()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

size_type llvm::SetVector< T, Vector, Set >::size ( ) const

inline

Determine the number of elements in the SetVector.

Definition at line 77 of file SetVector.h.

Referenced by computeFunctionSummary(), llvm::rdf::Liveness::computeLiveIns(), computeLiveInValues(), llvm::rdf::Liveness::computePhiInfo(), convertToGuardPredicates(), createGuardBlocks(), getCodeExtractorArguments(), llvm::InformationCache::getSccSize(), llvm::LiveRangeCalc::isJointlyDominated(), llvm::Attributor::isModulePass(), makeReducible(), llvm::NodeSet::NodeSet(), llvm::slpvectorizer::BoUpSLP::optimizeGatherSequence(), reconnectPhis(), runAttributorOnFunctions(), and llvm::NodeSet::size().

◆ swap()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

void llvm::SetVector< T, Vector, Set >::swap ( SetVector< T, Vector, Set > & RHS )

inline

Definition at line 271 of file SetVector.h.

Referenced by std::swap().

◆ takeVector()

template<typename T , typename Vector = std::vector<T>, typename Set = DenseSet<T>>

Vector llvm::SetVector< T, Vector, Set >::takeVector ( )

inline

Clear the SetVector and return the underlying vector.

Definition at line 66 of file SetVector.h.

Referenced by computeFunctionSummary(), and computeVariableSummary().

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

include/llvm/ADT/SetVector.h

Public Types

Public Member Functions

Detailed Description

template<typename T, typename Vector = std::vector<T>, typename Set = DenseSet<T>> class llvm::SetVector< T, Vector, Set >

Member Typedef Documentation

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ iterator

◆ key_type

◆ reference

◆ reverse_iterator

◆ set_type

◆ size_type

◆ value_type

◆ vector_type

Constructor & Destructor Documentation

◆ SetVector() [1/2]

◆ SetVector() [2/2]

Member Function Documentation

◆ back()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ contains()

◆ count()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase()

◆ front()

◆ getArrayRef()

◆ insert() [1/2]

◆ insert() [2/2]

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ pop_back()

◆ pop_back_val()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ remove()

◆ remove_if()

◆ rend() [1/2]

◆ rend() [2/2]

◆ set_subtract()

◆ set_union()

◆ size()

◆ swap()

◆ takeVector()

template<typename T, typename Vector = std::vector<T>, typename Set = DenseSet<T>>
class llvm::SetVector< T, Vector, Set >