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
|
// -*- mode: c++; c-basic-offset:4 -*-
// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.
// Copyright (c) 2002,2003 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
// (c) COPYRIGHT URI/MIT 1994-1999
// Please read the full copyright statement in the file COPYRIGHT_URI.
//
// Authors:
// jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
// Class for array variables. The dimensions of the array are stored in the
// list SHAPE.
//
// jhrg 9/6/94
#ifndef _array_h
#define _array_h 1
#include <string>
#include <vector>
#ifndef _dods_limits_h
#include "dods-limits.h"
#endif
#ifndef _vector_h
#include "Vector.h"
#endif
namespace libdap
{
const int DODS_MAX_ARRAY = DODS_INT_MAX;
/** This class is used to hold arrays of data. The elements of the array can
be simple or compound data types. There is no limit on the number of
dimensions an array can have, or on the size of each dimension.
If desired, the user can give each dimension of an array a name. You can,
for example, have a 360x180 array of temperatures, covering the whole
globe with one-degree squares. In this case, you could name the first
dimension \e Longitude and the second dimension \e Latitude. This can
help prevent a great deal of confusion.
The Array is used as part of the Grid class, where the dimension names
are crucial to its structure. The dimension names correspond to \e Map
vectors, holding the actual values for that column of the array.
Each array dimension carries with it its own projection information. The
projection information takes the form of three integers: the start, stop,
and stride values. This is clearest with an example. Consider a
one-dimensional array 10 elements long. If the start value of the
dimension constraint is 3, then the constrained array appears to be seven
elements long. If the stop value is changed to 7, then the array appears
to be five elements long. If the stride is changed to two, the array will
appear to be 3 elements long. Array constraints are written as:
<b>[start:stride:stop]</b>.
\verbatim
A = [1 2 3 4 5 6 7 8 9 10]
A[3::] = [4 5 6 7 8 9 10]
A[3::7] = [4 5 6 7 8]
A[3:2:7] = [4 6 8]
A[0:3:9] = [1 4 7 10]
\endverbatim
@note Arrays use zero-based indexing.
@brief A multidimensional array of identical data types.
@see Grid
@see Vector
@see dimension */
class Array: public Vector
{
public:
/** Information about a dimension. Each Array has one or more dimensions.
For each of an Array's dimensions, a corresponding instance of this
struct holds the natural size, name, constraint information and
constrained size.
@note Instead of using this struct's fields directly, use Array's
dimension accessor methods.
@note This struct is public because its type is used in public
typedefs. */
struct dimension
{
int size; ///< The unconstrained dimension size.
string name; ///< The name of this dimension.
int start; ///< The constraint start index
int stop; ///< The constraint end index
int stride; ///< The constraint stride
int c_size; ///< Size of dimension once constrained
};
private:
std::vector<dimension> _shape; // list of dimensions (i.e., the shape)
friend class ArrayTest;
protected:
void _duplicate(const Array &a);
//#if FILE_METHODS
unsigned int print_array(FILE *out, unsigned int index,
unsigned int dims, unsigned int shape[]);
//#endif
unsigned int print_array(ostream &out, unsigned int index,
unsigned int dims, unsigned int shape[]);
public:
/** A constant iterator used to access the various dimensions of an
Array.
@see dim_begin()
@see dim_end() */
typedef std::vector<dimension>::const_iterator Dim_citer ;
/** An iterator used to access the various dimensions of an
Array. Most of the methods that access various properties of a
dimension use an instance of Dim_iter.
@see dim_begin()
@see dim_end() */
typedef std::vector<dimension>::iterator Dim_iter ;
Array(const string &n, BaseType *v);
Array(const string &n, const string &d, BaseType *v);
Array(const Array &rhs);
virtual ~Array();
Array &operator=(const Array &rhs);
virtual BaseType *ptr_duplicate();
void add_var(BaseType *v, Part p = nil);
void update_length(int size);
void append_dim(int size, string name = "");
void add_constraint(Dim_iter i, int start, int stride, int stop);
void reset_constraint();
void clear_constraint();
Dim_iter dim_begin() ;
Dim_iter dim_end() ;
int dimension_size(Dim_iter i, bool constrained = false);
int dimension_start(Dim_iter i, bool constrained = false);
int dimension_stop(Dim_iter i, bool constrained = false);
int dimension_stride(Dim_iter i, bool constrained = false);
string dimension_name(Dim_iter i);
unsigned int dimensions(bool constrained = false);
virtual void print_decl(ostream &out, string space = " ",
bool print_semi = true,
bool constraint_info = false,
bool constrained = false);
virtual void print_xml(ostream &out, string space = " ",
bool constrained = false);
//#if FILE_METHODS
virtual void print_xml_core(FILE *out, string space, bool constrained, string tag);
//#endif
virtual void print_xml_core(ostream &out, string space, bool constrained, string tag);
// not used (?)
virtual void print_as_map_xml(ostream &out, string space = " ",
bool constrained = false);
virtual void print_val(ostream &out, string space = "",
bool print_decl_p = true);
//#if FILE_METHODS
virtual void print_xml(FILE *out, string space = " ",
bool constrained = false);
virtual void print_as_map_xml(FILE *out, string space = " ",
bool constrained = false);
virtual void print_val(FILE *out, string space = "",
bool print_decl_p = true);
virtual void print_decl(FILE *out, string space = " ",
bool print_semi = true,
bool constraint_info = false,
bool constrained = false);
//#endif
virtual bool check_semantics(string &msg, bool all = false);
virtual void dump(ostream &strm) const ;
};
} // namespace libdap
#endif // _array_h
|
