LLVM  16.0.0git
Classes | Public Types | Public Member Functions | List of all members
llvm::SmallBitVector Class Reference

This is a 'bitvector' (really, a variable-sized bit array), optimized for the case when the array is small. More...

#include "llvm/ADT/SmallBitVector.h"

Classes

class  reference
 

Public Types

using size_type = uintptr_t
 
using const_set_bits_iterator = const_set_bits_iterator_impl< SmallBitVector >
 
using set_iterator = const_set_bits_iterator
 

Public Member Functions

 SmallBitVector ()=default
 Creates an empty bitvector. More...
 
 SmallBitVector (unsigned s, bool t=false)
 Creates a bitvector of specified number of bits. More...
 
 SmallBitVector (const SmallBitVector &RHS)
 SmallBitVector copy ctor. More...
 
 SmallBitVector (SmallBitVector &&RHS)
 
 ~SmallBitVector ()
 
const_set_bits_iterator set_bits_begin () const
 
const_set_bits_iterator set_bits_end () const
 
iterator_range< const_set_bits_iteratorset_bits () const
 
bool isSmall () const
 
bool empty () const
 Tests whether there are no bits in this bitvector. More...
 
size_type size () const
 Returns the number of bits in this bitvector. More...
 
size_type count () const
 Returns the number of bits which are set. More...
 
bool any () const
 Returns true if any bit is set. More...
 
bool all () const
 Returns true if all bits are set. More...
 
bool none () const
 Returns true if none of the bits are set. More...
 
int find_first () const
 Returns the index of the first set bit, -1 if none of the bits are set. More...
 
int find_last () const
 
int find_first_unset () const
 Returns the index of the first unset bit, -1 if all of the bits are set. More...
 
int find_last_unset () const
 
int find_next (unsigned Prev) const
 Returns the index of the next set bit following the "Prev" bit. More...
 
int find_next_unset (unsigned Prev) const
 Returns the index of the next unset bit following the "Prev" bit. More...
 
int find_prev (unsigned PriorTo) const
 find_prev - Returns the index of the first set bit that precedes the the bit at PriorTo. More...
 
void clear ()
 Clear all bits. More...
 
void resize (unsigned N, bool t=false)
 Grow or shrink the bitvector. More...
 
void reserve (unsigned N)
 
SmallBitVectorset ()
 
SmallBitVectorset (unsigned Idx)
 
SmallBitVectorset (unsigned I, unsigned E)
 Efficiently set a range of bits in [I, E) More...
 
SmallBitVectorreset ()
 
SmallBitVectorreset (unsigned Idx)
 
SmallBitVectorreset (unsigned I, unsigned E)
 Efficiently reset a range of bits in [I, E) More...
 
SmallBitVectorflip ()
 
SmallBitVectorflip (unsigned Idx)
 
SmallBitVector operator~ () const
 
reference operator[] (unsigned Idx)
 
bool operator[] (unsigned Idx) const
 
bool back () const
 Return the last element in the vector. More...
 
bool test (unsigned Idx) const
 
void push_back (bool Val)
 
void pop_back ()
 Pop one bit from the end of the vector. More...
 
bool anyCommon (const SmallBitVector &RHS) const
 Test if any common bits are set. More...
 
bool operator== (const SmallBitVector &RHS) const
 
bool operator!= (const SmallBitVector &RHS) const
 
SmallBitVectoroperator&= (const SmallBitVector &RHS)
 
SmallBitVectorreset (const SmallBitVector &RHS)
 Reset bits that are set in RHS. Same as *this &= ~RHS. More...
 
bool test (const SmallBitVector &RHS) const
 Check if (This - RHS) is zero. This is the same as reset(RHS) and any(). More...
 
SmallBitVectoroperator|= (const SmallBitVector &RHS)
 
SmallBitVectoroperator^= (const SmallBitVector &RHS)
 
SmallBitVectoroperator<<= (unsigned N)
 
SmallBitVectoroperator>>= (unsigned N)
 
