Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/multi_array/doc/test_cases.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 8.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2  "http://www.w3.org/TR/html4/loose.dtd">
3<html>
4<!--
5  == Copyright 2002 The Trustees of Indiana University.
6
7  == Use, modification and distribution is subject to the Boost Software
8  == License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
9  == http://www.boost.org/LICENSE_1_0.txt)
10
11  ==  Boost.MultiArray Library
12  ==  Authors: Ronald Garcia
13  ==           Jeremy Siek
14  ==           Andrew Lumsdaine
15  ==  See http://www.boost.org/libs/multi_array for documentation.
16  -->
17<head>
18<title>
19Boost.MultiArray: Test Descriptions
20</title>
21</head>
22<body bgcolor="#ffffff" text="#000000">
23<IMG SRC="http://www.boost.org/boost.png" 
24     ALT="C++ Boost" width="277" height="86"> 
25<h1>Boost.MultiArray: Test Descriptions</h1>
26
27    The following is a description of the test cases that are included with
28    Boost.Multi_Array (B.M).
29
30<h2>Terminology</h2>
31The following list is to clarify the use of terms in the following
32descriptions:
33<ul>
34<li> <b>B.M</b> - abbreviation for Boost.MultiArray.
35
36<li><b>primary components</b> - refers to <tt>boost::multi_array</tt>,
37<tt>boost::const_multi_array_ref</tt>, and
38<tt>boost::multi_array_ref</tt>.
39
40<li><b>array types</b> - refers to all the primary components, plus for each
41primary component "array", the types <tt>array::const_subarray</tt>,
42<tt>array::subarray</tt>, <tt>array::const_array_view</tt>, and
43<tt>array::array_view </tt>
44
45</ul>
46
47<h2>Acceptance Tests</h2>
48
49    The following tests exercise various features of Boost.Multi_Array to
50    ensure proper operation at run time.
51
52<table border="1" cellspacing="0" cellpadding="5"
53summary="This table describes the test cases in the multi-array test
54      suite that should compile and run.">
55<tr>
56<td>Program</td>
57<td>Description</td>
58</tr>
59
60<tr>
61<td><a href="../test/constructors.cpp">libs/multi_array/test/constructors.cpp</a></td>
62<td>
63Exercises all of the constructors for B.M primary components.
64</td>
65</tr>
66
67<tr>
68<td><a href="../test/access.cpp">libs/multi_array/test/access.cpp</a></td>
69<td>
70Tests <tt>operator[]</tt> and <tt>operator()</tt> on all B.M array types.
71</td>
72</tr>
73
74<tr>
75<td><a href="../test/compare.cpp">libs/multi_array/test/compare.cpp</a></td>
76<td>
77Tests all comparison operators for the B.M primary components.
78</td>
79</tr>
80
81<tr>
82<td><a href="../test/iterators.cpp">libs/multi_array/test/iterators.cpp</a></td>
83<td>
84Test all iterator traversal and access functionality for all B.M array types.
85</td>
86</tr>
87
88<tr>
89<td><a href="../test/slice.cpp">libs/multi_array/test/slice.cpp</a></td>
90<td>
91Test all variations of subview generation for all B.M array types.
92</td>
93</tr>
94
95<tr>
96<td><a href="../test/assign.cpp">libs/multi_array/test/assign.cpp</a></td>
97<td>
98Tests out <tt>operator=()</tt> on the various B.M array types.
99</td>
100</tr>
101
102<tr>
103<td><a href="../test/assign_to_array.cpp">libs/multi_array/test/assign_to_array.cpp</a></td>
104<td>
105Ensure that a <tt>multi_array</tt> can be constructed from any other
106array type.
107</td>
108</tr>
109
110<tr>
111<td><a href="../test/index_bases.cpp">libs/multi_array/test/index_bases.cpp</a></td>
112<td>
113Test re-indexing functionality for the B.M primary components.
114</td>
115</tr>
116
117<tr>
118<td><a href="../test/storage_order.cpp">libs/multi_array/test/storage_order.cpp</a></td>
119<td>
120Test variations on storage_order for the B.M primary components.
121</td>
122</tr>
123
124<tr>
125<td><a href="../test/reshape.cpp">libs/multi_array/test/reshape.cpp</a></td>
126<td>
127Test re-shaping functionality for the B.M primary components.
128</td>
129</tr>
130
131<tr>
132<td><a href="../test/range1.cpp">libs/multi_array/test/range1.cpp</a></td>
133<td>
134Test the various syntaxes for specifying index ranges using
135<tt>array::index_range</tt>.
136</td>
137</tr>
138
139<tr>
140<td><a href="../test/idxgen1.cpp">libs/multi_array/test/idxgen1.cpp</a></td>
141<td>
142Test the <tt>array::index_gen</tt> objects.
143</td>
144</tr>
145
146<tr>
147<td><a href="../test/stl_interaction.cpp">libs/multi_array/test/stl_interaction.cpp</a></td>
148<td>
149Test interaction between array types and STL containers.
150</td>
151</tr>
152
153<tr>
154<td><a href="../test/resize.cpp">libs/multi_array/test/resize.cpp</a></td>
155<td>
156Test the <tt>multi_array</tt> class' resizing functionality.
157</td>
158</tr>
159
160<tr>
161<td><a href="../test/concept_checks.cpp">libs/multi_array/test/concept_checks.cpp</a></td>
162<td>
163Ensure that all the array types meet the defined Concepts.
164</td>
165</tr>
166
167<tr>
168<td><a href="../test/generative_tests.hpp">libs/multi_array/test/generative_tests.hpp</a></td>
169<td>
170A test harness used to simplify testing operations upon all array
171types. Used by slice.cpp, iterators.cpp, and access.cpp.
172</td>
173</tr>
174</table>
175
176<h2>Compile-Fail Tests</h2>
177
178    The following tests check to make sure that various constructs not
179    accepted by the library fail to compile.  Each test checks only
180    one fault in order to more easily ensure the cause of the
181    compilation failure.
182<p>
183
184<table border="1" cellspacing="0" cellpadding="5"
185summary="This table describes the tests in the multi array test suite
186      that should fail to compile">
187<tr>
188<td>Program</td>
189<td>Description</td>
190</tr>
191
192<tr>
193<td><a href="../test/fail_cbracket.cpp">libs/multi_array/test/fail_cbracket.cpp</a>
194<br><a href="../test/fail_ref_cbracket.cpp">libs/multi_array/test/fail_ref_cbracket.cpp</a></td>
195<td>
196<tt>operator[]</tt> on a const array must not modify elements.
197</td>
198</tr>
199
200<tr>
201<td><a href="../test/fail_cdata.cpp">libs/multi_array/test/fail_cdata.cpp</a>
202<br><a href="../test/fail_ref_cdata.cpp">libs/multi_array/test/fail_ref_cdata.cpp</a></td>
203<td>
204<tt>array::data() const</tt> must return a pointer to const data.
205</td>
206</tr>
207
208<tr>
209<td><a href="../test/fail_citerator.cpp">libs/multi_array/test/fail_citerator.cpp</a>
210<br><a href="../test/fail_ref_citerator.cpp">libs/multi_array/test/fail_ref_citerator.cpp</a></td>
211<td>
212<tt>const_iterator</tt> must not be convertible to <tt>iterator</tt>.
213</td>
214</tr>
215
216<tr>
217<td><a href="../test/fail_cparen.cpp">libs/multi_array/test/fail_cparen.cpp</a>
218<br><a href="../test/fail_ref_cparen.cpp">libs/multi_array/test/fail_ref_cparen.cpp</a></td>
219<td>
220<tt>operator()</tt> on a const array must not modify elements.
221</td>
222</tr>
223
224<tr>
225<td><a href="../test/fail_criterator.cpp">libs/multi_array/test/fail_criterator.cpp</a>
226<br><a href="../test/fail_ref_criterator.cpp">libs/multi_array/test/fail_ref_criterator.cpp</a></td>
227<td>
228<tt>const_reverse_iterator</tt> must not be convertible to
229<tt>reverse_iterator</tt>.
230</td>
231</tr>
232
233<tr>
234<td><a href="../test/fail_csubarray.cpp">libs/multi_array/test/fail_csubarray.cpp</a>
235<br><a href="../test/fail_ref_csubarray.cpp">libs/multi_array/test/fail_ref_csubarray.cpp</a></td>
236<td>
237<tt>const_subarray</tt> must not be convertible to <tt>subarray</tt>.
238</td>
239</tr>
240
241<tr>
242<td><a href="../test/fail_csubarray2.cpp">libs/multi_array/test/fail_csubarray2.cpp</a>
243<br><a href="../test/fail_ref_csubarray2.cpp">libs/multi_array/test/fail_ref_csubarray2.cpp</a></td>
244<td>
245<tt>array::operator[] const</tt> must not be convertible to <tt>subarray</tt>.
246</td>
247</tr>
248
249<tr>
250<td><a href="../test/fail_csubarray3.cpp">libs/multi_array/test/fail_csubarray3.cpp</a>
251<br><a href="../test/fail_ref_csubarray3.cpp">libs/multi_array/test/fail_ref_csubarray3.cpp</a></td>
252<td>
253<tt>const_subarray</tt> into an array must not modify elements.
254</td>
255</tr>
256
257<tr>
258<td><a href="../test/fail_cview.cpp">libs/multi_array/test/fail_cview.cpp</a>
259<br><a href="../test/fail_ref_cview.cpp">libs/multi_array/test/fail_ref_cview.cpp</a></td>
260<td>
261<tt>const_array_view</tt> of an array must not modify elements.
262</td>
263</tr>
264
265<tr>
266<td><a href="../test/fail_cview2.cpp">libs/multi_array/test/fail_cview2.cpp</a>
267<br><a href="../test/fail_ref_cview2.cpp">libs/multi_array/test/fail_ref_cview2.cpp</a></td>
268<td>
269<tt>array::operator[] const</tt> must not be convertible to
270<tt>array_view</tt>.
271</td>
272</tr>
273
274<tr>
275<td><a href="../test/fail_cview3.cpp">libs/multi_array/test/fail_cview3.cpp</a>
276<br><a href="../test/fail_ref_cview3.cpp">libs/multi_array/test/fail_ref_cview3.cpp</a></td>
277<td>
278<tt>const_array_view</tt> of an array must not modify elements.
279</td>
280</tr>
281
282</table>
283
284<br>
285<table summary="Copyright information">
286<tr valign="top">
287<td nowrap>Copyright &copy; 2001</td>
288<td><a href="../../../people/ronald_garcia.htm">Ronald Garcia</a>,
289Indiana University (<a href=
290"mailto:garcia@cs.indiana.edu">garcia@cs.indiana.edu</a>)<br>
291<a href="../../../people/jeremy_siek.htm">Jeremy Siek</a>, Indiana
292University (<a href=
293"mailto:jsiek@cs.indiana.edu">jsiek@cs.indiana.edu</a>)<br>
294<a href="http://www.lsc.nd.edu/~lums">Andrew Lumsdaine</a>, Indiana
295University (<a href=
296"mailto:lums@cs.indiana.edu">lums@cs.indiana.edu</a>)</td>
297</tr>
298</table>
299
300<hr>
301
302<address>
303<a href="mailto:garcia@.cs.indiana.edu">Ronald Garcia</a>
304</address>
305<!-- hhmts start -->
306Last modified: Wed Oct 31 19:46:44 EST 2001
307<!-- hhmts end -->
308
309</body>
310</html>
311
Note: See TracBrowser for help on using the repository browser.