MR::BitSet Class Reference

#include <MRBitSet.h>

Inheritance diagram for MR::BitSet:

Public Types
using	base = boost::dynamic_bitset<std::uint64_t>
using	IndexType = size_t

Public Member Functions
	BitSet (size_t numBits, bool fillValue)
	creates bitset of given size filled with given value
	BitSet (size_t, unsigned long)=delete
	prohibit these constructors inherited from boost::dynamic_bitset, which can initialize only few initial bits
template<class T , std::enable_if_t< std::is_arithmetic< T >::value, std::nullptr_t > = nullptr>
	BitSet (T, T)=delete
bool	test (IndexType n) const
bool	test_set (IndexType n, bool val=true)
BitSet &	set (IndexType n, size_type len, bool val)
BitSet &	set (IndexType n, bool val)
BitSet &	set (IndexType n)
BitSet &	set ()
BitSet &	reset (IndexType n, size_type len)
BitSet &	reset (IndexType n)
BitSet &	reset ()
BitSet &	flip (IndexType n, size_type len)
BitSet &	flip (IndexType n)
BitSet &	flip ()
const auto &	bits () const
	read-only access to all bits stored as a vector of uint64 blocks
MRMESH_API BitSet &	operator&= (const BitSet &b)
MRMESH_API BitSet &	operator|= (const BitSet &b)
MRMESH_API BitSet &	operator^= (const BitSet &b)
MRMESH_API BitSet &	operator-= (const BitSet &b)
MRMESH_API BitSet &	subtract (const BitSet &b, int bShiftInBlocks)
	subtracts b from this, considering that bits in b are shifted right on bShiftInBlocks*bits_per_block
MRMESH_API IndexType	find_last () const
	return the highest index i such as bit i is set, or npos if *this has no on bits.
MRMESH_API size_t	nthSetBit (size_t n) const
	returns the location of nth set bit (where the first bit corresponds to n=0) or npos if there are less bit set
MRMESH_API bool	is_subset_of (const BitSet &a) const
	returns true if, for every bit that is set in this bitset, the corresponding bit in bitset a is also set. Otherwise this function returns false.
bool	is_proper_subset_of (const BitSet &a) const =delete
	returns true if, for every bit that is set in this bitset, the corresponding bit in bitset a is also set and if this->count() < a.count(). Otherwise this function returns false.
void	resizeWithReserve (size_t newSize)
	doubles reserved memory until resize(newSize) can be done without reallocation
void	autoResizeSet (size_t pos, size_type len, bool val=true)
	sets elements [pos, pos+len) to given value, adjusting the size of the set to include new elements
void	autoResizeSet (size_t pos, bool val=true)
bool	autoResizeTestSet (size_t pos, bool val=true)
	same as autoResizeSet and returns previous value of pos-bit
size_t	heapBytes () const
	returns the amount of memory this object occupies on heap
IndexType	backId () const
	returns the identifier of the back() element
IndexType	endId () const

Static Public Member Functions
static IndexType	beginId ()
	[beginId(), endId()) is the range of all bits in the set

Detailed Description

std::vector<bool> like container (random-access, size_t - index type, bool - value type) with all bits after size() considered off during testing

Member Typedef Documentation

base

using MR::BitSet::base = boost::dynamic_bitset<std::uint64_t>

IndexType

using MR::BitSet::IndexType = size_t

Constructor & Destructor Documentation

BitSet() [1/3]

MR::BitSet::BitSet ( size_t numBits, bool fillValue )

inlineexplicit

creates bitset of given size filled with given value

BitSet() [2/3]

MR::BitSet::BitSet ( size_t , unsigned long  )

explicitdelete

prohibit these constructors inherited from boost::dynamic_bitset, which can initialize only few initial bits

BitSet() [3/3]

template<class T , std::enable_if_t< std::is_arithmetic< T >::value, std::nullptr_t > = nullptr>

MR::BitSet::BitSet ( T , T  )

explicitdelete

Member Function Documentation