const SmallBitVectoroperator= (const SmallBitVector &RHS)
 
const SmallBitVectoroperator= (SmallBitVector &&RHS)
 
void swap (SmallBitVector &RHS)
 
void setBitsInMask (const uint32_t *Mask, unsigned MaskWords=~0u)
 Add '1' bits from Mask to this vector. More...
 
void clearBitsInMask (const uint32_t *Mask, unsigned MaskWords=~0u)
 Clear any bits in this vector that are set in Mask. More...
 
void setBitsNotInMask (const uint32_t *Mask, unsigned MaskWords=~0u)
 Add a bit to this vector for every '0' bit in Mask. More...
 
void clearBitsNotInMask (const uint32_t *Mask, unsigned MaskWords=~0u)
 Clear a bit in this vector for every '0' bit in Mask. More...
 
void invalid ()
 
bool isInvalid () const
 
ArrayRef< uintptr_t > getData (uintptr_t &Store) const
 

Detailed Description

This is a 'bitvector' (really, a variable-sized bit array), optimized for the case when the array is small.

It contains one pointer-sized field, which is directly used as a plain collection of bits when possible, or as a pointer to a larger heap-allocated array when necessary. This allows normal "small" cases to be fast without losing generality for large inputs.

Definition at line 35 of file SmallBitVector.h.

Member Typedef Documentation

◆ const_set_bits_iterator

Definition at line 172 of file SmallBitVector.h.

◆ set_iterator

Definition at line 173 of file SmallBitVector.h.

◆ size_type

Definition at line 64 of file SmallBitVector.h.

Constructor & Destructor Documentation

◆ SmallBitVector() [1/4]

llvm::SmallBitVector::SmallBitVector ( )
default

Creates an empty bitvector.

Referenced by operator~().

◆ SmallBitVector() [2/4]

llvm::SmallBitVector::SmallBitVector ( unsigned  s,
bool  t = false 
)
inlineexplicit

Creates a bitvector of specified number of bits.

All bits are initialized to the specified value.

Definition at line 148 of file SmallBitVector.h.

References s.

◆ SmallBitVector() [3/4]

llvm::SmallBitVector::SmallBitVector ( const SmallBitVector RHS)
inline

SmallBitVector copy ctor.

Definition at line 156 of file SmallBitVector.h.

References RHS, and X.

◆ SmallBitVector() [4/4]

llvm::SmallBitVector::SmallBitVector ( SmallBitVector &&  RHS)
inline

Definition at line 163 of file SmallBitVector.h.

References RHS, and X.

◆ ~SmallBitVector()

llvm::SmallBitVector::~SmallBitVector ( )
inline

Definition at line 167 of file SmallBitVector.h.

References isSmall().

Member Function Documentation

◆ all()

bool llvm::SmallBitVector::all ( ) const
inline

◆ any()

bool llvm::SmallBitVector::any ( ) const
inline

Returns true if any bit is set.

Definition at line 209 of file SmallBitVector.h.

References llvm::BitVector::any(), and isSmall().

Referenced by llvm::DependenceInfo::depends(), and llvm::DependenceInfo::getSplitIteration().

◆ anyCommon()

bool llvm::SmallBitVector::anyCommon ( const SmallBitVector RHS) const
inline

Test if any common bits are set.

Definition at line 488 of file SmallBitVector.h.

References llvm::BitVector::anyCommon(), llvm::numbers::e, i, isSmall(), llvm::min(), RHS, size(), and test().

◆ back()

bool llvm::SmallBitVector::back ( ) const
inline

Return the last element in the vector.

Definition at line 467 of file SmallBitVector.h.

References assert(), empty(), and size().

◆ clear()

void llvm::SmallBitVector::clear ( )
inline

◆ clearBitsInMask()

void llvm::SmallBitVector::clearBitsInMask ( const uint32_t Mask,
unsigned  MaskWords = ~0u 
)
inline

Clear any bits in this vector that are set in Mask.

Don't resize. This computes "*this &= ~Mask".

