utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX > Struct Template Reference

This struct condenses N boolean values into roughly N bits, saving roughly 4x memory. NUM_ELEMS parameter takes in the number of boolean values. BASE_INDEX parameter takes in the index of the first value. The recommended way to use this struct is with an enum. See core::scoring::hbonds::graph::AtomInfo for an example. More...

#include <DenseBoolMap.hh>

Public Member Functions
	DenseBoolMap ()
void	set (unsigned int const element, bool const setting)
template<unsigned int const element>
void	set (bool const setting)
	templated equivalent to set( element, setting ). I personally like this one better because it does bounds-checking at compile time and not just in debug mode. Of course, this only works if you know the value for "element" when calling set(). More...
bool	get (unsigned int const element) const
template<unsigned int const element>
constexpr bool	get () const
	templated equivalent to get( element ). I personally like this one better because it does bounds-checking at compile time and not just in debug mode. Of course, this only works if you know the value for "element" when calling get(). More...

Static Public Member Functions
static constexpr unsigned int	num_bytes ()
static constexpr unsigned int	byte_for_element (unsigned int const element)
static constexpr unsigned char	mask_for_element (unsigned int const element)

Private Attributes
std::array< unsigned char,(NUM_ELEMS+3)/4 >	data_

Detailed Description

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>
struct utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >

This struct condenses N boolean values into roughly N bits, saving roughly 4x memory. NUM_ELEMS parameter takes in the number of boolean values. BASE_INDEX parameter takes in the index of the first value. The recommended way to use this struct is with an enum. See core::scoring::hbonds::graph::AtomInfo for an example.

Constructor & Destructor Documentation

DenseBoolMap()

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::DenseBoolMap ( )

inline

References utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_, create_a3b_hbs::i, utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::num_bytes(), and utility_exit_with_message.

Member Function Documentation

byte_for_element()

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

static constexpr unsigned int utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::byte_for_element ( unsigned int const  element )

inlinestaticconstexpr

Referenced by utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::get(), and utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::set().

get() [1/2]

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

template<unsigned int const element>

constexpr bool utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::get ( ) const

inlineconstexpr

templated equivalent to get( element ). I personally like this one better because it does bounds-checking at compile time and not just in debug mode. Of course, this only works if you know the value for "element" when calling get().

References utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::byte_for_element(), utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_, and utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::mask_for_element().

get() [2/2]

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

bool utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::get ( unsigned int const  element ) const

inline

References utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::byte_for_element(), utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_, utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::mask_for_element(), numeric::interpolation::to_string(), and utility_exit_with_message.

mask_for_element()

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

static constexpr unsigned char utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::mask_for_element ( unsigned int const  element )

inlinestaticconstexpr

Referenced by utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::get(), and utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::set().

num_bytes()

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

static constexpr unsigned int utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::num_bytes ( )

inlinestaticconstexpr

Referenced by utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::DenseBoolMap().

set() [1/2]

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

template<unsigned int const element>

void utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::set ( bool const  setting )

inline

templated equivalent to set( element, setting ). I personally like this one better because it does bounds-checking at compile time and not just in debug mode. Of course, this only works if you know the value for "element" when calling set().

References utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::byte_for_element(), utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_, and utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::mask_for_element().

set() [2/2]

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

void utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::set ( unsigned int const  element, bool const  setting  )

inline

References utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::byte_for_element(), utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_, utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::mask_for_element(), numeric::interpolation::to_string(), and utility_exit_with_message.

Member Data Documentation

data_

template<unsigned int NUM_ELEMS, unsigned int BASE_INDEX>

std::array< unsigned char, ( NUM_ELEMS + 3 ) / 4 > utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::data_

private

Referenced by utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::DenseBoolMap(), utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::get(), and utility::DenseBoolMap< NUM_ELEMS, BASE_INDEX >::set().

---

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

• src/utility/DenseBoolMap.hh