List.H 6.94 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
     \\/     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::List

Description
    A 1D array of objects of type \<T\>, where the size of the vector
    is known and used for subscript bounds checking, etc.
31

32
33
34
35
36
37
38
39
40
41
42
43
44
45
    Storage is allocated on free-store during construction.

SourceFiles
    List.C
    ListI.H
    ListIO.C

\*---------------------------------------------------------------------------*/

#ifndef List_H
#define List_H

#include "UList.H"
#include "autoPtr.H"
Mark Olesen's avatar
Mark Olesen committed
46
#include "Xfer.H"
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

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

namespace Foam
{

class Istream;
class Ostream;

// Forward declaration of friend functions and operators

template<class T> class List;

template<class T> Istream& operator>>(Istream&, List<T>&);

template<class T, label Size> class FixedList;
template<class T> class PtrList;
template<class T> class SLList;
mattijs's avatar
mattijs committed
65
template<class T, unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
66
67
    class DynamicList;
template<class T> class SortableList;
68
69
70
71
72
73
74
75
76
77
78
79
80
81
template<class T> class IndirectList;
template<class T> class BiIndirectList;


/*---------------------------------------------------------------------------*\
                           Class List Declaration
\*---------------------------------------------------------------------------*/

template<class T>
class List
:
    public UList<T>
{

82
83
84
85
86
87
protected:

    //- Override size to be inconsistent with allocated storage.
    //  Use with care.
    inline void size(const label);

88
89
public:

90
91
92
93
94
    // Static Member Functions

        //- Return a null List
        inline static const List<T>& null();

95
96
97
98
99
100
101
102
103
104
105
106
107
108
    // Constructors

        //- Null constructor.
        inline List();

        //- Construct with given size.
        explicit List(const label);

        //- Construct with given size and value for all elements.
        List(const label, const T&);

        //- Copy constructor.
        List(const List<T>&);

109
        //- Construct by transferring the parameter contents
Mark Olesen's avatar
Mark Olesen committed
110
        List(const Xfer<List<T> >&);
111

112
113
114
        //- Construct as copy or re-use as specified.
        List(List<T>&, bool reUse);

115
        //- Construct given start and end iterators.
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
        template<class InputIterator>
        List(InputIterator first, InputIterator last);

        //- Construct as copy of FixedList<T, Size>
        template<label Size>
        List(const FixedList<T, Size>&);

        //- Construct as copy of PtrList<T>
        List(const PtrList<T>&);

        //- Construct as copy of SLList<T>
        List(const SLList<T>&);

        //- Construct as copy of IndirectList<T>
        List(const IndirectList<T>&);

        //- Construct as copy of BiIndirectList<T>
        List(const BiIndirectList<T>&);

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

        //- Clone
        inline autoPtr<List<T> > clone() const;


    // Destructor

        ~List();


    // Related types

        //- Declare type of subList
        typedef SubList<T> subList;


153
    // Member Functions
154

mattijs's avatar
mattijs committed
155
156
157
        //- Return the number of elements in the UList.
        inline label size() const;

158
159
160

        // Edit

161
162
163
164
165
166
            //- Reset size of List.
            inline void resize(const label);

            //- Reset size of List and value for new elements.
            inline void resize(const label, const T&);

167
168
169
170
171
172
173
174
175
176
177
178
179
            //- Reset size of List.
            void setSize(const label);

            //- Reset size of List and value for new elements.
            void setSize(const label, const T&);

            //- Clear the list, i.e. set size to zero.
            void clear();

            //- Transfer the contents of the argument List into this List
            //  and annull the argument list.
            void transfer(List<T>&);

mattijs's avatar
mattijs committed
180
181
182
183
184
            //- Transfer the contents of the argument List into this List
            //  and annull the argument list.
            template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
            void transfer(DynamicList<T, SizeInc, SizeMult, SizeDiv>&);

185
186
187
188
            //- Transfer the contents of the argument List into this List
            //  and annull the argument list.
            void transfer(SortableList<T>&);

Mark Olesen's avatar
Mark Olesen committed
189
190
            //- Transfer contents to the Xfer container
            inline Xfer<List<T> > xfer();
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
            //- Return subscript-checked element of UList.
            inline T& newElmt(const label);

    // Member operators

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

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

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

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

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

        //- Assignment of all entries to the given value
        inline void operator=(const T&);


    // Istream operator

        //- Read List from Istream, discarding contents of existing List.
        friend Istream& operator>>
        #ifndef __CINT__
        <T>
        #endif
        (Istream&, List<T>&);
};


template<class T>
void sort(List<T>& a);

template<class T, class Cmp>
void sort(List<T>& a, const Cmp&);

233
234
235
236
237
238
template<class T>
void stableSort(List<T>& a);

template<class T, class Cmp>
void stableSort(List<T>& a, const Cmp&);

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

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

} // End namespace Foam

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

#   include "ListI.H"

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

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

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

#endif

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