Dune::TypeTree::HybridTreePath< T > Class Template Reference

A hybrid version of TreePath that supports both compile time and run time indices. More...

#include <dune/typetree/treepath.hh>

Public Types
using	index_sequence = std::index_sequence_for< T... >
	An index_sequence for the entries in this HybridTreePath.

Public Member Functions
constexpr	HybridTreePath ()
	Default constructor.
constexpr	HybridTreePath (const HybridTreePath &tp)=default
constexpr	HybridTreePath (HybridTreePath &&tp)=default
constexpr HybridTreePath &	operator= (const HybridTreePath &tp)=default
constexpr HybridTreePath &	operator= (HybridTreePath &&tp)=default
constexpr	HybridTreePath (std::tuple< T... > t)
	Constructor from a std::tuple
template<typename... U, typename std::enable_if_t<(sizeof...(T) > 0 &&sizeof...(U)==sizeof...(T)), bool > = true>
constexpr	HybridTreePath (U... t)
	Constructor from arguments.
template<std::size_t i, std::enable_if_t<(sizeof...(T) > i), bool > = true>
constexpr auto	operator[] (Dune::index_constant< i >) const
	Get the index value at position pos.
constexpr std::size_t	operator[] (std::size_t pos) const
	Get the index value at position pos.
template<std::size_t i, std::enable_if_t<(sizeof...(T) > i), bool > = true>
constexpr auto	element (Dune::index_constant< i > pos={}) const
	Get the last index value.
constexpr std::size_t	element (std::size_t pos) const
	Get the index value at position pos.
template<std::size_t n = sizeof...(T), std::enable_if_t<(n > 0 &&n==sizeof...(T)), bool > = true>
constexpr auto	front () const
	Get the first index value. Only available in non-empty paths.
template<std::size_t n = sizeof...(T), std::enable_if_t<(n > 0 &&n==sizeof...(T)), bool > = true>
constexpr auto	back () const
	Get the last index value. Only available in non-empty paths.

Static Public Member Functions
static constexpr index_sequence	enumerate ()
	Returns an index_sequence for enumerating the components of this HybridTreePath.
static constexpr std::size_t	size ()
	Get the size (length) of this path.
static constexpr std::size_t	max_size ()
	Get the size (length) of this path.

Detailed Description

template<typename... T>
class Dune::TypeTree::HybridTreePath< T >

A hybrid version of TreePath that supports both compile time and run time indices.

A HybridTreePath supports storing a combination of run time and compile time indices. This makes it possible to store the tree path to a tree node inside the tree node itself, even if the path contains one or more PowerNodes, where each child must have exactly the same type. At the same time, as much information as possible is kept accessible at compile time, allowing for more efficient algorithms.

Note

Internally all indices are stored as std::size_t or std::integral_constant<std::size_t,v>. The latter is the same as Dune::index_constant<v>.

Member Typedef Documentation

index_sequence

template<typename... T>

using Dune::TypeTree::HybridTreePath< T >::index_sequence = std::index_sequence_for<T...>

An index_sequence for the entries in this HybridTreePath.

Constructor & Destructor Documentation

HybridTreePath() [1/5]

template<typename... T>

constexpr Dune::TypeTree::HybridTreePath< T >::HybridTreePath ( )

inlineconstexpr

Default constructor.

HybridTreePath() [2/5]

template<typename... T>

constexpr Dune::TypeTree::HybridTreePath< T >::HybridTreePath ( const HybridTreePath< T > &  tp )

constexprdefault

HybridTreePath() [3/5]

template<typename... T>

constexpr Dune::TypeTree::HybridTreePath< T >::HybridTreePath ( HybridTreePath< T > &&  tp )

constexprdefault

HybridTreePath() [4/5]

template<typename... T>

constexpr Dune::TypeTree::HybridTreePath< T >::HybridTreePath ( std::tuple< T... >  t )

inlineexplicitconstexpr

Constructor from a std::tuple

HybridTreePath() [5/5]

template<typename... T>

template<typename... U, typename std::enable_if_t<(sizeof...(T) > 0 &&sizeof...(U)==sizeof...(T)), bool > = true>

constexpr Dune::TypeTree::HybridTreePath< T >::HybridTreePath ( U...  t )

inlineexplicitconstexpr

Constructor from arguments.

Member Function Documentation

back()

template<typename... T>

template<std::size_t n = sizeof...(T), std::enable_if_t<(n > 0 &&n==sizeof...(T)), bool > = true>

constexpr auto Dune::TypeTree::HybridTreePath< T >::back ( ) const

inlineconstexpr

Get the last index value. Only available in non-empty paths.

element() [1/2]

template<typename... T>

template<std::size_t i, std::enable_if_t<(sizeof...(T) > i), bool > = true>

constexpr auto Dune::TypeTree::HybridTreePath< T >::element ( Dune::index_constant< i >  pos = {} ) const

inlineconstexpr

Get the last index value.

element() [2/2]

template<typename... T>

constexpr std::size_t Dune::TypeTree::HybridTreePath< T >::element ( std::size_t  pos ) const

inlineconstexpr

Get the index value at position pos.

enumerate()

template<typename... T>

static constexpr index_sequence Dune::TypeTree::HybridTreePath< T >::enumerate ( )

inlinestaticconstexpr

Returns an index_sequence for enumerating the components of this HybridTreePath.

front()

template<typename... T>

template<std::size_t n = sizeof...(T), std::enable_if_t<(n > 0 &&n==sizeof...(T)), bool > = true>

constexpr auto Dune::TypeTree::HybridTreePath< T >::front ( ) const

inlineconstexpr

Get the first index value. Only available in non-empty paths.

max_size()

template<typename... T>

static constexpr std::size_t Dune::TypeTree::HybridTreePath< T >::max_size ( )

inlinestaticconstexpr

Get the size (length) of this path.

operator=() [1/2]

template<typename... T>

constexpr HybridTreePath & Dune::TypeTree::HybridTreePath< T >::operator= ( const HybridTreePath< T > &  tp )

constexprdefault

operator=() [2/2]

template<typename... T>

constexpr HybridTreePath & Dune::TypeTree::HybridTreePath< T >::operator= ( HybridTreePath< T > &&  tp )

constexprdefault

operator[]() [1/2]

template<typename... T>

template<std::size_t i, std::enable_if_t<(sizeof...(T) > i), bool > = true>

constexpr auto Dune::TypeTree::HybridTreePath< T >::operator[] ( Dune::index_constant< i >  ) const

inlineconstexpr

Get the index value at position pos.

operator[]() [2/2]

template<typename... T>

constexpr std::size_t Dune::TypeTree::HybridTreePath< T >::operator[] ( std::size_t  pos ) const

inlineconstexpr

Get the index value at position pos.

size()

template<typename... T>

static constexpr std::size_t Dune::TypeTree::HybridTreePath< T >::size ( )

inlinestaticconstexpr

Get the size (length) of this path.

---

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

• treepath.hh