/usr/include/dlib/tuple/tuple_abstract.h is in libdlib-dev 18.18-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // Copyright (C) 2007 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_TUPLe_ABSTRACT_H_
#ifdef DLIB_TUPLe_ABSTRACT_H_
#include "../algs.h"
#include "../serialize.h"
#include "tuple_abstract.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
struct null_type
{
/*!
WHAT THIS OBJECT REPRESENTS
This object is the default type used as the default
template argument to the tuple object's template arguments.
Also note that it has no state associated with it.
!*/
};
inline void serialize (
const null_type& ,
std::ostream&
){}
inline void deserialize (
null_type& ,
std::istream&
){}
/*!
Serialization support is provided for null_type because in some cases
it makes your code a little more concise and easier to deal with
when using tuple objects and serialization. The serialization literally
does nothing though.
!*/
// ----------------------------------------------------------------------------------------
template <
typename T0 = null_type,
typename T1 = null_type,
typename T2 = null_type,
typename T3 = null_type,
...
typename T31 = null_type
>
class tuple
{
/*!
INITIAL VALUE
Each object in the tuple is default initialized by its own constructor.
The tuple object itself does not modify them or add any additional
state.
WHAT THIS OBJECT REPRESENTS
This object represents a container of between 0 and 31 objects
where the objects contained are specified in the template
arguments.
EXAMPLE
We can declare a tuple that contains an int, a float, and a char like so:
tuple<int,float,char> ex;
Then we can access each of these by their index number. The index number
is just the order each type has in the template argument list. So we have:
ex.get<0>() = 5; // assign the int the value 5
ex.get<1>() = 3.14; // assign the float the value 3.14
ex.get<2>() = 'c'; // assign the char the value 'c'
Also, since we only have one of each type in this example tuple we can
unambiguously access each field in the tuple by their types. So for
example, we can use this syntax to access our fields:
ex.get<int>() // returns 5
ex.get<float>() // returns 3.14
ex.get<char>() // returns 'c'
We can also get the indexes of each of these fields like so:
ex.index<int>() // returns 0
ex.index<float>() // returns 1
ex.index<char>() // returns 2
!*/
public:
// the maximum number of items this tuple template can contain
const static long max_fields = 32;
template <long index>
struct get_type
{
typedef (the type of the Tindex template argument) type;
};
template <long index>
const get_type<index>::type& get (
) const;
/*!
requires
- 0 <= index <= 31
ensures
- returns a const reference to the index(th) object contained
inside this tuple
!*/
template <long index>
get_type<index>::type& get (
);
/*!
requires
- 0 <= index <= 31
ensures
- returns a non-const reference to the index(th) object contained
inside this tuple
!*/
template <typename Q>
const long index (
) const;
/*!
requires
- Q is a type of object contained in this tuple and there is
only one object of that type in the tuple
ensures
- returns the index of the object in this tuple with type Q
!*/
template <typename Q>
const Q& get (
) const;
/*!
requires
- Q is a type of object contained in this tuple and there is
only one object of that type in the tuple
ensures
- returns a const reference to the object in this tuple
with type Q
!*/
template <typename Q>
Q& get (
);
/*!
requires
- Q is a type of object contained in this tuple and there is
only one object of that type in the tuple
ensures
- returns a non-const reference to the object in this tuple
with type Q
!*/
template <typename F>
void for_each (
F& funct
);
/*!
requires
- funct is a templated function object
ensures
- for each item X in this tuple that isn't a null_type object:
- calls funct(X);
!*/
template <typename F>
void for_each (
F& funct
) const;
/*!
requires
- funct is a templated function object
ensures
- for each item X in this tuple that isn't a null_type object:
- calls funct(X);
!*/
template <typename F>
void for_each (
const F& funct
);
/*!
requires
- funct is a templated function object
ensures
- for each item X in this tuple that isn't a null_type object:
- calls funct(X);
!*/
template <typename F>
void for_each (
const F& funct
) const;
/*!
requires
- funct is a templated function object
ensures
- for each item X in this tuple that isn't a null_type object:
- calls funct(X);
!*/
template <typename F>
void for_index (
F& funct,
long idx
);
/*!
requires
- funct is a templated function object
- 0 <= idx < max_fields && get_type<idx>::type != null_type
(i.e. idx must be the index of a non-null_type object in this tuple)
ensures
- calls funct(this->get<idx>());
!*/
template <typename F>
void for_index (
F& funct,
long idx
) const;
/*!
requires
- funct is a templated function object
- 0 <= idx < max_fields && get_type<idx>::type != null_type
(i.e. idx must be the index of a non-null_type object in this tuple)
ensures
- calls funct(this->get<idx>());
!*/
template <typename F>
void for_index (
const F& funct,
long idx
);
/*!
requires
- funct is a templated function object
- 0 <= idx < max_fields && get_type<idx>::type != null_type
(i.e. idx must be the index of a non-null_type object in this tuple)
ensures
- calls funct(this->get<idx>());
!*/
template <typename F>
void for_index (
const F& funct,
long idx
) const;
/*!
requires
- funct is a templated function object
- 0 <= idx < max_fields && get_type<idx>::type != null_type
(i.e. idx must be the index of a non-null_type object in this tuple)
ensures
- calls funct(this->get<idx>());
!*/
void swap (
tuple& item
);
/*!
ensures
- swaps *this and item
!*/
// -------------------------------------------------
// global functions for tuple objects
// -------------------------------------------------
friend void swap (
tuple& a,
tuple& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
friend void serialize (
const tuple& item,
std::ostream& out
);
/*!
provides serialization support
!*/
friend void deserialize (
tuple& item,
std::istream& in
);
/*!
provides deserialization support
!*/
};
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_TUPLe_ABSTRACT_H_
|