Definition at line 655 of file SmallBitVector.h.

References llvm::BitVector::clearBitsInMask(), isSmall(), and llvm::BitmaskEnumDetail::Mask().

◆ clearBitsNotInMask()

void llvm::SmallBitVector::clearBitsNotInMask ( const uint32_t Mask,
unsigned  MaskWords = ~0u 
)
inline

Clear a bit in this vector for every '0' bit in Mask.

Don't resize. This computes "*this &= Mask".

Definition at line 673 of file SmallBitVector.h.

References llvm::BitVector::clearBitsNotInMask(), isSmall(), and llvm::BitmaskEnumDetail::Mask().

◆ count()

size_type llvm::SmallBitVector::count ( ) const
inline

◆ empty()

bool llvm::SmallBitVector::empty ( ) const
inline

Tests whether there are no bits in this bitvector.

Definition at line 190 of file SmallBitVector.h.

References llvm::BitVector::empty(), and isSmall().

Referenced by back(), invalid(), and pop_back().

◆ find_first()

int llvm::SmallBitVector::find_first ( ) const
inline

Returns the index of the first set bit, -1 if none of the bits are set.

Definition at line 230 of file SmallBitVector.h.

References llvm::tgtok::Bits, llvm::countTrailingZeros(), llvm::BitVector::find_first(), and isSmall().

Referenced by findMainViewFileID(), and fixupOrderingIndices().

◆ find_first_unset()

int llvm::SmallBitVector::find_first_unset ( ) const
inline

Returns the index of the first unset bit, -1 if all of the bits are set.

Definition at line 251 of file SmallBitVector.h.

References llvm::tgtok::Bits, count(), llvm::countTrailingOnes(), llvm::BitVector::find_first_unset(), and isSmall().

◆ find_last()

int llvm::SmallBitVector::find_last ( ) const
inline

◆ find_last_unset()

int llvm::SmallBitVector::find_last_unset ( ) const
inline

◆ find_next()

int llvm::SmallBitVector::find_next ( unsigned  Prev) const
inline

Returns the index of the next set bit following the "Prev" bit.

Returns -1 if the next set bit is not found.

Definition at line 277 of file SmallBitVector.h.

References llvm::tgtok::Bits, llvm::countTrailingZeros(), llvm::BitVector::find_next(), and isSmall().

Referenced by dumpSmallBitVector(), and fixupOrderingIndices().

◆ find_next_unset()

int llvm::SmallBitVector::find_next_unset ( unsigned  Prev) const
inline

Returns the index of the next unset bit following the "Prev" bit.

Returns -1 if the next unset bit is not found.

Definition at line 291 of file SmallBitVector.h.

References llvm::tgtok::Bits, llvm::countTrailingOnes(), llvm::BitVector::find_next_unset(), and isSmall().

◆ find_prev()

int llvm::SmallBitVector::find_prev ( unsigned  PriorTo) const
inline

find_prev - Returns the index of the first set bit that precedes the the bit at PriorTo.

Returns -1 if all previous bits are unset.

Definition at line 308 of file SmallBitVector.h.

References llvm::tgtok::Bits, llvm::countLeadingZeros(), llvm::BitVector::find_prev(), and isSmall().

◆ flip() [1/2]

SmallBitVector& llvm::SmallBitVector::flip ( )
inline

Definition at line 432 of file SmallBitVector.h.

References llvm::BitVector::flip(), and isSmall().

◆ flip() [2/2]

SmallBitVector& llvm::SmallBitVector::flip ( unsigned  Idx)
inline

Definition at line 440 of file SmallBitVector.h.

References llvm::BitVector::flip(), and isSmall().

◆ getData()

ArrayRef<uintptr_t> llvm::SmallBitVector::getData ( uintptr_t &  Store) const
inline

◆ invalid()

void llvm::SmallBitVector::invalid ( )
inline

Definition at line 680 of file SmallBitVector.h.

References assert(), empty(), and X.

