SVF::CoreBitVector::CoreBitVectorIterator Class Reference

#include <CoreBitVector.h>

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = u32_t
using	difference_type = std::ptrdiff_t
using	pointer = u32_t *
using	reference = u32_t &

Public Member Functions
	CoreBitVectorIterator (void)=delete
	CoreBitVectorIterator (const CoreBitVector *cbv, bool end=false)
	CoreBitVectorIterator (const CoreBitVectorIterator &cbv)=default
	CoreBitVectorIterator (CoreBitVectorIterator &&cbv)=default
CoreBitVectorIterator &	operator= (const CoreBitVectorIterator &cbv)=default
CoreBitVectorIterator &	operator= (CoreBitVectorIterator &&cbv)=default
const CoreBitVectorIterator &	operator++ (void)
	Pre-increment: ++it.
const CoreBitVectorIterator	operator++ (int)
	Post-increment: it++.
u32_t	operator* (void) const
	Dereference: *it.
bool	operator== (const CoreBitVectorIterator &rhs) const
	Equality: *this == rhs.
bool	operator!= (const CoreBitVectorIterator &rhs) const
	Inequality: *this != rhs.

Private Member Functions
bool	atEnd (void) const

Private Attributes
const CoreBitVector *	cbv
	CoreBitVector we are iterating over.
std::vector< Word >::const_iterator	wordIt
	Word in words we are looking at.
u32_t	bit

Detailed Description

Definition at line 147 of file CoreBitVector.h.

Member Typedef Documentation

difference_type

using SVF::CoreBitVector::CoreBitVectorIterator::difference_type = std::ptrdiff_t

Definition at line 152 of file CoreBitVector.h.

iterator_category

using SVF::CoreBitVector::CoreBitVectorIterator::iterator_category = std::forward_iterator_tag

Definition at line 150 of file CoreBitVector.h.

pointer

using SVF::CoreBitVector::CoreBitVectorIterator::pointer = u32_t *

Definition at line 153 of file CoreBitVector.h.

reference

using SVF::CoreBitVector::CoreBitVectorIterator::reference = u32_t &

Definition at line 154 of file CoreBitVector.h.

value_type

using SVF::CoreBitVector::CoreBitVectorIterator::value_type = u32_t

Definition at line 151 of file CoreBitVector.h.

Constructor & Destructor Documentation

CoreBitVectorIterator() [1/4]

SVF::CoreBitVector::CoreBitVectorIterator::CoreBitVectorIterator ( void  )

delete

CoreBitVectorIterator() [2/4]

SVF::CoreBitVector::CoreBitVectorIterator::CoreBitVectorIterator	(	const CoreBitVector *	cbv,
		bool	end = false
	)

Returns an iterator to the beginning of cbv if end is false, and to the end of cbv if end is true.

Definition at line 387 of file CoreBitVector.cpp.

    : cbv(cbv), bit(0)
{
    wordIt = end ? cbv->words.end() : cbv->words.begin();
    // If user didn't request an end iterator, or words is non-empty,
    // from 0, go to the next bit. But if the 0 bit is set, we don't
    // need to because that is the first element.
    if (wordIt != cbv->words.end() && !(cbv->words[0] & (Word)0b1)) ++(*this);
}

CoreBitVectorIterator() [3/4]

SVF::CoreBitVector::CoreBitVectorIterator::CoreBitVectorIterator ( const CoreBitVectorIterator &  cbv )

default

CoreBitVectorIterator() [4/4]

SVF::CoreBitVector::CoreBitVectorIterator::CoreBitVectorIterator ( CoreBitVectorIterator &&  cbv )

default

Member Function Documentation

atEnd()

bool SVF::CoreBitVector::CoreBitVectorIterator::atEnd ( void  ) const

private

Definition at line 452 of file CoreBitVector.cpp.

{
    return wordIt == cbv->words.end();
}

operator!=()

bool SVF::CoreBitVector::CoreBitVectorIterator::operator!=

