1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300 | // *****************************************************************************
/*!
\file src/Base/TaggedTuple.hpp
\copyright 2012-2015 J. Bakosi,
2016-2018 Los Alamos National Security, LLC.,
2019-2021 Triad National Security, LLC.
All rights reserved. See the LICENSE file for details.
\brief Tagged tuple allowing tag-based access
\details Tagged tuple allowing tag-based access. This is very much like
[std::tuple](http://en.cppreference.com/w/cpp/utility/tuple), but instead of
having to index the elements by integers, it allows access by a tag, which
can be an empty struct with a unique name. Credit goes to
ecatmur_at_stackoverflow.com, for more details, see
http://stackoverflow.com/questions/13065166/c11-tagged-tuple. For tags, see
Control/Tags.h. Tagged tuples are extensively used for transferring data
from the parser to an internal data structure in a type-save manner, which
is a tagged tuple containing a hierarchy of various containers. As an
example on how tagged tuples are used for parsing an input file, see
Control/Walker/InputDeck/InputDeck.h. Another way to use a tagged tuple is a
compile-time associated container between tags and an arbitrary type. As an
example, see rngtest::TestU01Stack::runner.
*/
// *****************************************************************************
#ifndef TaggedTuple_h
#define TaggedTuple_h
#include <type_traits>
#include <tuple>
#include <brigand/adapted/tuple.hpp>
#include "NoWarning/any.hpp"
#include "NoWarning/partition.hpp"
#include "NoWarning/index_of.hpp"
#include "PUPUtil.hpp"
#include "Exception.hpp"
namespace tk {
//! \brief Tagged tuple, allowing tag-based access
//! \details "Tag" here is any type, but mostly an empty struct with a good name
//! for the data member
//! \tparam List Type list as brigand::list
//! \see https://stackoverflow.com/a/42988897
//! \see https://gist.github.com/underdoeg/4c5c616c1ad4cbb718f787eefcab902d
template< class List >
class TaggedTuple{
private:
//! Generate index for every 2nd type of a type list
template< typename T >
using is_odd = brigand::size_t< (brigand::index_of<List,T>::value%2) != 0 >;
//! Partition a type list into two lists with the even and the odd types
using Pair = brigand::partition< List, brigand::bind<is_odd,brigand::_1> >;
//! List of member types
using Data = typename Pair::first_type;
//! Tuple of member types
using Tuple = brigand::as_tuple< Data >;
//! False-overload for detecting if T is a tagged tuple
template< typename T, typename = std::void_t<> >
struct is_tagged_tuple_t : std::false_type {};
//! True-overload for detecting if T is a tagged tuple
template< typename T >
struct is_tagged_tuple_t< T, std::void_t< typename T::i_am_tagged_tuple > >
: std::true_type {};
//! Member data as a tuple
Tuple m_members;
public:
//! List of key-value pairs
using PairList = List;
//! List of keys
using Keys = typename Pair::second_type;
//! Typedef defining self for identifying self
using i_am_tagged_tuple = void;
//! Acces type in tuple behind tag
template< typename Tag >
using TupleElement =
std::tuple_element_t< brigand::index_of<Keys,Tag>::value, Tuple >;
//! Query if the type behind Tag is a TaggedTuple
//! Usage: if constexpr( is_tagged_tuple<Tag>::value ) { ... }
template< typename Tag >
using is_tagged_tuple =
is_tagged_tuple_t< std::decay_t< TupleElement<Tag> > >;
//! Default constructor
explicit TaggedTuple() = default;
//! Initializer constructor
explicit TaggedTuple( Tuple&& tuple ) : m_members( std::move(tuple) ) {}
//! Const-ref access to member tuple
const Tuple& tuple() const { return m_members; }
//! Const-reference data member accessor of field of tagged tuple at depth
template< typename Tag, typename... Tags >
const auto& get() const noexcept {
constexpr std::size_t idx = brigand::index_of< Keys, Tag >::value;
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
return std::get< idx >( m_members ).template get< Tags... >();
else
return std::get< idx >( m_members );
}
//! Reference data member accessor of field of tagged tuple at depth
template< typename Tag, typename... Tags >
auto& get() noexcept {<--- Syntax Error: AST broken, binary operator '>' doesn't have two operands.
constexpr std::size_t idx = brigand::index_of< Keys, Tag >::value;
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
return std::get< idx >( m_members ).template get< Tags... >();
else
return std::get< idx >( m_members );
}
//! Convert and store value converting from string at depth
//! \param[in] value Value to convert and store
template< typename Tag, typename... Tags >
void store( const std::string& value ) noexcept {
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
{
using T = std::remove_reference_t< decltype( get<Tag,Tags...>() ) >;
get< Tag, Tags... >() = convert< T >( value );
} else {
using T = std::remove_reference_t< decltype( get< Tag >() ) >;
get< Tag >() = convert< T >( value );
}
}
//! Convert and push back value, converting from string, to vector
//! \param[in] value Value to convert and store
template< typename Tag, typename... Tags >
void store_back( const std::string& value ) noexcept {
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
{
using T = typename std::remove_reference_t<
decltype( get<Tag,Tags...>() ) >::value_type;
get< Tag, Tags... >().push_back( convert< T >( value ) );
} else {
using T = typename std::remove_reference_t<
decltype( get<Tag>() ) >::value_type;
get< Tag >().push_back( convert< T >( value ) );
}
}
//! Convert bool and push back, converting from string, to vector of ints
//! \param[in] value Value to convert and store
template< typename Tag, typename... Tags >
void store_back_bool( const std::string& value ) noexcept {
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
{
get< Tag, Tags... >().push_back( convert_bool( value ) );<--- Exception thrown in function declared not to throw exceptions.
} else {
get< Tag >().push_back( convert_bool( value ) );
}
}
//! \brief Convert and push back value, converting from string, to back of
//! a nested vector
//! \param[in] value Value to convert and store
template< typename Tag, typename... Tags >
void store_back_back( const std::string& value ) noexcept {
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
{
using T = typename std::remove_reference_t<
decltype( get<Tag,Tags...>() ) >::value_type::value_type;
get< Tag, Tags... >().back().push_back( convert< T >( value ) );
} else {
using T = typename std::remove_reference_t<
decltype( get<Tag>() ) >::value_type::value_type;
get< Tag >().back().push_back( convert< T >( value ) );
}
}
//! \brief Convert and push back value, converting from string, to back of
//! a doubly nested vector
//! \param[in] value Value to convert and store
template< typename Tag, typename... Tags >
void store_back_back_back( const std::string& value ) noexcept {
if constexpr( is_tagged_tuple<Tag>::value and sizeof...(Tags) != 0 )
{
using T = typename std::remove_reference_t<
decltype( get<Tag,Tags...>() ) >::value_type::value_type::value_type;
get< Tag, Tags... >().back().back().push_back( convert< T >( value ) );
} else {
using T = typename std::remove_reference_t<
decltype( get<Tag>() ) >::value_type::value_type::value_type;
get< Tag >().back().back().push_back( convert< T >( value ) );
}
}
//! Insert key-value pair, converting value from string, to map
template< typename Tag, typename... Tags, typename Key, typename Value >
void insert( const Key& key, const Value& value ) {
get< Tag, Tags... >()[ key ] = value;
}
//! Insert key-value pair to map of nested TaggedTuple
template< typename FieldTag, typename FieldType,
typename Tag, typename... Tags, typename Key >
void insert_field( const Key& key, const FieldType& value ) {
get< Tag, Tags... >()[ key ].template get< FieldTag >() = value;
}
//! \brief Insert key-value pair, converting value from string, to map of
//! nested TaggedTuple
template< typename FieldTag, typename FieldType,
typename Tag, typename... Tags, typename Key >
void insert_field( const Key& key, const std::string& value ) {
get< Tag, Tags... >()[ key ].template get< FieldTag >() =
convert< FieldType >( value );
}
//! Operator == between two TaggedTuple objects
//! \tparam L Type list as brigand::list for other TaggedTuple
//! \return True if the lhs and rhs equal
template< typename L >
bool operator== ( const TaggedTuple< L >& t ) const {
static_assert( std::is_same_v< L, List >, "Invoking operator== on "
"TaggedTuple objects with different typelists" );
static_assert( !brigand::any< List,
std::is_floating_point<brigand::_1> >::value, "Invoking operator== on "
"TaggedTuple objects containing a floating point type is unreliable" );
return m_members == t.tuple();
}
//! Operator < between two TaggedTuple objects
//! \tparam L Type list as brigand::list for other TaggedTuple
//! \return True if lhs < rhs
template< typename L >
bool operator< ( const TaggedTuple< L >& t ) const {
static_assert( std::is_same_v< L, List >, "Invoking operator< on "
"TaggedTuple objects with different typelists" );
return m_members < t.tuple();
}
//! Return number of tuple entries
static constexpr std::size_t size() { return std::tuple_size_v< Tuple >; }
//! Pack/Unpack
/** @name Charm++ pack/unpack serializer member functions */
///@{
//! \brief Pack/Unpack serialize member function
//! \param[in,out] p Charm++'s PUP::er serializer object reference
void pup( PUP::er& p ) { p | m_members; }<--- Parameter 'p' can be declared with const
//! \brief Pack/Unpack serialize operator|
//! \param[in,out] p Charm++'s PUP::er serializer object reference
//! \param[in,out] t TaggedTuple object reference
friend void operator|( PUP::er& p, TaggedTuple<List>& t ) { t.pup(p); }
//@}
//! Convert/parse string to and return as type given by template argument
//! \param[in] str String to convert
//! \return A value of type given by the template argument
template< typename type >
type convert( const std::string& str ) {
std::stringstream ss( str );
type num;
ss >> std::boolalpha >> num;
if (ss.fail())
Throw( "Failed to convert '" + str +
"' to typeid " + typeid(num).name() );
return num;
}
//! Convert/parse string to bool and return as int
//! \param[in] str String to convert
//! \return Bool parsed from str returned as an int
//! \details Parsing a bool from a string, e.g., "true" or "false" is
//! special compared to the above convert template, because the type into
//! which we parse to (from stringstream) must be bool, but its value must
//! be returned as an int. Input data stored this way ensures that the
//! data is stored as an int and not a bool, which could be problematic if
//! stored in a std::vector. Using this function via store_back_bool is a
//! better way to achieve type-safety of the user input and ensures data
//! does not get corrupted during Charm++ serialization as distributed to
//! multiple PEs.
int convert_bool( const std::string& str ) {
std::stringstream ss( str );
bool num;
ss >> std::boolalpha >> num;
if (ss.fail())
Throw( "Failed to convert '" + str +
"' to typeid " + typeid(num).name() );
return num;
}
};
} // tk::
#endif // TaggedTuple_h
|