README.changelog 13.6 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
/*! \file README.changelog
 * \brief ChangeLog for C++ containers for numbers (libaff)
 *
 * ----------------------------------------------------------------------------
 *
6
 * $Id: README.changelog,v 1.34 2003-01-04 11:10:23 forbrig Exp $
thomas.forbriger's avatar
thomas.forbriger committed
7
8
9
10
11
12
13
 * 
 * Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt) 
 * 
 * C++ containers for numbers (libaff)
 *
 * This file contains:
 *  - \ref page_changelog
thomas.forbriger's avatar
thomas.forbriger committed
14
 *  - \ref page_project_status
thomas.forbriger's avatar
thomas.forbriger committed
15
16
17
18
19
20
21
 * 
 * REVISIONS and CHANGES 
 *  - 17/12/2002   V1.0   Thomas Forbriger 
 * 
 * ============================================================================
 */

thomas.forbriger's avatar
thomas.forbriger committed
22
/*! \page page_changelog ChangeLog (AFF)
thomas.forbriger's avatar
thomas.forbriger committed
23

24
  $Id: README.changelog,v 1.34 2003-01-04 11:10:23 forbrig Exp $
thomas.forbriger's avatar
thomas.forbriger committed
25

thomas.forbriger's avatar
thomas.forbriger committed
26
  \sa \ref page_project_status
thomas.forbriger's avatar
thomas.forbriger committed
27

thomas.forbriger's avatar
thomas.forbriger committed
28
29
  Major changes in the interface of the library are marked by \b !!.

30
31
32
33
34
  - \b 04/01/2003 (thof)
    - aff::deepcopy now converts to Tcontainer. And aff::util::Subarray
      and aff::util::Slice therefore provide a Tcontainer typedef. See also
      "\ref sec_design_interface_tcontainer".

35
36
  - \b 03/01/2003 (thof)
    - introduced lib/checkedcast.h and aff::util::SizeCheckedCast
37
    - \b !! aff::FortranArray now takes container type as template argument
thomas.forbriger's avatar
thomas.forbriger committed
38
39
40
41
    - copyout function now returns an aff::Array rather
      than an aff::ConstArray
    - aff::Array inherits copyout from aff::ConstArray
    - copyout now tested by tests/arraytest.cc
42
43
    - \b !! aff::deepcopy is now placed in namespace aff, because it may prove
      useful to external user together with slices and subarrays
44

thomas.forbriger's avatar
thomas.forbriger committed
45
46
47
  - \b 31/12/2002 (thof)
    - NULL is deprecated as pointed out by Wolfgang (replaced by literal 0 in
      lib/error.cc and lib/sharedheap_def.h)
thomas.forbriger's avatar
thomas.forbriger committed
48
49
50
51
52
53
54
    - Removed non-initializing constructors in aff::ConstArray and
      aff::ConstSeries (except default constructor, which is needed, when
      object is a container's element) as suggested by Wolfgang.
    - removed constructor from Theadstruct in aff::ConstSharedHeap
    - made the non-initializing constructor aff::ConstSharedHeap
      protected. Default constructor remains public (it is needed if we
      construct a container for ConstSharedHeap elements).
thomas.forbriger's avatar
thomas.forbriger committed
55

56
57
58
59
60
61
62
63
64
65
66
  - \b 29/12/2002 (thof)
    - aff::ConstArray and aff::ConstSeries now inherit from
      aff::ConstSharedHeap. See "\ref sec_design_replicated".
    - added section about sparse interface
      (\ref sec_design_interface_sparse)
    - added section about accessing internals
      (\ref sec_design_interface_internals)
    - \b !! reworked class aff::util::Subarray and introduced
      aff::subarray
    - \b !! reworked class aff::util::Slice and introduced
      aff::slice
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    - use "using" syntax for access declarations
    - overloaded, protected versions of write-access operators lead to
      conflicts in derived classes. Resolved that conflicts and made shared
      heap objects data members in container classes.
    - aff::Strided now provides Fortran style constructor
    - reworked array classes to use shared heap member data and correct set of
      access operators - looks much more natural now
    - explain concept of member data representation 
      (\ref sec_design_hierarchy)
    - reworked series classes in the same way as array classes
    - introduced lib/deepcopy.h
    - factored out common code in copyin functions to aff::util::deepcopy
    - now and aff::Array should be able to copy in the values of an
      aff::Series
81

thomas.forbriger's avatar
thomas.forbriger committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  - \b 28/12/2002 (thof)
    - \b !! Wolfgang pointed out a fundamental design error: Classes
      aff::Array, aff::Series and aff::SharedHeap used a specialization of
      themselves as base class to implement a version for const element type
      (see "\ref sec_design_const"). Since specialization may only be declared
      after the general template itself, the base class definition is not
      available at the point it is used in the declaration of the general
      class template. We made the base class a completely independent class
      template. Base classes aff::ConstArray, aff::ConstSeries, and
      aff::ConstSharedHeap are introduced.
    - reworked documentation in
      -# lib/README
      -# lib/sharedheap.h
      -# array_dec.h

97
  - \b 27/12/2002 (thof)
98
    - completed Fortran interface documentation (\ref page_fortran)
99

thomas.forbriger's avatar
thomas.forbriger committed
100
101
102
103
104
105
106
  - \b 23/12/2002 (thof)
    - coded class aff::Subarray
    - coded class aff::Slice
    - introduced tests/helpertest.cc to test aff::Iterator,
      aff::Subarray and aff::Slice and tested helper classes
    - reorganized aff::Iterator code. Inheritance from Stepper does not work.
    - aff::Array::copyin() and aff::Array::copyout() work
thomas.forbriger's avatar
thomas.forbriger committed
107
108
    - introduced fortranshape.h and fortranshape.cc and herein
      aff::FortranArray and aff::util::FortranShape
109
    - Test of Fortran 77 interface works
thomas.forbriger's avatar
thomas.forbriger committed
110
111
112
113

  - \b 22/12/2002 (thof)
    - started test for interface to Fortran 77 code

thomas.forbriger's avatar
thomas.forbriger committed
114
115
116
  - \b 20/12/2002 (thof)
    - introduced aff/lib/seriesstepper.h and aff/lib/seriesstepper.cc
      which define aff::util::SeriesStepper
thomas.forbriger's avatar
thomas.forbriger committed
117
118
119
120
121
122
123
124
    - Access declarations are nor useable with functions
      that return a reference to *this. They must be
      reimplemented.
    - introduced class aff::LinearShape
    - provide appropriate Tstepper typedef in shape classes (requires forward
      declarations of stepper classes, because we do not like to include the
      full stepper header if we don't use it).
    - introduced aff::Iterator class template
thomas.forbriger's avatar
thomas.forbriger committed
125
    - reworked lib/README
thomas.forbriger's avatar
thomas.forbriger committed
126
    - moved SHeap to namespace util
thomas.forbriger's avatar
thomas.forbriger committed
127
128
129
130
    - reviewed README entirely
    - Remove unresolvable doxygen links in documentation parts of the code.
      Notice: There remain doxygen warning. Doxygen cannot deal with access
      declarations and has problems with member typedefs.
thomas.forbriger's avatar
thomas.forbriger committed
131

thomas.forbriger's avatar
thomas.forbriger committed
132
133
134
  - \b 19/12/2002 (thof)
    - \b !! aff::Array provides access to base classes through access
      functions and not through conversion operators.
thomas.forbriger's avatar
thomas.forbriger committed
135
136
137
138
    - Factored out header files for dump functions for different classes.
      This is necessary to use the SimpleRigidArray dump function within the
      Array class definition.
    - introduced function aff::util::StridedStepper::valid()
thomas.forbriger's avatar
update    
thomas.forbriger committed
139
140
    - aff::Array is now tested and works in its basic functionality
      (no subarrays, no slices, no deep copy, etc.)
thomas.forbriger's avatar
thomas.forbriger committed
141

thomas.forbriger's avatar
thomas.forbriger committed
142
143
144
  - \b 18/12/2002 (thof)
    - defined dump function for Strided
    - started with tests/shapetest.cc
thomas.forbriger's avatar
thomas.forbriger committed
145
    - reworked stridedstepper to fit into new concept
146
147
148
149
150
    - essential correction in aff::Strided::collapse()
    - aff::Strided, aff::Shaper, and aff::util::StridedStepper
      passed basic tests
    - additionally aff::SharedHeap and aff::SimpleRigidArray passed their
      basic tests
thomas.forbriger's avatar
thomas.forbriger committed
151
    - activated scalar assignment with aff::Array::operator=()
thomas.forbriger's avatar
thomas.forbriger committed
152
153

  - \b 17/12/2002 (thof)
thomas.forbriger's avatar
thomas.forbriger committed
154
    - introduced class Series
thomas.forbriger's avatar
thomas.forbriger committed
155
    - \b !! Array now inherits privately from Strided
thomas.forbriger's avatar
thomas.forbriger committed
156
157
    - use access declarations to declare base class functions that should be
      visible in the public interface of aff::Array and aff::SharedHeap
thomas.forbriger's avatar
thomas.forbriger committed
158
159
    - introduced tests/seriestest.cc
    - introduced dump function for class Series
thomas.forbriger's avatar
thomas.forbriger committed
160

thomas.forbriger's avatar
thomas.forbriger committed
161
162
163
164
165
*/
/*======================================================================*/

