dune-typetree  2.3.1
filteredcompositenode.hh
Go to the documentation of this file.
1 // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 // vi: set et ts=4 sw=2 sts=2:
3 
4 #ifndef DUNE_TYPETREE_FILTEREDCOMPOSITENODE_HH
5 #define DUNE_TYPETREE_FILTEREDCOMPOSITENODE_HH
6 
7 #if !(HAVE_VARIADIC_TEMPLATES || DOXYGEN || HEADERCHECK)
8 #error The class FilteredCompositeNode requires compiler support for variadic templates, which your compiler lacks.
9 #endif
10 
11 #if (HAVE_VARIADIC_TEMPLATES || DOXYGEN)
12 #include <dune/common/shared_ptr.hh>
13 #include <dune/common/static_assert.hh>
14 #include <dune/common/tuples.hh>
15 #include <dune/common/typetraits.hh>
16 
17 #include <dune/typetree/filters.hh>
19 
20 namespace Dune {
21  namespace TypeTree {
22 
28 #ifndef DOXYGEN
29  namespace {
30 
31  // ********************************************************************************
32  // Utility structs for filter construction and application
33  // ********************************************************************************
34 
35  // Gets the filter and wraps it in case of a SimpleFilter.
36  template<typename Filter, typename Tag>
37  struct get_filter;
38 
39  // Helper struct to extract the child template parameter pack from the ChildTypes tuple.
40  template<typename Filter, typename Node, typename ChildTypes>
41  struct apply_filter_wrapper;
42 
43  template<typename Filter, typename Node, typename... Children>
44  struct apply_filter_wrapper<Filter,Node,tuple<Children...> >
45  : public Filter::template apply<Node,Children...>
46  {};
47 
48  // specialization for SimpleFilter
49  template<typename Filter>
50  struct get_filter<Filter,SimpleFilterTag>
51  {
52  struct type
53  {
54  template<typename Node, typename ChildTypes>
55  struct apply
56  : public apply_filter_wrapper<filter<Filter>,Node,ChildTypes>
57  {};
58  };
59  };
60 
61  // specialization for AdvancedFilter
62  template<typename Filter>
63  struct get_filter<Filter,AdvancedFilterTag>
64  {
65  struct type
66  {
67  template<typename Node, typename ChildTypes>
68  struct apply
69  : public apply_filter_wrapper<Filter,Node,ChildTypes>
70  {};
71  };
72  };
73 
74  } // anonymous namespace
75 #endif // DOXYGEN
76 
77 
79  template<typename Node, typename Filter>
81  {
82 
83  typedef typename get_filter<Filter,typename Filter::FilterTag>::type filter;
84  typedef typename filter::template apply<Node,typename Node::ChildTypes>::type filter_result;
85  typedef typename filter_result::template apply<Node> mapped_children;
86 
87  static const bool nodeIsConst = IsConst<typename remove_reference<Node>::type>::value;
88 
89  template<std::size_t k>
90  struct lazy_enable
91  {
92  static const bool value = !nodeIsConst;
93  };
94 
95  public:
96 
99 
101  typedef typename mapped_children::NodeStorage NodeStorage;
102 
104  typedef typename mapped_children::ChildTypes ChildTypes;
105 
107  static const bool isLeaf = false;
108 
110  static const bool isPower = false;
111 
113  static const bool isComposite = true;
114 
116  static const std::size_t CHILDREN = filter_result::size;
117 
119  template<std::size_t k>
120  struct Child {
121 
122 #ifndef DOXYGEN
123 
124  typedef typename tuple_element<k,typename mapped_children::Children>::type OriginalChild;
125 
126  static const std::size_t mapped_index = tuple_element<k,typename filter_result::IndexMap>::type::original_index;
127 
128 #endif // DOXYGEN
129 
131  typedef typename OriginalChild::Type Type;
132 
134  typedef typename OriginalChild::type type;
135 
137  typedef typename OriginalChild::Storage Storage;
138 
140  typedef typename OriginalChild::ConstStorage ConstStorage;
141  };
142 
145 
147 
150  template<std::size_t k>
151  typename enable_if<lazy_enable<k>::value,typename Child<k>::Type&>::type
153  {
154  return _node->template child<Child<k>::mapped_index>();
155  }
156 
158 
161  template<std::size_t k>
162  const typename Child<k>::Type& child() const
163  {
164  return _node->template child<Child<k>::mapped_index>();
165  }
166 
168 
171  template<std::size_t k>
172  typename enable_if<lazy_enable<k>::value,typename Child<k>::Storage>::type
174  {
175  return _node->template childStorage<Child<k>::mapped_index>();
176  }
177 
179 
185  template<std::size_t k>
187  {
188  return _node->template childStorage<Child<k>::mapped_index>();
189  }
190 
192  template<std::size_t k>
193  void setChild(typename Child<k>::type& child, typename enable_if<lazy_enable<k>::value,void*>::type = 0)
194  {
195  _node->template childStorage<Child<k>::mapped_index>() = stackobject_to_shared_ptr(child);
196  }
197 
199  template<std::size_t k>
200  void setChild(typename Child<k>::storage_type child, typename enable_if<lazy_enable<k>::value,void*>::type = 0)
201  {
202  _node->template childStorage<Child<k>::mapped_index>() = child;
203  }
204 
206 
209 
210  protected:
211 
213 
216  template<bool enabled = !nodeIsConst>
217  typename enable_if<enabled,Node&>::type
219  {
220  return *_node;
221  }
222 
224 
227  const Node& unfiltered() const
228  {
229  return *_node;
230  }
231 
233 
236  template<bool enabled = !nodeIsConst>
237  typename enable_if<enabled,shared_ptr<Node> >::type
239  {
240  return _node;
241  }
242 
244 
247  shared_ptr<const Node> unfilteredStorage() const
248  {
249  return _node;
250  }
251 
253 
254  public:
255 
258 
260  FilteredCompositeNode(shared_ptr<Node> node)
261  : _node(node)
262  {}
263 
266  : _node(stackobject_to_shared_ptr(node))
267  {}
268 
270 
271  private:
272  shared_ptr<Node> _node;
273  };
274 
276 
277  } // namespace TypeTree
278 } //namespace Dune
279 
280 #endif // (HAVE_VARIADIC_TEMPLATES || DOXYGEN)
281 
282 #endif // DUNE_TYPETREE_FILTEREDCOMPOSITENODE_HH
OriginalChild::Storage Storage
The storage type of the child.
Definition: filteredcompositenode.hh:137
Child< k >::ConstStorage childStorage() const
Returns the storage of the i-th child (const version).
Definition: filteredcompositenode.hh:186
Access to the type and storage type of the i-th child.
Definition: filteredcompositenode.hh:120
shared_ptr< const Node > unfilteredStorage() const
Returns the storage object of the unfiltered node (const version).
Definition: filteredcompositenode.hh:247
OriginalChild::type type
The type of the child.
Definition: filteredcompositenode.hh:134
enable_if< lazy_enable< k >::value, typename Child< k >::Storage >::type childStorage()
Returns the storage of the i-th child.
Definition: filteredcompositenode.hh:173
VariadicCompositeNodeTag NodeTag
The type tag that describes a VariadicCompositeNode.
Definition: filteredcompositenode.hh:98
enable_if< enabled, shared_ptr< Node > >::type unfilteredStorage()
Returns the storage object of the unfiltered node.
Definition: filteredcompositenode.hh:238
mapped_children::ChildTypes ChildTypes
A tuple storing the types of all children.
Definition: filteredcompositenode.hh:104
OriginalChild::Type Type
The type of the child.
Definition: filteredcompositenode.hh:131
enable_if< lazy_enable< k >::value, typename Child< k >::Type & >::type child()
Returns the i-th child.
Definition: filteredcompositenode.hh:152
OriginalChild::ConstStorage ConstStorage
The const storage type of the child.
Definition: filteredcompositenode.hh:140
FilteredCompositeNode(Node &node)
Initialize the VariadicCompositeNode with a copy of the passed-in storage type.
Definition: filteredcompositenode.hh:265
enable_if< enabled, Node & >::type unfiltered()
Returns the unfiltered node.
Definition: filteredcompositenode.hh:218
static const std::size_t CHILDREN
The number of children.
Definition: filteredcompositenode.hh:116
FilteredCompositeNode(shared_ptr< Node > node)
Initialize the VariadicCompositeNode with copies of the passed in Storage objects.
Definition: filteredcompositenode.hh:260
Tag designating a composite node that is based on variadic templates.
Definition: nodetags.hh:25
const Child< k >::Type & child() const
Returns the i-th child (const version).
Definition: filteredcompositenode.hh:162
void setChild(typename Child< k >::storage_type child, typename enable_if< lazy_enable< k >::value, void * >::type=0)
Sets the storage of the i-th child to the passed-in value.
Definition: filteredcompositenode.hh:200
mapped_children::NodeStorage NodeStorage
The type used for storing the children.
Definition: filteredcompositenode.hh:101
static const bool isLeaf
Mark this class as non leaf in the dune-typetree.
Definition: filteredcompositenode.hh:107
const Node & unfiltered() const
Returns the unfiltered node (const version).
Definition: filteredcompositenode.hh:227
static const bool isPower
Mark this class as a non power in the dune-typetree.
Definition: filteredcompositenode.hh:110
Base class for composite nodes representing a filtered view on an underlying composite node...
Definition: filteredcompositenode.hh:80
void setChild(typename Child< k >::type &child, typename enable_if< lazy_enable< k >::value, void * >::type=0)
Sets the i-th child to the passed-in value.
Definition: filteredcompositenode.hh:193
static const std::size_t value
Definition: compositenode.hh:38
Type
Definition: treepath.hh:26
static const bool isComposite
Mark this class as a composite in the dune-typetree.
Definition: filteredcompositenode.hh:113