(

const CoreBitVectorIterator &

rhs

)

const

Inequality: *this != rhs.

Definition at line 446 of file CoreBitVector.cpp.

{
    assert(cbv == rhs.cbv && "CoreBitVectorIterator::!=: comparing iterators from different CBVs");
    return !(*this == rhs);
}

operator*()

u32_t SVF::CoreBitVector::CoreBitVectorIterator::operator*

(

void

)

const

Dereference: *it.

Definition at line 427 of file CoreBitVector.cpp.

{
    assert(!atEnd() && "CoreBitVectorIterator::*: dereferencing end!");
    size_t wordsIndex = wordIt - cbv->words.begin();
    // Add where the bit vector starts (offset), with the number of bits
    // in the passed words (the index encodes how many we have completely
    // passed since it is position - 1) and the bit we are up to for the
    // current word (i.e., in the n+1th)
    return cbv->offset + wordsIndex * WordSize + bit;
}

operator++() [1/2]

const CoreBitVector::CoreBitVectorIterator SVF::CoreBitVector::CoreBitVectorIterator::operator++

(

int

)

Post-increment: it++.

Definition at line 419 of file CoreBitVector.cpp.

{
    assert(!atEnd() && "CoreBitVectorIterator::++(pre): incrementing past end!");
    CoreBitVectorIterator old = *this;
    ++*this;
    return old;
}

operator++() [2/2]

const CoreBitVector::CoreBitVectorIterator & SVF::CoreBitVector::CoreBitVectorIterator::operator++

(

void

)

Pre-increment: ++it.

Definition at line 397 of file CoreBitVector.cpp.

{
    assert(!atEnd() && "CoreBitVectorIterator::++(pre): incrementing past end!");
 
    ++bit;
    // Check if no more bits in wordIt. Find word with a bit set.
    if (bit == WordSize || (*wordIt >> bit) == 0)
    {
        bit = 0;
        ++wordIt;
        while (wordIt != cbv->words.end() && *wordIt == 0) ++wordIt;
    }
 
    // Find set bit if we're not at the end.
    if (wordIt != cbv->words.end())
    {
        while (bit != WordSize && (*wordIt & ((Word)0b1 << bit)) == 0) ++bit;
    }
 
    return *this;
}

operator=() [1/2]

CoreBitVectorIterator & SVF::CoreBitVector::CoreBitVectorIterator::operator= ( const CoreBitVectorIterator &  cbv )

default

operator=() [2/2]

CoreBitVectorIterator & SVF::CoreBitVector::CoreBitVectorIterator::operator= ( CoreBitVectorIterator &&  cbv )

default

operator==()

bool SVF::CoreBitVector::CoreBitVectorIterator::operator==

(

const CoreBitVectorIterator &

rhs

)

const

Equality: *this == rhs.

Definition at line 438 of file CoreBitVector.cpp.

{
    assert(cbv == rhs.cbv && "CoreBitVectorIterator::==: comparing iterators from different CBVs");
    // When we're at the end we don't care about bit.
    if (wordIt == cbv->words.end()) return rhs.wordIt == cbv->words.end();
    return wordIt == rhs.wordIt && bit == rhs.bit;
}

Member Data Documentation

bit

u32_t SVF::CoreBitVector::CoreBitVectorIterator::bit

private

Current bit in wordIt we are looking at (index into *wordIt).

Definition at line 193 of file CoreBitVector.h.

cbv

const CoreBitVector* SVF::CoreBitVector::CoreBitVectorIterator::cbv

private

CoreBitVector we are iterating over.

Definition at line 188 of file CoreBitVector.h.

wordIt

std::vector<Word>::const_iterator SVF::CoreBitVector::CoreBitVectorIterator::wordIt

private

Word in words we are looking at.

Definition at line 190 of file CoreBitVector.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/CoreBitVector.h
• /home/runner/work/SVF/SVF/svf/lib/Util/CoreBitVector.cpp