Class Acts::MultiIndex¶
-
template<typename T, std::size_t... BitsPerLevel>
class MultiIndex¶ A set of (hierachical) indices bitpacked into a single value.
The underlying value is split into blocks of bits with variable size. Each block is a level within the index hierachy and can be set and retrieved separately. The encoded MultiIndex can be ordered and compared for equality. The ordering follows the hiearchy, i.e. indices are first ordered by the highest level, then within the highest level by the second level and so on.
Public Types
Public Functions
-
MultiIndex() = default¶
Construct a default MultiIndex with undefined values for each level.
-
MultiIndex(const MultiIndex&) = default¶
-
MultiIndex(MultiIndex&) = default¶
-
inline constexpr MultiIndex makeLastDescendant(std::size_t lvl) const¶
Create index with every level below the selected level maximized.
-
inline constexpr MultiIndex makeNextSibling(std::size_t lvl) const¶
Create index with the selected level increased and levels below zeroed.
-
MultiIndex &operator=(const MultiIndex&) = default¶
-
MultiIndex &operator=(MultiIndex&&) = default¶
-
inline constexpr MultiIndex &operator=(Value encoded)¶
Allow setting the MultiIndex from an already encoded value.
-
inline constexpr MultiIndex &set(std::size_t lvl, Value val)¶
Set the value of the index level.
Public Static Functions
-
static inline constexpr std::size_t bits(std::size_t lvl)¶
Get the number of bits for the associated level.
-
template<typename ...Us>
static inline constexpr MultiIndex Encode(Us&&... us)¶ Construct a MultiIndex from values for multiple level.
This functionality must be implemented as a static, named constructor to avoid confusion with other constructors. If it would be implemented as a regular constructor, constructing a MultiIndex from a single encoded value and encoding only the first level would have the same signature and could not be distinguished.
-
static inline constexpr MultiIndex Zeros()¶
Construct a MultiIndex with all levels set to zero.
-
MultiIndex() = default¶