File size: 12,069 Bytes
5a600cf | 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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::FixedList
Description
A 1D vector of objects of type \<T\> with a fixed size \<Size\>.
SourceFiles
FixedList.C
FixedListI.H
FixedListIO.C
\*---------------------------------------------------------------------------*/
#ifndef FixedList_H
#define FixedList_H
#include "bool.H"
#include "label.H"
#include "uLabel.H"
#include "Hash.H"
#include "autoPtr.H"
#include <type_traits>
#include <initializer_list>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class T, unsigned Size> class FixedList;
template<class T, unsigned Size>
void writeEntry(Ostream& os, const FixedList<T, Size>&);
template<class T, unsigned Size>
Istream& operator>>(Istream&, FixedList<T, Size>&);
template<class T, unsigned Size>
Ostream& operator<<(Ostream&, const FixedList<T, Size>&);
template<class T> class UList;
class SLListBase;
template<class LListBase, class T> class LList;
template<class T>
using SLList = LList<SLListBase, T>;
/*---------------------------------------------------------------------------*\
Class FixedList Declaration
\*---------------------------------------------------------------------------*/
template<class T, unsigned Size>
class FixedList
{
static_assert
(
Size && Size <= INT_MAX,
"Size must be positive (non-zero) and also fit as a signed value"
);
// Private Data
//- Vector of values of type T of size Size.
T v_[Size];
public:
//- Hashing function class.
// Use Hasher directly for contiguous data. Otherwise hash incrementally.
template<class HashT=Hash<T>>
class Hash
{
public:
Hash()
{}
inline unsigned operator()
(
const FixedList<T, Size>&,
unsigned seed = 0
) const;
};
// Static Member Functions
//- Return a null FixedList
inline static const FixedList<T, Size>& null();
// Constructors
//- Null constructor
inline FixedList();
//- Construct from value
explicit inline FixedList(const T&);
//- Construct from C-array
explicit inline FixedList(const T v[Size]);
//- Construct given start and end iterators
template<class InputIterator>
inline FixedList(InputIterator first, InputIterator last);
//- Construct from an initialiser list
inline FixedList(std::initializer_list<T>);
//- Construct from UList
explicit inline FixedList(const UList<T>&);
//- Construct from SLList
explicit inline FixedList(const SLList<T>&);
//- Construct from Istream
FixedList(Istream&);
//- Clone
inline autoPtr<FixedList<T, Size>> clone() const;
// Member Functions
// Access
//- Return the forward circular index, i.e. the next index
// which returns to the first at the end of the list
inline label fcIndex(const label i) const;
//- Return the reverse circular index, i.e. the previous index
// which returns to the last at the beginning of the list
inline label rcIndex(const label i) const;
//- Return a const pointer to the first data element,
// similar to the STL front() method and the string::data() method
// This can be used (with caution) when interfacing with C code
inline const T* cdata() const;
//- Return a pointer to the first data element,
// similar to the STL front() method and the string::data() method
// This can be used (with caution) when interfacing with C code
inline T* data();
//- Return the first element of the list
inline T& first();
//- Return first element of the list
inline const T& first() const;
//- Return the last element of the list
inline T& last();
//- Return the last element of the list
inline const T& last() const;
//- Return element at a given index
template<unsigned I>
inline T& elmt();
//- Return element at a given index
template<unsigned I>
inline const T& elmt() const;
// Check
//- Check start is within valid range (0 ... size-1)
inline void checkStart(const label start) const;
//- Check size is within valid range (0 ... size)
inline void checkSize(const label size) const;
//- Check index i is within valid range (0 ... size-1)
inline void checkIndex(const label i) const;
// Edit
//- Dummy resize function
// needed to make FixedList consistent with List
inline void resize(const label);
//- Dummy setSize function
// needed to make FixedList consistent with List
inline void setSize(const label);
//- Copy (not transfer) the argument contents
// needed to make FixedList consistent with List
void transfer(const FixedList<T, Size>&);
// Member Operators
//- Return element of FixedList
inline T& operator[](const label);
//- Return element of constant FixedList
inline const T& operator[](const label) const;
//- Assignment to array operator. Takes linear time
inline void operator=(const T v[Size]);
//- Assignment to UList operator. Takes linear time
inline void operator=(const UList<T>&);
//- Assignment to SLList operator. Takes linear time
inline void operator=(const SLList<T>&);
//- Assignment to an initialiser list. Takes linear time
inline void operator=(std::initializer_list<T>);
//- Assignment of all entries to the given value
inline void operator=(const T&);
// STL type definitions
//- Type of values the FixedList contains
typedef T value_type;
//- Type that can be used for storing into
// FixedList::value_type objects
typedef T& reference;
//- Type that can be used for storing into
// constant FixedList::value_type objects
typedef const T& const_reference;
//- The type that can represent the difference between any two
// FixedList iterator objects
typedef label difference_type;
//- The type that can represent the size of a FixedList
typedef label size_type;
// STL iterator
//- Random access iterator for traversing FixedList
typedef T* iterator;
//- Return an iterator to begin traversing the FixedList
inline iterator begin();
//- Return an iterator to end traversing the FixedList
inline iterator end();
// STL const_iterator
//- Random access iterator for traversing FixedList
typedef const T* const_iterator;
//- Return const_iterator to begin traversing the constant FixedList
inline const_iterator cbegin() const;
//- Return const_iterator to end traversing the constant FixedList
inline const_iterator cend() const;
//- Return const_iterator to begin traversing the constant FixedList
inline const_iterator begin() const;
//- Return const_iterator to end traversing the constant FixedList
inline const_iterator end() const;
// STL reverse_iterator
//- Reverse iterator for reverse traversal of FixedList
typedef std::reverse_iterator<iterator> reverse_iterator;
//- Return reverse_iterator to begin reverse traversing the FixedList
inline reverse_iterator rbegin();
//- Return reverse_iterator to end reverse traversing the FixedList
inline reverse_iterator rend();
// STL const_reverse_iterator
//- Reverse iterator for reverse traversal of constant FixedList
typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
//- Return const_reverse_iterator to begin reverse traversing FixedList
inline const_reverse_iterator crbegin() const;
//- Return const_reverse_iterator to end reverse traversing FixedList
inline const_reverse_iterator crend() const;
//- Return const_reverse_iterator to begin reverse traversing FixedList
inline const_reverse_iterator rbegin() const;
//- Return const_reverse_iterator to end reverse traversing FixedList
inline const_reverse_iterator rend() const;
// STL member functions
//- Return the number of elements in the FixedList
inline label size() const;
//- Return size of the largest possible FixedList
inline label max_size() const;
//- Return true if the FixedList is empty (ie, size() is zero)
inline bool empty() const;
//- Swap two FixedLists of the same type in constant time
void swap(FixedList<T, Size>&);
// STL member operators
//- Equality operation on FixedLists of the same type.
// Returns true when the FixedLists are elementwise equal
// (using FixedList::value_type::operator==). Takes linear time
bool operator==(const FixedList<T, Size>&) const;
//- The opposite of the equality operation. Takes linear time
bool operator!=(const FixedList<T, Size>&) const;
//- Compare two FixedLists lexicographically. Takes linear time
bool operator<(const FixedList<T, Size>&) const;
//- Compare two FixedLists lexicographically. Takes linear time
bool operator>(const FixedList<T, Size>&) const;
//- Return true if !(a > b). Takes linear time
bool operator<=(const FixedList<T, Size>&) const;
//- Return true if !(a < b). Takes linear time
bool operator>=(const FixedList<T, Size>&) const;
// IOstream Operators
//- Read List from Istream, discarding contents of existing List
friend Istream& operator>> <T, Size>
(Istream&, FixedList<T, Size>&);
//- Write FixedList to Ostream
friend Ostream& operator<< <T, Size>
(
Ostream&,
const FixedList<T, Size>&
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "FixedListI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "FixedList.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|