Referenced by llvm::DenseMapInfo< SmallBitVector >::getTombstoneKey().

◆ isInvalid()

bool llvm::SmallBitVector::isInvalid ( ) const
inline

Definition at line 684 of file SmallBitVector.h.

References X.

◆ isSmall()

bool llvm::SmallBitVector::isSmall ( ) const
inline

◆ none()

bool llvm::SmallBitVector::none ( ) const
inline

Returns true if none of the bits are set.

Definition at line 223 of file SmallBitVector.h.

References isSmall(), and llvm::BitVector::none().

Referenced by fixupOrderingIndices().

◆ operator!=()

bool llvm::SmallBitVector::operator!= ( const SmallBitVector RHS) const
inline

Definition at line 517 of file SmallBitVector.h.

References RHS.

◆ operator&=()

SmallBitVector& llvm::SmallBitVector::operator&= ( const SmallBitVector RHS)
inline

Definition at line 523 of file SmallBitVector.h.

References E, I, isSmall(), llvm::max(), llvm::min(), reset(), resize(), RHS, size(), and test().

◆ operator<<=()

SmallBitVector& llvm::SmallBitVector::operator<<= ( unsigned  N)
inline

Definition at line 598 of file SmallBitVector.h.

References isSmall(), and N.

◆ operator=() [1/2]

const SmallBitVector& llvm::SmallBitVector::operator= ( const SmallBitVector RHS)
inline

Definition at line 615 of file SmallBitVector.h.

References isSmall(), RHS, and X.

◆ operator=() [2/2]

const SmallBitVector& llvm::SmallBitVector::operator= ( SmallBitVector &&  RHS)
inline

Definition at line 632 of file SmallBitVector.h.

References clear(), RHS, and swap().

◆ operator==()

bool llvm::SmallBitVector::operator== ( const SmallBitVector RHS) const
inline

Definition at line 501 of file SmallBitVector.h.

References E, I, isSmall(), RHS, and size().

◆ operator>>=()

SmallBitVector& llvm::SmallBitVector::operator>>= ( unsigned  N)
inline

Definition at line 606 of file SmallBitVector.h.

References isSmall(), and N.

◆ operator[]() [1/2]

reference llvm::SmallBitVector::operator[] ( unsigned  Idx)
inline

Definition at line 454 of file SmallBitVector.h.

References assert(), and size().

◆ operator[]() [2/2]

bool llvm::SmallBitVector::operator[] ( unsigned  Idx) const
inline

Definition at line 459 of file SmallBitVector.h.

References assert(), isSmall(), and size().

◆ operator^=()

SmallBitVector& llvm::SmallBitVector::operator^= ( const SmallBitVector RHS)
inline

Definition at line 585 of file SmallBitVector.h.

References E, I, isSmall(), llvm::max(), resize(), RHS, size(), and test().

◆ operator|=()

SmallBitVector& llvm::SmallBitVector::operator|= ( const SmallBitVector RHS)
inline

Definition at line 572 of file SmallBitVector.h.

References E, I, isSmall(), llvm::max(), resize(), RHS, size(), and test().

◆ operator~()

SmallBitVector llvm::SmallBitVector::operator~ ( ) const
inline

Definition at line 449 of file SmallBitVector.h.

References SmallBitVector().

◆ pop_back()

void llvm::SmallBitVector::pop_back ( )
inline

Pop one bit from the end of the vector.

Definition at line 482 of file SmallBitVector.h.

References assert(), empty(), resize(), and size().

◆ push_back()

void llvm::SmallBitVector::push_back ( bool  Val)
inline

Definition at line 477 of file SmallBitVector.h.

References resize(), and size().

◆ reserve()

void llvm::SmallBitVector::reserve ( unsigned  N)
inline

Definition at line 348 of file SmallBitVector.h.

References I, isSmall(), N, llvm::BitVector::reserve(), and llvm::BitVector::set().

◆ reset() [1/4]

SmallBitVector& llvm::SmallBitVector::reset ( )
inline

◆ reset() [2/4]

