FixedList.H 11.2 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    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.
15
16
17
18
19
20
21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

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

Mark Olesen's avatar
Mark Olesen committed
40
#include "bool.H"
41
#include "label.H"
Mark Olesen's avatar
Mark Olesen committed
42
#include "uLabel.H"
43
44
#include "Hash.H"
#include "autoPtr.H"
Mark Olesen's avatar
Mark Olesen committed
45
#include "StaticAssert.H"
46
47
48
49
50
51
52
53

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of friend functions and operators

Mark Olesen's avatar
Mark Olesen committed
54
template<class T, unsigned Size> class FixedList;
55

Mark Olesen's avatar
Mark Olesen committed
56
template<class T, unsigned Size>
57
58
Istream& operator>>(Istream&, FixedList<T, Size>&);

Mark Olesen's avatar
Mark Olesen committed
59
template<class T, unsigned Size>
60
61
62
63
64
65
66
67
68
69
Ostream& operator<<(Ostream&, const FixedList<T, Size>&);

template<class T> class UList;
template<class T> class SLList;


/*---------------------------------------------------------------------------*\
                           Class FixedList Declaration
\*---------------------------------------------------------------------------*/

Mark Olesen's avatar
Mark Olesen committed
70
template<class T, unsigned Size>
71
72
class FixedList
{
Mark Olesen's avatar
Mark Olesen committed
73
74
75
    //- Size must be positive (non-zero) and also fit as a signed value
    StaticAssert(Size && Size <= INT_MAX);

76
77
78
79
80
81
82
83
    // Private data

        //- Vector of values of type T of size Size.
        T v_[Size];


public:

84
85
    //- Hashing function class.
    //  Use Hasher directly for contiguous data. Otherwise hash incrementally.
Mark Olesen's avatar
Mark Olesen committed
86
    template< class HashT=Hash<T> >
87
88
89
    class Hash
    {
    public:
Mark Olesen's avatar
Mark Olesen committed
90
91
92
        Hash()
        {}

93
94
95
96
97
        inline unsigned operator()
        (
            const FixedList<T, Size>&,
            unsigned seed = 0
        ) const;
98
99
    };

100
101
102
103
104
    // Static Member Functions

        //- Return a null FixedList
        inline static const FixedList<T, Size>& null();

105
106
107
108
109
110

    // Constructors

        //- Null constructor.
        inline FixedList();

mattijs's avatar
mattijs committed
111
112
        //- Construct from C-array.
        explicit inline FixedList(const T v[Size]);
113
114

        //- Construct from value
mattijs's avatar
mattijs committed
115
        explicit inline FixedList(const T&);
116
117

        //- Construct from UList.
mattijs's avatar
mattijs committed
118
        explicit inline FixedList(const UList<T>&);
119
120

        //- Construct from SLList.
mattijs's avatar
mattijs committed
121
        explicit inline FixedList(const SLList<T>&);
122
123
124
125
126
127
128
129

        //- Copy constructor.
        inline FixedList(const FixedList<T, Size>&);

        //- Construct from Istream.
        FixedList(Istream&);

        //- Clone
130
        inline autoPtr< FixedList<T, Size> > clone() const;
131
132


133
    // Member Functions
134
135
136
137
138
139
140
141

        // 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
Mark Olesen's avatar
Mark Olesen committed
142
            //  which returns to the last at the beginning of the list
143
144
145
            inline label rcIndex(const label i) const;


Mark Olesen's avatar
Mark Olesen committed
146
147
148
149
150
151
152
153
154
155
            //- 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();

156
157
158
159
160
161
162
163
164
165
166
167
            //- 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;

Mark Olesen's avatar
Mark Olesen committed
168

169
170
171
172
173
174
175
176
177
178
179
180
181
182
        // 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

183
184
185
186
            //- Dummy resize function
            //  needed to make FixedList consistent with List
            inline void resize(const label);

187
188
189
190
            //- Dummy setSize function
            //  needed to make FixedList consistent with List
            inline void setSize(const label);

191
192
193
            //- Copy (not transfer) the argument contents
            //  needed to make FixedList consistent with List
            void transfer(const FixedList<T, Size>&);
194
195

        //- Write the FixedList as a dictionary entry
Mark Olesen's avatar
Mark Olesen committed
196
        void writeEntry(Ostream&) const;
197
198

        //- Write the FixedList as a dictionary entry with keyword
Mark Olesen's avatar
Mark Olesen committed
199
        void writeEntry(const word& keyword, Ostream&) const;
200
201
202
203


    // Member operators

Mark Olesen's avatar
Mark Olesen committed
204
        //- Return element of FixedList.
205
206
        inline T& operator[](const label);

Mark Olesen's avatar
Mark Olesen committed
207
        //- Return element of constant FixedList.
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
        inline const T& operator[](const label) const;

        //- Assignment from array operator. Takes linear time.
        inline void operator=(const T v[Size]);

        //- Assignment from UList operator. Takes linear time.
        inline void operator=(const UList<T>&);

        //- Assignment from SLList operator. Takes linear time.
        inline void operator=(const SLList<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;

261
262
263
264
265
266
267
        //- 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.
268
269
        inline const_iterator begin() const;

270
        //- Return const_iterator to end traversing the constant FixedList.
271
272
273
274
275
276
277
278
        inline const_iterator end() const;


    // STL reverse_iterator

        //- Reverse iterator for reverse traversal of FixedList.
        typedef T* reverse_iterator;

279
        //- Return reverse_iterator to begin reverse traversing the FixedList.
280
281
        inline reverse_iterator rbegin();

282
        //- Return reverse_iterator to end reverse traversing the FixedList.
283
284
285
286
287
288
289
290
        inline reverse_iterator rend();


    // STL const_reverse_iterator

        //- Reverse iterator for reverse traversal of constant FixedList.
        typedef const T* const_reverse_iterator;

291
292
293
294
295
296
297
        //- 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.
298
299
        inline const_reverse_iterator rbegin() const;

300
        //- Return const_reverse_iterator to end reverse traversing FixedList.
301
302
303
304
305
306
307
308
309
310
311
        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;

Mark Olesen's avatar
Mark Olesen committed
312
        //- Return true if the FixedList is empty (ie, size() is zero).
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
        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.
Henry Weller's avatar
Henry Weller committed
345
        friend Istream& operator>> <T, Size>
346
347
348
        (Istream&, FixedList<T, Size>&);

        // Write FixedList to Ostream.
Henry Weller's avatar
Henry Weller committed
349
        friend Ostream& operator<< <T, Size>
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
        (
            Ostream&,
            const FixedList<T, Size>&
        );
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "FixedListI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
#   include "FixedList.C"
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //