Collect k instances of type T within a dune-typetree. More...

#include <dune/typetree/powernode.hh>

Classes
struct	Child
	Access to the type and storage type of the i-th child. More...

Public Types
typedef PowerNodeTag	NodeTag
	The type tag that describes a PowerNode.

typedef T	ChildType
	The type of each child.

typedef std::array< std::shared_ptr< T >, k >	NodeStorage
	The type used for storing the children.

Public Member Functions
Child Access (templated methods)
template<std::size_t i>
T &	child (index_constant< i >={})
	Returns the i-th child.

template<std::size_t i>
const T &	child (index_constant< i >={}) const
	Returns the i-th child (const version).

template<std::size_t i>
std::shared_ptr< T >	childStorage (index_constant< i >={})
	Returns the storage of the i-th child.

template<std::size_t i>
std::shared_ptr< const T >	childStorage (index_constant< i >={}) const
	Returns the storage of the i-th child (const version).

template<std::size_t i>
void	setChild (T &t, index_constant< i >={})
	Sets the i-th child to the passed-in value.

template<std::size_t i>
void	setChild (T &&t, index_constant< i >={})
	Store the passed value in i-th child.

template<std::size_t i>
void	setChild (std::shared_ptr< T > st, index_constant< i >={})
	Sets the stored value representing the i-th child to the passed-in value.

Child Access (Dynamic methods)
T &	child (std::size_t i)
	Returns the i-th child.

const T &	child (std::size_t i) const
	Returns the i-th child (const version).

std::shared_ptr< T >	childStorage (std::size_t i)
	Returns the storage of the i-th child.

std::shared_ptr< const T >	childStorage (std::size_t i) const
	Returns the storage of the i-th child (const version).

void	setChild (std::size_t i, T &t)
	Sets the i-th child to the passed-in value.

void	setChild (std::size_t i, T &&t)
	Store the passed value in i-th child.

void	setChild (std::size_t i, std::shared_ptr< T > st)
	Sets the stored value representing the i-th child to the passed-in value.

const NodeStorage &	nodeStorage () const

Nested Child Access
template<typename... Indices>
ImplementationDefined &	child (Indices... indices)
	Returns the child given by the list of indices.

template<typename... Indices>
const ImplementationDefined &	child (Indices... indices)
	Returns the child given by the list of indices.

Static Public Member Functions
static constexpr auto	degree ()

Static Public Attributes
static const bool	isLeaf = false
	Mark this class as non leaf in the dune-typetree.

static const bool	isPower = true
	Mark this class as a power in the dune-typetree.

static const bool	isComposite = false
	Mark this class as a non composite in the dune-typetree.

Protected Member Functions
Constructors
	PowerNode ()
	Default constructor.

	PowerNode (const NodeStorage &children)
	Initialize the PowerNode with a copy of the passed-in storage type.

	PowerNode (T &t, bool distinct_objects=true)
	Initialize all children with copies of a storage object constructed from the parameter `t`.

	PowerNode (T &t1, T &t2,...)
	Initialize all children with the passed-in objects.

Detailed Description

template<typename T, std::size_t k>
class Dune::TypeTree::PowerNode< T, k >

Collect k instances of type T within a dune-typetree.

Template Parameters

T	The base type
k	The number of instances this node should collect

Member Typedef Documentation

◆ ChildType

template<typename T , std::size_t k>

typedef T Dune::TypeTree::PowerNode< T, k >::ChildType

The type of each child.

◆ NodeStorage

template<typename T , std::size_t k>

typedef std::array<std::shared_ptr<T>,k> Dune::TypeTree::PowerNode< T, k >::NodeStorage

The type used for storing the children.

◆ NodeTag

template<typename T , std::size_t k>

typedef PowerNodeTag Dune::TypeTree::PowerNode< T, k >::NodeTag

The type tag that describes a PowerNode.

Constructor & Destructor Documentation

◆ PowerNode() [1/4]

template<typename T , std::size_t k>

Dune::TypeTree::PowerNode< T, k >::PowerNode ( )

inlineprotected

Default constructor.

The default constructor is protected, as PowerNode is a utility class that needs to be filled with meaning by subclassing it and adding useful functionality to the subclass.

Warning: When using the default constructor, make sure to set ALL children by means of the setChild() methods!

◆ PowerNode() [2/4]

template<typename T , std::size_t k>

Dune::TypeTree::PowerNode< T, k >::PowerNode ( const NodeStorage & children )

inlineexplicitprotected

Initialize the PowerNode with a copy of the passed-in storage type.

◆ PowerNode() [3/4]

template<typename T , std::size_t k>

Dune::TypeTree::PowerNode< T, k >::PowerNode	(	T &	t,
		bool	distinct_objects = `true`
	)

inlineexplicitprotected

Initialize all children with copies of a storage object constructed from the parameter t.

◆ PowerNode() [4/4]

template<typename T , std::size_t k>

Dune::TypeTree::PowerNode< T, k >::PowerNode	(	T &	t1,
		T &	t2,
			...
	)

inlineprotected

Initialize all children with the passed-in objects.

Member Function Documentation

◆ child() [1/6]

template<typename T , std::size_t k>

template<std::size_t i>

T & Dune::TypeTree::PowerNode< T, k >::child ( index_constant< i > = {} )

inline

Returns the i-th child.

Returns: a reference to the i-th child.

◆ child() [2/6]

template<typename T , std::size_t k>

template<std::size_t i>