SmallBitVector& llvm::SmallBitVector::reset ( const SmallBitVector RHS)
inline

Reset bits that are set in RHS. Same as *this &= ~RHS.

Definition at line 540 of file SmallBitVector.h.

References llvm::numbers::e, i, isSmall(), llvm::min(), llvm::BitVector::reset(), reset(), RHS, and size().

◆ reset() [3/4]

SmallBitVector& llvm::SmallBitVector::reset ( unsigned  I,
unsigned  E 
)
inline

Efficiently reset a range of bits in [I, E)

Definition at line 418 of file SmallBitVector.h.

References assert(), E, I, isSmall(), llvm::BitmaskEnumDetail::Mask(), llvm::BitVector::reset(), and size().

◆ reset() [4/4]

SmallBitVector& llvm::SmallBitVector::reset ( unsigned  Idx)
inline

Definition at line 409 of file SmallBitVector.h.

References isSmall(), and llvm::BitVector::reset().

◆ resize()

void llvm::SmallBitVector::resize ( unsigned  N,
bool  t = false 
)
inline

◆ set() [1/3]

SmallBitVector& llvm::SmallBitVector::set ( )
inline

◆ set() [2/3]

SmallBitVector& llvm::SmallBitVector::set ( unsigned  I,
unsigned  E 
)
inline

Efficiently set a range of bits in [I, E)

Definition at line 387 of file SmallBitVector.h.

References assert(), E, I, isSmall(), llvm::BitmaskEnumDetail::Mask(), llvm::BitVector::set(), and size().

◆ set() [3/3]

SmallBitVector& llvm::SmallBitVector::set ( unsigned  Idx)
inline

Definition at line 374 of file SmallBitVector.h.

References assert(), isSmall(), and llvm::BitVector::set().

◆ set_bits()

iterator_range<const_set_bits_iterator> llvm::SmallBitVector::set_bits ( ) const
inline

◆ set_bits_begin()

const_set_bits_iterator llvm::SmallBitVector::set_bits_begin ( ) const
inline

Definition at line 175 of file SmallBitVector.h.

Referenced by set_bits().

◆ set_bits_end()

const_set_bits_iterator llvm::SmallBitVector::set_bits_end ( ) const
inline

Definition at line 179 of file SmallBitVector.h.

Referenced by set_bits().

◆ setBitsInMask()

void llvm::SmallBitVector::setBitsInMask ( const uint32_t Mask,
unsigned  MaskWords = ~0u 
)
inline

Add '1' bits from Mask to this vector.

Don't resize. This computes "*this |= Mask".

Definition at line 646 of file SmallBitVector.h.

References isSmall(), llvm::BitmaskEnumDetail::Mask(), and llvm::BitVector::setBitsInMask().

◆ setBitsNotInMask()

void llvm::SmallBitVector::setBitsNotInMask ( const uint32_t Mask,
unsigned  MaskWords = ~0u 
)
inline

Add a bit to this vector for every '0' bit in Mask.

Don't resize. This computes "*this |= ~Mask".

Definition at line 664 of file SmallBitVector.h.

References isSmall(), llvm::BitmaskEnumDetail::Mask(), and llvm::BitVector::setBitsNotInMask().

◆ size()

size_type llvm::SmallBitVector::size ( ) const
inline

◆ swap()

void llvm::SmallBitVector::swap ( SmallBitVector RHS)
inline

Definition at line 640 of file SmallBitVector.h.

References RHS, std::swap(), and X.

Referenced by operator=().

◆ test() [1/2]

bool llvm::SmallBitVector::test ( const SmallBitVector RHS) const
inline

Check if (This - RHS) is zero. This is the same as reset(RHS) and any().

Definition at line 554 of file SmallBitVector.h.

References llvm::numbers::e, i, isSmall(), llvm::min(), RHS, size(), llvm::BitVector::test(), and test().

◆ test() [2/2]

bool llvm::SmallBitVector::test ( unsigned  Idx) const
inline

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