autoResizeSet() [1/2]

void MR::BitSet::autoResizeSet ( size_t pos, bool val = true )

inline

autoResizeSet() [2/2]

void MR::BitSet::autoResizeSet ( size_t pos, size_type len, bool val = true )

inline

sets elements [pos, pos+len) to given value, adjusting the size of the set to include new elements

autoResizeTestSet()

bool MR::BitSet::autoResizeTestSet ( size_t pos, bool val = true )

inlinenodiscard

same as autoResizeSet and returns previous value of pos-bit

backId()

IndexType MR::BitSet::backId ( ) const

inlinenodiscard

returns the identifier of the back() element

beginId()

static IndexType MR::BitSet::beginId ( )

inlinestaticnodiscard

[beginId(), endId()) is the range of all bits in the set

bits()

const auto & MR::BitSet::bits ( ) const

inline

read-only access to all bits stored as a vector of uint64 blocks

endId()

IndexType MR::BitSet::endId ( ) const

inlinenodiscard

find_last()

MRMESH_API IndexType MR::BitSet::find_last ( ) const

nodiscard

return the highest index i such as bit i is set, or npos if *this has no on bits.

flip() [1/3]

BitSet & MR::BitSet::flip ( )

inline

flip() [2/3]

BitSet & MR::BitSet::flip ( IndexType n )

inline

flip() [3/3]

BitSet & MR::BitSet::flip ( IndexType n, size_type len )

inline

heapBytes()

size_t MR::BitSet::heapBytes ( ) const

inlinenodiscard

returns the amount of memory this object occupies on heap

is_proper_subset_of()

bool MR::BitSet::is_proper_subset_of ( const BitSet & a ) const

delete

returns true if, for every bit that is set in this bitset, the corresponding bit in bitset a is also set and if this->count() < a.count(). Otherwise this function returns false.

is_subset_of()

MRMESH_API bool MR::BitSet::is_subset_of ( const BitSet & a ) const

nodiscard

returns true if, for every bit that is set in this bitset, the corresponding bit in bitset a is also set. Otherwise this function returns false.

nthSetBit()

MRMESH_API size_t MR::BitSet::nthSetBit ( size_t n ) const

nodiscard

returns the location of nth set bit (where the first bit corresponds to n=0) or npos if there are less bit set

operator&=()

MRMESH_API BitSet & MR::BitSet::operator&=

(

const BitSet &

b

)

operator-=()

MRMESH_API BitSet & MR::BitSet::operator-=

(

const BitSet &

b

)

operator^=()

MRMESH_API BitSet & MR::BitSet::operator^=

(

const BitSet &

b

)

operator|=()

MRMESH_API BitSet & MR::BitSet::operator|=

(

const BitSet &

b

)

reset() [1/3]

BitSet & MR::BitSet::reset ( )

inline

reset() [2/3]

BitSet & MR::BitSet::reset ( IndexType n )

inline

reset() [3/3]

BitSet & MR::BitSet::reset ( IndexType n, size_type len )

inline

resizeWithReserve()

void MR::BitSet::resizeWithReserve ( size_t newSize )

inline

doubles reserved memory until resize(newSize) can be done without reallocation

set() [1/4]

BitSet & MR::BitSet::set ( )

inline

set() [2/4]

BitSet & MR::BitSet::set ( IndexType n )

inline

set() [3/4]

BitSet & MR::BitSet::set ( IndexType n, bool val )

inline

set() [4/4]

BitSet & MR::BitSet::set ( IndexType n, size_type len, bool val )

inline

subtract()

MRMESH_API BitSet & MR::BitSet::subtract	(	const BitSet &	b,
		int	bShiftInBlocks )

subtracts b from this, considering that bits in b are shifted right on bShiftInBlocks*bits_per_block

test()

bool MR::BitSet::test ( IndexType n ) const

inlinenodiscard

test_set()

bool MR::BitSet::test_set ( IndexType n, bool val = true )

inlinenodiscard

---

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

• MRMesh/MRBitSet.h