FixedList.H 10.9 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
Mark Olesen's avatar
Mark Olesen committed
5
    \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
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
     \\/     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 2 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, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

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
41
#include "bool.H"
42
#include "label.H"
Mark Olesen's avatar
Mark Olesen committed
43
#include "uLabel.H"
44
45
#include "Hash.H"
#include "autoPtr.H"
Mark Olesen's avatar
Mark Olesen committed
46
#include "StaticAssert.H"
47
48
49
50
51
52
53
54

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

namespace Foam
{

// Forward declaration of friend functions and operators

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

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

Mark Olesen's avatar
Mark Olesen committed
60
template<class T, unsigned Size>
61
62
63
64
65
66
67
68
69
70
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
71
template<class T, unsigned Size>
72
73
class FixedList
{
Mark Olesen's avatar
Mark Olesen committed
74
75
76
    //- Size must be positive (non-zero) and also fit as a signed value
    StaticAssert(Size && Size <= INT_MAX);

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

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


public:

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

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

101
102
103
104
105
    // Static Member Functions

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

106
107
108
109
110
111

    // Constructors

        //- Null constructor.
        inline FixedList();

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

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

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

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

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

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

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


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

        // 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
143
            //  which returns to the last at the beginning of the list
144
145
146
            inline label rcIndex(const label i) const;


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


158
159
160
161
162
163
164
165
166
167
168
169
170
171
        // 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

172
173
174
175
            //- Dummy resize function
            //  needed to make FixedList consistent with List
            inline void resize(const label);

176
177
178
179
            //- Dummy setSize function
            //  needed to make FixedList consistent with List
            inline void setSize(const label);

180
181
182
            //- Copy (not transfer) the argument contents
            //  needed to make FixedList consistent with List
            void transfer(const FixedList<T, Size>&);
183
184

        //- Write the FixedList as a dictionary entry
Mark Olesen's avatar
Mark Olesen committed
185
        void writeEntry(Ostream&) const;
186
187

        //- Write the FixedList as a dictionary entry with keyword
Mark Olesen's avatar
Mark Olesen committed
188
        void writeEntry(const word& keyword, Ostream&) const;
189
190
191
192


    // Member operators

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

Mark Olesen's avatar
Mark Olesen committed
196
        //- Return element of constant FixedList.
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
        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;

250
251
252
253
254
255
256
        //- 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.
257
258
        inline const_iterator begin() const;

259
        //- Return const_iterator to end traversing the constant FixedList.
260
261
262
263
264
265
266
267
        inline const_iterator end() const;


    // STL reverse_iterator

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

268
        //- Return reverse_iterator to begin reverse traversing the FixedList.
269
270
        inline reverse_iterator rbegin();

271
        //- Return reverse_iterator to end reverse traversing the FixedList.
272
273
274
275
276
277
278
279
        inline reverse_iterator rend();


    // STL const_reverse_iterator

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

280
281
282
283
284
285
286
        //- 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.
287
288
        inline const_reverse_iterator rbegin() const;

289
        //- Return const_reverse_iterator to end reverse traversing FixedList.
290
291
292
293
294
295
296
297
298
299
300
        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
301
        //- Return true if the FixedList is empty (ie, size() is zero).
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
        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
334
        friend Istream& operator>> <T, Size>
335
336
337
        (Istream&, FixedList<T, Size>&);

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


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

} // End namespace Foam

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

#include "FixedListI.H"

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

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

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

#endif

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