Type Definitions module

Standard type aliases and definitions used throughout Rodin.

This module contains type definitions that provide consistent naming and standardized types across the entire Rodin library.

Typedefs

template<class T, class Container = Deque<T>>
using Stack = std::stack<T, Container>
template<class T>
using FlatSet = boost::container::flat_set<T>
template<class T>
using UnorderedSet = boost::unordered_set<T>
template<class K, class T>
using Map = boost::container::map<K, T>
template<class ... Params>
using UnorderedMap = boost::unordered_map<Params...>
template<class K, class T>
using FlatMap = boost::container::flat_map<K, T>
using IndexSet = FlatSet<Index>
template<class T>
using IndexMap = FlatMap<Index, T>
template<size_t Size>
using BitSet = std::bitset<Size>
using BitSet2 = std::bitset<2>
template<class T>
using Optional = std::optional<T>

Typedef documentation

template<class T, class Container = Deque<T>>
using Stack = std::stack<T, Container>

Standard type for representing stacks.

template<class T>
using FlatSet = boost::container::flat_set<T>

Standard flat set type.

template<class T>
using UnorderedSet = boost::unordered_set<T>

Standard unordered set type.

template<class K, class T>
using Map = boost::container::map<K, T>

Standard ordered map type.

template<class ... Params>
using UnorderedMap = boost::unordered_map<Params...>

Standard unordered map type.

template<class K, class T>
using FlatMap = boost::container::flat_map<K, T>

Standard flat map type.

using IndexSet = FlatSet<Index>

Standard set of indices.

template<class T>
using IndexMap = FlatMap<Index, T>

Standard map of indices to arbitrary types.

template<size_t Size>
using BitSet = std::bitset<Size>

Standard bitset template with fixed size.

using BitSet2 = std::bitset<2>

Standard bitset with 2 bits.

template<class T>
using Optional = std::optional<T>

Standard optional type wrapper.