Represents a bitset with dynamically allocated memory (using an mtcore allocator) Allows operating on an arbitrary number of bits. More...

#include <bitset.hpp>

Collaboration diagram for mtcore::Bitset2D:

[legend]

Classes
struct	BitsetAccess
	Helper for accessing a bitset position (including for setting bits) More...

struct	SetBitIter
	Simple bit set iterator that uses next() iteration to return the indices of all set bits. More...

Public Member Functions
Result< void, AllocationError >	init (mtcore::Allocator &allocator, const size_t height, const size_t width)
	Initializes a bitset to have a total number of bits All bits will be set to zero.

Result< void, BitStrInitError >	init (mtcore::Allocator &allocator, const Slice< const Slice< const char > > binaryStr)
	Initializes a bitset from a binary string of 1's and 0's.

Result< void, BitStrInitError >	init (mtcore::Allocator &allocator, const Slice< Slice< const char > > binaryStr)
	Initializes a bitset from a binary string of 1's and 0's.

Result< void, BitStrInitError >	init (mtcore::Allocator &allocator, const size_t height, const size_t width, const Slice< Slice< const char > > binaryStr)
	Initializes a bitset of a given size from a string Any bits not set by the string will be zero.

Result< void, BitStrInitError >	init (mtcore::Allocator &allocator, const size_t height, const size_t width, const Slice< const Slice< const char > > binaryStr)
	Initializes a bitset of a given size from a string Any bits not set by the string will be zero.

void	deinit (mtcore::Allocator &allocator)
	Deinitialies a bitset.

bool	operator[] (std::tuple< size_t, size_t > index) const
	Access an individual bit at a specific position.

BitsetAccess	operator[] (std::tuple< size_t, size_t > index)
	Access an individual bit at a specific position.

std::tuple< size_t, size_t >	size () const
	Gets the size of the bitset.

bool	at (size_t row, size_t col) const
	Reads a bit at a specific position.

Result< Bitset2D, AllocationError >	clone (mtcore::Allocator &allocator)
	Clones a bitset using a specific allocator.

Result< Bitset2D, AllocationError >	clone (mtcore::Allocator &allocator, const size_t newHeight, const size_t newWidth)
	Clones and resizes a bitset using a specific allocator.

Bitset2D &	set (size_t row, size_t col, bool val)
	Sets a bit at a position to a specific value.

Bitset2D &	toggle (size_t row, size_t col)
	Toggles a bit at a specific position.

Optional< std::tuple< size_t, size_t > >	first_set () const
	Returns the position of the first set bit (if one is set) Otherwise, returns a null Optional.

size_t	pop_count () const
	Counts the number of set bits in the bitset.

SetBitIter	set_bits () const
	Iterates over the indices of all set bits in the bitset.

Bitset2D &	operator&= (const Bitset2D &other)

Bitset2D &	operator\|= (const Bitset2D &other)

Bitset2D &	operator^= (const Bitset2D &other)

void	set_all (bool value)
	Sets all bits to a specific value.

Public Attributes
Bitset	underlying

size_t	width

size_t	height

Detailed Description

Represents a bitset with dynamically allocated memory (using an mtcore allocator) Allows operating on an arbitrary number of bits.

Definition at line 477 of file bitset.hpp.

Member Function Documentation

◆ at()

bool mtcore::Bitset2D::at	(	size_t	row,
		size_t	col ) const

inlinenodiscard

Reads a bit at a specific position.

Parameters

row	Bit row index to read
col	Bit col index to read

Returns: whether it is set or not

Definition at line 647 of file bitset.hpp.

                                                        {
      ensure(row < height, "OUT OF BOUNDS ACCESS, INVALID ROW");
      ensure(col < width, "OUT OF BOUNDS ACCESS, INVALID COL");
      const auto pos = row * width + col;
      return underlying.at(pos);
    }

Here is the caller graph for this function:

◆ clone() [1/2]

Result< Bitset2D, AllocationError > mtcore::Bitset2D::clone ( mtcore::Allocator & allocator )

inline

Clones a bitset using a specific allocator.

Parameters

allocator Allocator to use for cloning

Returns: Bitset on success, or error on failure