const T & Dune::TypeTree::PowerNode< T, k >::child ( index_constant< i > = {} ) const

inline

Returns the i-th child (const version).

Returns: a const reference to the i-th child.

◆ child() [3/6]

template<typename T , std::size_t k>

template<typename... Indices>

ImplementationDefined & Dune::TypeTree::PowerNode< T, k >::child ( Indices... indices )

inline

Returns the child given by the list of indices.

This method simply forwards to the freestanding function child(). See that function for further information.

◆ child() [4/6]

template<typename T , std::size_t k>

template<typename... Indices>

const ImplementationDefined & Dune::TypeTree::PowerNode< T, k >::child ( Indices... indices )

inline

Returns the child given by the list of indices.

This method simply forwards to the freestanding function child(). See that function for further information.

◆ child() [5/6]

template<typename T , std::size_t k>

T & Dune::TypeTree::PowerNode< T, k >::child ( std::size_t i )

inline

Returns the i-th child.

Returns: a reference to the i-th child.

◆ child() [6/6]

template<typename T , std::size_t k>

const T & Dune::TypeTree::PowerNode< T, k >::child ( std::size_t i ) const

inline

Returns the i-th child (const version).

Returns: a const reference to the i-th child.

◆ childStorage() [1/4]

template<typename T , std::size_t k>

template<std::size_t i>

std::shared_ptr< T > Dune::TypeTree::PowerNode< T, k >::childStorage ( index_constant< i > = {} )

inline

Returns the storage of the i-th child.

Returns: a copy of the object storing the i-th child.

◆ childStorage() [2/4]

template<typename T , std::size_t k>

template<std::size_t i>

std::shared_ptr< const T > Dune::TypeTree::PowerNode< T, k >::childStorage ( index_constant< i > = {} ) const

inline

Returns the storage of the i-th child (const version).

Returns: a copy of the object storing the i-th child.

◆ childStorage() [3/4]

template<typename T , std::size_t k>

std::shared_ptr< T > Dune::TypeTree::PowerNode< T, k >::childStorage ( std::size_t i )

inline

Returns the storage of the i-th child.

Returns: a copy of the object storing the i-th child.

◆ childStorage() [4/4]

template<typename T , std::size_t k>

std::shared_ptr< const T > Dune::TypeTree::PowerNode< T, k >::childStorage ( std::size_t i ) const

inline

Returns the storage of the i-th child (const version).

Returns: a copy of the object storing the i-th child.

◆ degree()

template<typename T , std::size_t k>

static constexpr auto Dune::TypeTree::PowerNode< T, k >::degree ( )

inlinestaticconstexpr

◆ nodeStorage()

template<typename T , std::size_t k>

const NodeStorage & Dune::TypeTree::PowerNode< T, k >::nodeStorage ( ) const

inline

◆ setChild() [1/6]

template<typename T , std::size_t k>

template<std::size_t i>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	std::shared_ptr< T >	st,
		index_constant< i >	= `{}`
	)

inline

Sets the stored value representing the i-th child to the passed-in value.

◆ setChild() [2/6]

template<typename T , std::size_t k>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	std::size_t	i,
		std::shared_ptr< T >	st
	)

inline

Sets the stored value representing the i-th child to the passed-in value.

◆ setChild() [3/6]

template<typename T , std::size_t k>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	std::size_t	i,
		T &&	t
	)

inline

Store the passed value in i-th child.

◆ setChild() [4/6]

template<typename T , std::size_t k>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	std::size_t	i,
		T &	t
	)

inline

Sets the i-th child to the passed-in value.

◆ setChild() [5/6]

template<typename T , std::size_t k>

template<std::size_t i>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	T &&	t,
		index_constant< i >	= `{}`
	)

inline

Store the passed value in i-th child.

◆ setChild() [6/6]

template<typename T , std::size_t k>

template<std::size_t i>

void Dune::TypeTree::PowerNode< T, k >::setChild	(	T &	t,
		index_constant< i >	= `{}`
	)

inline

Sets the i-th child to the passed-in value.

Member Data Documentation

◆ isComposite

template<typename T , std::size_t k>

const bool Dune::TypeTree::PowerNode< T, k >::isComposite = false

static

Mark this class as a non composite in the dune-typetree.

◆ isLeaf

template<typename T , std::size_t k>

const bool Dune::TypeTree::PowerNode< T, k >::isLeaf = false

static

Mark this class as non leaf in the dune-typetree.

◆ isPower

template<typename T , std::size_t k>

const bool Dune::TypeTree::PowerNode< T, k >::isPower = true

static

Mark this class as a power in the dune-typetree.

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

powernode.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ChildType

◆ NodeStorage

◆ NodeTag

Constructor & Destructor Documentation

◆ PowerNode() [1/4]

◆ PowerNode() [2/4]

◆ PowerNode() [3/4]

◆ PowerNode() [4/4]

Member Function Documentation

◆ child() [1/6]

◆ child() [2/6]

◆ child() [3/6]

◆ child() [4/6]

◆ child() [5/6]

◆ child() [6/6]

◆ childStorage() [1/4]

◆ childStorage() [2/4]

◆ childStorage() [3/4]

◆ childStorage() [4/4]

◆ degree()

◆ nodeStorage()

◆ setChild() [1/6]

◆ setChild() [2/6]

◆ setChild() [3/6]

◆ setChild() [4/6]

◆ setChild() [5/6]

◆ setChild() [6/6]

Member Data Documentation

◆ isComposite

◆ isLeaf

◆ isPower