EasyNav Plugins
Loading...
Searching...
No Matches
Mask Class Reference

#include <mask.hpp>

Classes

class  Iterator

Public Member Functions

Iterator beginOn () const
uint32_t bitCount () const
 Return the number of bits available in this Mask.
uint32_t countOn () const
uint32_t findFirstOn () const
uint64_t getWord (size_t n) const
bool isOff () const
bool isOn () const
 Return true if any bit is set.
bool isOn (uint32_t n) const
 Return true if the given bit is set.
 Mask (const Mask &other)
 Mask (Mask &&other)
 Mask (size_t log2dim)
 Initialize all bits to zero.
 Mask (size_t log2dim, bool on)
 Initialize all bits to a given value.
size_t memUsage () const
 Return the memory footprint in bytes of this Mask.
bool operator!= (const Mask &other) const
bool operator== (const Mask &other) const
void set (bool on)
 Set all bits to the value "on".
void set (uint32_t n, bool On)
void setOff ()
 Set all bits off.
bool setOff (uint32_t n)
void setOn ()
 Set all bits on.
bool setOn (uint32_t n)
void setWord (size_t n, uint64_t v)
uint32_t size () const
void toggle ()
 Toggle the state of all bits in the mask.
void toggle (uint32_t n)
 Toggle the state of one bit in the mask.
uint32_t wordCount () const
 Return the number of machine words used by this Mask.
 ~Mask ()

Constructor & Destructor Documentation

◆ Mask() [1/4]

Mask ( size_t log2dim)

Initialize all bits to zero.

◆ Mask() [2/4]

Mask ( size_t log2dim,
bool on )

Initialize all bits to a given value.

◆ Mask() [3/4]

Mask ( const Mask & other)

◆ Mask() [4/4]

Mask ( Mask && other)

◆ ~Mask()

~Mask ( )

Member Function Documentation

◆ beginOn()

Iterator beginOn ( ) const

◆ bitCount()

uint32_t bitCount ( ) const

Return the number of bits available in this Mask.

◆ countOn()

uint32_t countOn ( ) const

◆ findFirstOn()

uint32_t findFirstOn ( ) const

◆ getWord()

uint64_t getWord ( size_t n) const

◆ isOff()

bool isOff ( ) const

◆ isOn() [1/2]

bool isOn ( ) const

Return true if any bit is set.

◆ isOn() [2/2]

bool isOn ( uint32_t n) const

Return true if the given bit is set.

◆ memUsage()

size_t memUsage ( ) const

Return the memory footprint in bytes of this Mask.

◆ operator!=()

bool operator!= ( const Mask & other) const

◆ operator==()

bool operator== ( const Mask & other) const

◆ set() [1/2]

void set ( bool on)

Set all bits to the value "on".

◆ set() [2/2]

void set ( uint32_t n,
bool On )

◆ setOff() [1/2]

void setOff ( )

Set all bits off.

◆ setOff() [2/2]

bool setOff ( uint32_t n)

◆ setOn() [1/2]

void setOn ( )

Set all bits on.

◆ setOn() [2/2]

bool setOn ( uint32_t n)

◆ setWord()

void setWord ( size_t n,
uint64_t v )

◆ size()

uint32_t size ( ) const

◆ toggle() [1/2]

void toggle ( )

Toggle the state of all bits in the mask.

◆ toggle() [2/2]

void toggle ( uint32_t n)

Toggle the state of one bit in the mask.

◆ wordCount()

uint32_t wordCount ( ) const

Return the number of machine words used by this Mask.


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