Definition at line 659 of file bitset.hpp.

                                                                        {
      auto copyRes = underlying.clone(allocator);
      if (copyRes.is_success()) {
        return copyRes.error();
      }
      auto cpy       = *this;
      cpy.underlying = *copyRes;
      return cpy;
    }

◆ clone() [2/2]

Result< Bitset2D, AllocationError > mtcore::Bitset2D::clone	(	mtcore::Allocator &	allocator,
		const size_t	newHeight,
		const size_t	newWidth )

inline

Clones and resizes a bitset using a specific allocator.

Parameters

allocator	Allocator to use for cloning
newHeight	New 2d array height
newWidth	New 2d array width

Returns: Bitset on success, or error on failure

Definition at line 676 of file bitset.hpp.

                                                                   {
      Bitset2D res;
      auto initRes = res.init(allocator, newHeight, newWidth);
      if (initRes.is_error()) {
        return initRes.error();
      }
      for (size_t row = 0; row < newHeight && row < height; ++row) {
        for (size_t col = 0; col < newWidth && col < width; ++col) {
          res[{row, col}] = at(row, col);
        }
      }
      return res;
    }

Here is the call graph for this function:

◆ deinit()

void mtcore::Bitset2D::deinit ( mtcore::Allocator & allocator )

inline

Deinitialies a bitset.

Parameters

allocator Allocator to use for deinitialization

Definition at line 589 of file bitset.hpp.

                                            {
      underlying.deinit(allocator);
      width  = 0;
      height = 0;
    }

◆ first_set()

Optional< std::tuple< size_t, size_t > > mtcore::Bitset2D::first_set ( ) const

inlinenodiscard

Returns the position of the first set bit (if one is set) Otherwise, returns a null Optional.

Returns: Optional with first set bit position

Definition at line 724 of file bitset.hpp.

                                                                       {
      auto index = underlying.first_set();
      if (index.empty()) {
        return nullopt;
      }
      size_t pos = *index;
      size_t row = pos / width;
      size_t col = pos % width;
      return std::tuple{row, col};
    }

◆ init() [1/5]

Result< void, AllocationError > mtcore::Bitset2D::init	(	mtcore::Allocator &	allocator,
		const size_t	height,
		const size_t	width )

inline

Initializes a bitset to have a total number of bits All bits will be set to zero.

Parameters

allocator	Allocator to use for memory allocation
height	2d array height
width	2d array width

