kouta::utils::EnumSet< TEnum > Class Template Reference

Custom bitset implementation that allows using enumeration values as indices. More...

#include <enum-set.hpp>

Inheritance diagram for kouta::utils::EnumSet< TEnum >:

Collaboration diagram for kouta::utils::EnumSet< TEnum >:

Public Types
using	EnumType = TEnum
	Enumeration type used.
using	BaseType = std::bitset< static_cast< std::size_t >(TEnum::_Total)>
	Base biset type.
using	reference = typename BaseType::reference

Public Member Functions
	EnumSet (std::initializer_list< TEnum > values)
	Constructor from a set of values.
bool	operator[] (EnumType pos) const
	Access a specific bit.
reference	operator[] (EnumType pos)
	Access a specific bit.
bool	test (EnumType pos) const
	Access a specific bit.
EnumSet &	set (EnumType pos, bool value=true)
	Set the value of a specific bit.

Detailed Description

template<class TEnum>
requires std::is_enum_v<TEnum>
class kouta::utils::EnumSet< TEnum >

Custom bitset implementation that allows using enumeration values as indices.

The used enumeration type used must:

• Derive from std::size_t
• Not set any value for the labels (optionally, value 0 can be set for the first one)
• Contain a _Total label at the end

The _Total label is used to determine the number of values in the enumeration (by explicitly casting it to an std::size_t value).

{c++} 
enum class MyEnum : std::size_t
{
    A,
    B,
    C,
 
    _Total
};
 
EnumSet<MyEnum> set{MyEnum::A, MyEnum::C};
 
// Test and set using enumeration values
set.test(MyEnum::A);
set.set{MyEnum::B};
 
// Or raw indices
set.test(0);
set.set(1);

Template Parameters

TEnum

Enumeration type to use.

Member Typedef Documentation

BaseType

template<class TEnum >

using kouta::utils::EnumSet< TEnum >::BaseType = std::bitset<static_cast<std::size_t>(TEnum::_Total)>

Base biset type.

EnumType

template<class TEnum >

using kouta::utils::EnumSet< TEnum >::EnumType = TEnum

Enumeration type used.

reference

template<class TEnum >

using kouta::utils::EnumSet< TEnum >::reference = typename BaseType::reference

Constructor & Destructor Documentation

EnumSet()

template<class TEnum >

kouta::utils::EnumSet< TEnum >::EnumSet ( std::initializer_list< TEnum >  values )

inline

Constructor from a set of values.

Parameters

[in]

values

Values to set.

Member Function Documentation

operator[]() [1/2]

template<class TEnum >

reference kouta::utils::EnumSet< TEnum >::operator[] ( EnumType  pos )

inline

Access a specific bit.

Note

Does not perform any bound checking.

Parameters

[in]

pos

Position to check.

Returns

Reference to the bit.

operator[]() [2/2]

template<class TEnum >

bool kouta::utils::EnumSet< TEnum >::operator[] ( EnumType  pos ) const

inline

Access a specific bit.

Note

Does not perform any bound checking.

Parameters

[in]

pos

Position to check.

Returns

Value of the bit.

set()

template<class TEnum >

EnumSet & kouta::utils::EnumSet< TEnum >::set ( EnumType  pos, bool  value = true  )

inline

Set the value of a specific bit.

Parameters

[in]	pos	Position to set.
[in]	value	Value to set.

Returns

Reference to this object for chaining

Exceptions

std::out_of_range

if pos does not correspond to a valid position within the bitset.

test()

template<class TEnum >

bool kouta::utils::EnumSet< TEnum >::test ( EnumType  pos ) const

inline

Access a specific bit.

Parameters

[in]

pos

Position to check.

Returns

Value of the bit.

Exceptions

std::out_of_range

if pos does not correspond to a valid position within the bitset.

---

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

• include/kouta/utils/enum-set.hpp