/*! \page page_project_status Project status (AFF)

166
  $Id: README.changelog,v 1.34 2003-01-04 11:10:23 forbrig Exp $
thomas.forbriger's avatar
thomas.forbriger committed
167

thomas.forbriger's avatar
thomas.forbriger committed
168
  \sa \ref page_changelog
thomas.forbriger's avatar
thomas.forbriger committed
169
170
171
172

  <TABLE>
    <TR><TD><B>Filename</B></TD>
        <TD><B>code is complete</B></TD>
thomas.forbriger's avatar
thomas.forbriger committed
173
        <TD><B>documentation is complete</B></TD>
thomas.forbriger's avatar
thomas.forbriger committed
174
        <TD><B>code is tested</B></TD>
thomas.forbriger's avatar
thomas.forbriger committed
175
        <TD><B>revision is required</B></TD>
thomas.forbriger's avatar
thomas.forbriger committed
176
    <TR><TD>libaff/README</TD>
thomas.forbriger's avatar
thomas.forbriger committed
177
178
179
180
        <TD>has no code</TD><TD> </TD><TD>has no code</TD>
        <TD>Explain Wolle's concept of multidimensional arrays.
            The HOWTO page needs a revision and much more examples.
        </TD>
thomas.forbriger's avatar
thomas.forbriger committed
181
182
    </TR>
    <TR><TD>libaff/array.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
183
        <TD>8/12/02</TD><TD>20/12/02</TD><TD>19/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
184
185
    </TR>
    <TR><TD>libaff/array_dec.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
186
        <TD>19/12/2002</TD><TD>28/12/2002</TD><TD>19/12/2002</TD>
thomas.forbriger's avatar
update    
thomas.forbriger committed
187
          <TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
188
189
    </TR>
    <TR><TD>libaff/array_def.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
190
        <TD>19/12/2002</TD><TD>20/12/2002</TD><TD>19/12/2002</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
191
192
    </TR>
    <TR><TD>libaff/binarray.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
193
        <TD>8/12/02</TD><TD>20/12/2002</TD><TD> </TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
194
195
    </TR>
    <TR><TD>libaff/dump.cc</TD>
thomas.forbriger's avatar
thomas.forbriger committed
196
        <TD>18/12/2002</TD><TD>20/12/2002</TD><TD>18/12/2002</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
197
198
    </TR>
    <TR><TD>libaff/dump.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
199
        <TD>19/12/2002</TD><TD>20/12/2002</TD><TD> </TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
200
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
201
    <TR><TD>libaff/fortranshape.cc</TD>
202
        <TD>23/12/02</TD><TD> </TD><TD>23/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
203
204
    </TR>
    <TR><TD>libaff/fortranshape.h</TD>
205
        <TD>23/12/02</TD><TD> </TD><TD>23/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
206
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
207
    <TR><TD>libaff/iterator.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
208
        <TD>20/12/2002</TD><TD> </TD><TD>23/12/02</TD>
209
        <TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
210
211
    </TR>
    <TR><TD>libaff/series.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
212
213
214
215
        <TD>17/12/02</TD><TD> </TD><TD> </TD>
        <TD>There is a constructor resolution conflict due to default
        arguments. <B>Resolving this will affect the interface
        definition</B></TD>
thomas.forbriger's avatar
thomas.forbriger committed
216
217
218
219
220
    </TR>
    <TR><TD>libaff/shaper.h</TD>
        <TD>12/12/02</TD><TD> </TD><TD>18/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/slice.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
221
        <TD>23/12/02</TD><TD> </TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
222
        <TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
223
224
    </TR>
    <TR><TD>libaff/subarray.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
225
        <TD>23/12/02</TD><TD> </TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
226
        <TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
227
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
228
229

    <TR><TD><BR><B>subdirectory "lib"</B></TD></TR>
thomas.forbriger's avatar
thomas.forbriger committed
230
    <TR><TD>libaff/lib/README</TD>
thomas.forbriger's avatar
thomas.forbriger committed
231
        <TD>has no code</TD><TD>20/12/02</TD><TD>has no code</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
232
    </TR>
233
    <TR><TD>libaff/lib/checkedcast.h</TD>
234
        <TD>03/01/2003</TD><TD>03/01/2003</TD><TD>03/01/2003</TD><TD> </TD>
235
    </TR>
236
237
238
    <TR><TD>libaff/lib/deepcopy.h</TD>
        <TD>29/12/02</TD><TD>29/12/2002</TD><TD>29/12/02</TD><TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
239
    <TR><TD>libaff/lib/error.cc</TD>
thomas.forbriger's avatar
thomas.forbriger committed
240
        <TD>16/12/02</TD><TD>20/12/2002</TD><TD>18/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
241
242
    </TR>
    <TR><TD>libaff/lib/error.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
243
        <TD>16/12/02</TD><TD>20/12/2002</TD><TD>18/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    </TR>
    <TR><TD>libaff/lib/range.h</TD>
        <TD>13/12/02</TD><TD> </TD><TD> </TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/rawarfun.h</TD>
        <TD>13/12/02</TD><TD> </TD><TD>15/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/sharedheap.h</TD>
        <TD>13/12/02</TD><TD>13/12/02</TD><TD>16/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/sharedheap_def.h</TD>
        <TD>13/12/02</TD><TD>13/12/02</TD><TD>16/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/simplearray.h</TD>
        <TD>13/12/02</TD><TD> </TD><TD>15/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/strided.cc</TD>
thomas.forbriger's avatar
thomas.forbriger committed
261
        <TD>13/12/02</TD><TD>23/12/02</TD><TD>18/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
262
263
264
265
    </TR>
    <TR><TD>libaff/lib/strided.h</TD>
        <TD>13/12/02</TD><TD> </TD><TD>18/12/02</TD><TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
266
267
268
269
270
271
    <TR><TD>libaff/lib/seriesstepper.cc</TD>
        <TD>20/12/02</TD><TD>20/12/02</TD><TD> </TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/seriesstepper.h</TD>
        <TD>20/12/02</TD><TD>20/12/02</TD><TD> </TD><TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
272
    <TR><TD>libaff/lib/stridedstepper.cc</TD>
thomas.forbriger's avatar
thomas.forbriger committed
273
        <TD>18/12/02</TD><TD>23/12/02</TD><TD>18/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
274
275
276
277
278
    </TR>
    <TR><TD>libaff/lib/stridedstepper.h</TD>
        <TD>18/12/02</TD><TD> </TD><TD>18/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/types.h</TD>
thomas.forbriger's avatar
thomas.forbriger committed
279
        <TD>13/12/02</TD><TD>23/12/02</TD><TD>15/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    </TR>
    <TR><TD>libaff/lib/dump_macros.h</TD>
        <TD>19/12/02</TD><TD>19/12/02</TD><TD>19/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/dump_sharedheap.h</TD>
        <TD>19/12/02</TD><TD> </TD><TD>19/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/dump_series.h</TD>
        <TD>19/12/02</TD><TD> </TD><TD>19/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/dump_array.h</TD>
        <TD>19/12/02</TD><TD> </TD><TD>19/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/dump_strided.h</TD>
        <TD>19/12/02</TD><TD> </TD><TD>19/12/02</TD><TD> </TD>
    </TR>
    <TR><TD>libaff/lib/dump_simplerigidarray.h</TD>
        <TD>19/12/02</TD><TD> </TD><TD>19/12/02</TD><TD> </TD>
thomas.forbriger's avatar
thomas.forbriger committed
298
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
299
300

    <TR><TD><BR><B>tests and examples</B></TD></TR>
thomas.forbriger's avatar
thomas.forbriger committed
301
    <TR><TD>libaff/tests/arraytest.cc</TD>
thomas.forbriger's avatar
update    
thomas.forbriger committed
302
        <TD>19/12/2002</TD><TD> </TD><TD>19/12/2002</TD>
thomas.forbriger's avatar
thomas.forbriger committed
303
304
305
306
307
308
          <TD> </TD>
    </TR>
    <TR><TD>libaff/tests/binarraytest.cc</TD>
        <TD> </TD><TD> </TD><TD> </TD>
          <TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
309
310
311
312
    <TR><TD>libaff/tests/helpertest.cc</TD>
        <TD>23/12/02</TD><TD> </TD><TD>23/12/02</TD>
          <TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
    <TR><TD>libaff/tests/rangetest.cc</TD>
        <TD> </TD><TD> </TD><TD> </TD>
          <TD> </TD>
    </TR>
    <TR><TD>libaff/tests/reprtest.cc</TD>
        <TD>16/12/02</TD><TD> </TD><TD>16/12/02</TD>
          <TD>does not check pathological cases</TD>
    </TR>
    <TR><TD>libaff/tests/seriestest.cc</TD>
        <TD> </TD><TD> </TD><TD> </TD>
          <TD> </TD>
    </TR>
    <TR><TD>libaff/tests/shapetest.cc</TD>
        <TD>18/12/02</TD><TD> </TD><TD>18/12/02</TD>
          <TD>does not check pathological cases</TD>
    </TR>
    <TR><TD>libaff/tests/simplearraytest.cc</TD>
        <TD>15/12/02</TD><TD> </TD><TD>15/12/02</TD>
          <TD>does not check pathological cases</TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
333
    <TR><TD>libaff/tests/f77common.inc</TD>
334
        <TD>23/12/02</TD><TD>27/12/02</TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
335
336
          <TD> </TD>
    </TR>
337
    <TR><TD>libaff/tests/f77interface.cc</TD>
338
        <TD>23/12/02</TD><TD>27/12/02</TD><TD>23/12/02</TD>
339
          <TD> </TD>
340
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
341
    <TR><TD>libaff/tests/f77procs.f</TD>
342
        <TD>23/12/02</TD><TD>27/12/02</TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
343
344
345
          <TD> </TD>
    </TR>
    <TR><TD>libaff/tests/f77proto.h</TD>
346
        <TD>23/12/02</TD><TD>27/12/02</TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
347
348
349
          <TD> </TD>
    </TR>
    <TR><TD>libaff/tests/f77test.cc</TD>
350
        <TD>23/12/02</TD><TD>27/12/02</TD><TD>23/12/02</TD>
thomas.forbriger's avatar
thomas.forbriger committed
351
352
          <TD> </TD>
    </TR>
thomas.forbriger's avatar
thomas.forbriger committed
353
  </TABLE>
thomas.forbriger's avatar
thomas.forbriger committed
354
355
356
*/

// ----- END OF README.changelog -----