Definition at line 489 of file bitset.hpp.

                                                                                                            {
      ensure(width, "INVALID WIDTH");
      ensure(height, "INVALID HEIGHT");
      auto baseRes = underlying.init(allocator, width * height);
      if (baseRes.is_error()) {
        return baseRes;
      }
 
      ensure(underlying.size() == width * height, "BAD UNDERLYING SIZE!");
      this->width  = width;
      this->height = height;
      return success();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init() [2/5]

Result< void, BitStrInitError > mtcore::Bitset2D::init	(	mtcore::Allocator &	allocator,
		const size_t	height,
		const size_t	width,
		const Slice< const Slice< const char > >	binaryStr )

inline

Initializes a bitset of a given size from a string Any bits not set by the string will be zero.

Parameters

allocator	Allocator to use for memory allocation
height	2D array height
width	2D array width
binaryStr	Binary string to use for initializing bits

Definition at line 547 of file bitset.hpp.

                                                                                       {
      {
        Slice<const char> curRow;
        auto rowIter = binaryStr.iter();
        while (rowIter.next().copy_if_present(curRow)) {
          char curCell  = '\0';
          auto cellIter = curRow.iter();
          while (cellIter.next().copy_if_present(curCell)) {
            if (curCell != '1' && curCell != '0') {
              return error(BitStrInitError::INVALID_BINARY_STRING);
            }
          }
        }
      }
 
      if (const auto baseRes = init(allocator, height, width); baseRes.is_error()) {
        return error(BitStrInitError::ALLOCATION_FAILED);
      }
 
      Slice<const char> curRow;
      auto rowIter = binaryStr.iter();
      size_t row   = 0;
      while (rowIter.next().copy_if_present(curRow)) {
        mtdefer { ++row; };
        char curCell  = '\0';
        auto cellIter = curRow.iter();
        size_t col    = 0;
        while (cellIter.next().copy_if_present(curCell)) {
          mtdefer { ++col; };
          if (curCell == '1') {
            set(row, col, true);
          }
        }
      }
      return success();
    }

Here is the call graph for this function:

◆ init() [3/5]

Result< void, BitStrInitError > mtcore::Bitset2D::init	(	mtcore::Allocator &	allocator,
		const size_t	height,
		const size_t	width,
		const Slice< Slice< const char > >	binaryStr )

inline

Initializes a bitset of a given size from a string Any bits not set by the string will be zero.

Parameters

allocator	Allocator to use for memory allocation
height	2D array height
width	2D array width
binaryStr	Binary string to use for initializing bits

Definition at line 534 of file bitset.hpp.

                                                                                 {
      return init(allocator, height, width, binaryStr.to_const());
    }

Here is the call graph for this function:

◆ init() [4/5]

Result< void, BitStrInitError > mtcore::Bitset2D::init	(	mtcore::Allocator &	allocator,
		const Slice< const Slice< const char > >	binaryStr )

inline

Initializes a bitset from a binary string of 1's and 0's.

Parameters

allocator	Allocator to use for memory allocation
binaryStr	Binary string to use for initializing bits

Definition at line 508 of file bitset.hpp.

                                                                                                                   {
      ensure(binaryStr.head && binaryStr.len && binaryStr[0].head && binaryStr[0].len, "INVALID BINARY STRING");
      const size_t max_width = binaryStr[0].len;
      for (size_t i = 1; i < binaryStr.len; ++i) {
        ensure(binaryStr[i].head && binaryStr[i].len, "INVALID BINARY STRING ROW");
      }
      return init(allocator, binaryStr.len, max_width, binaryStr);
    }

Here is the call graph for this function:

◆ init() [5/5]

Result< void, BitStrInitError > mtcore::Bitset2D::init	(	mtcore::Allocator &	allocator,
		const Slice< Slice< const char > >	binaryStr )

inline

Initializes a bitset from a binary string of 1's and 0's.

Parameters

allocator	Allocator to use for memory allocation
binaryStr	Binary string to use for initializing bits

Definition at line 522 of file bitset.hpp.

                                                                                                             {
      return init(allocator, binaryStr.to_const());
    }

Here is the call graph for this function:

◆ operator&=()

Bitset2D & mtcore::Bitset2D::operator&= ( const Bitset2D & other )

inline

Definition at line 775 of file bitset.hpp.

                                                {
      size_t row = 0;
      for (; row < other.height && row < height; ++row) {
        size_t col = 0;
        for (; col < other.width && col < width; ++col) {
          this->operator[]({row, col}) &= other[{row, col}];
        }
        for (; col < width; ++col) {
          set(row, col, false);
        }
      }
      for (; row < height; ++row) {
        for (size_t col = 0; col < width; ++col) {
          set(row, col, false);
        }
      }
      return *this;
    }

Here is the call graph for this function:

◆ operator[]() [1/2]

BitsetAccess mtcore::Bitset2D::operator[] ( std::tuple< size_t, size_t > index )

inlinenodiscard

Access an individual bit at a specific position.

Parameters

index Bit index to access

Returns: Wrapper for reading/setting bit

Definition at line 629 of file bitset.hpp.

                                                                          {
      ensure(std::get<0>(index) < height, "OUT OF BOUNDS ACCESS, INVALID ROW");
      ensure(std::get<1>(index) < width, "OUT OF BOUNDS ACCESS, INVALID COL");
      return {index, *this};
    }

◆ operator[]() [2/2]

bool mtcore::Bitset2D::operator[] ( std::tuple< size_t, size_t > index ) const

inlinenodiscard

Access an individual bit at a specific position.

Parameters

index Bit index to access

Returns: Wrapper for reading/setting bit

Definition at line 620 of file bitset.hpp.

                                                                        {
      return at(std::get<0>(index), std::get<1>(index));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator^=()

Bitset2D & mtcore::Bitset2D::operator^= ( const Bitset2D & other )

inline

Definition at line 803 of file bitset.hpp.

                                                {
      for (size_t row = 0; row < other.height && row < height; ++row) {
        for (size_t col = 0; col < other.width && col < width; ++col) {
          this->operator[]({row, col}) ^= other[{row, col}];
        }
      }
      return *this;
    }

Here is the call graph for this function:

◆ operator|=()

Bitset2D & mtcore::Bitset2D::operator|= ( const Bitset2D & other )

inline

Definition at line 794 of file bitset.hpp.

                                                {
      for (size_t row = 0; row < other.height && row < height; ++row) {
        for (size_t col = 0; col < other.width && col < width; ++col) {
          this->operator[]({row, col}) |= other[{row, col}];
        }
      }
      return *this;
    }

Here is the call graph for this function:

◆ pop_count()

size_t mtcore::Bitset2D::pop_count ( ) const

inlinenodiscard

Counts the number of set bits in the bitset.

Returns: count of set bits

Definition at line 739 of file bitset.hpp.

739{ return underlying.pop_count(); }

◆ set()

Bitset2D & mtcore::Bitset2D::set	(	size_t	row,
		size_t	col,
		bool	val )

inline

Sets a bit at a position to a specific value.

Parameters

row	Bit row to set
col	Bit col to set
val	Bit value to set to

Definition at line 697 of file bitset.hpp.

                                                    {
      ensure(row < height, "OUT OF BOUNDS ACCESS, INVALID ROW");
      ensure(col < width, "OUT OF BOUNDS ACCESS, INVALID COL");
      const auto pos = row * width + col;
      underlying.set(pos, val);
      return *this;
    }

Here is the caller graph for this function:

◆ set_all()

void mtcore::Bitset2D::set_all ( bool value )

inline

Sets all bits to a specific value.

Parameters

value to set to

Definition at line 816 of file bitset.hpp.

816{ underlying.set_all(value); }

◆ set_bits()

SetBitIter mtcore::Bitset2D::set_bits ( ) const

inlinenodiscard

Iterates over the indices of all set bits in the bitset.

Returns: an iterator over all set bits

Definition at line 773 of file bitset.hpp.

773{ return SetBitIter{*this, underlying.bits[0], 0}; }

mtcore::Bitset2D::SetBitIter

Simple bit set iterator that uses next() iteration to return the indices of all set bits.

Definition bitset.hpp:745

◆ size()

std::tuple< size_t, size_t > mtcore::Bitset2D::size ( ) const

inlinenodiscard

Gets the size of the bitset.

Returns: number of bits in bitset (not number of bytes allocated)

Definition at line 639 of file bitset.hpp.

639{ return {height, width}; }

◆ toggle()

Bitset2D & mtcore::Bitset2D::toggle	(	size_t	row,
		size_t	col )

inline

Toggles a bit at a specific position.

Parameters

row	Bit row to set
col	Bit col to set

Returns: a reference to the current bitset

Definition at line 711 of file bitset.hpp.

                                             {
      ensure(row < height, "OUT OF BOUNDS ACCESS, INVALID ROW");
      ensure(col < width, "OUT OF BOUNDS ACCESS, INVALID COL");
      const auto pos = row * width + col;
      underlying.toggle(pos);
      return *this;
    }

Member Data Documentation

◆ height

size_t mtcore::Bitset2D::height

Definition at line 480 of file bitset.hpp.

◆ underlying

Bitset mtcore::Bitset2D::underlying

Definition at line 478 of file bitset.hpp.

◆ width

size_t mtcore::Bitset2D::width

Definition at line 479 of file bitset.hpp.

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

bitset.hpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ at()

◆ clone() [1/2]

◆ clone() [2/2]

◆ deinit()

◆ first_set()

◆ init() [1/5]

◆ init() [2/5]

◆ init() [3/5]

◆ init() [4/5]

◆ init() [5/5]

◆ operator&=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator^=()

◆ operator|=()

◆ pop_count()

◆ set()

◆ set_all()

◆ set_bits()

◆ size()

◆ toggle()

Member Data Documentation

◆ height

◆ underlying

◆ width