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="../../../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_convert.cpp">libs/multi_array/test/storage_order_convert.cpp</a></td> 119<td> 120Test out conversions among the storage orders data types. 121</td> 122</tr> 123 124<tr> 125<td><a href="../test/storage_order.cpp">libs/multi_array/test/storage_order.cpp</a></td> 126<td> 127Test variations on storage_order for the B.M primary components. 128</td> 129</tr> 130 131<tr> 132<td><a href="../test/reshape.cpp">libs/multi_array/test/reshape.cpp</a></td> 133<td> 134Test re-shaping functionality for the B.M primary components. 135</td> 136</tr> 137 138<tr> 139<td><a href="../test/range1.cpp">libs/multi_array/test/range1.cpp</a></td> 140<td> 141Test the various syntaxes for specifying index ranges using 142<tt>array::index_range</tt>. 143</td> 144</tr> 145 146<tr> 147<td><a href="../test/idxgen1.cpp">libs/multi_array/test/idxgen1.cpp</a></td> 148<td> 149Test the <tt>array::index_gen</tt> objects. 150</td> 151</tr> 152 153<tr> 154<td><a href="../test/stl_interaction.cpp">libs/multi_array/test/stl_interaction.cpp</a></td> 155<td> 156Test interaction between array types and STL containers. 157</td> 158</tr> 159 160<tr> 161<td><a href="../test/resize.cpp">libs/multi_array/test/resize.cpp</a></td> 162<td> 163Test the <tt>multi_array</tt> class' resizing functionality. 164</td> 165</tr> 166 167<tr> 168<td><a href="../test/concept_checks.cpp">libs/multi_array/test/concept_checks.cpp</a></td> 169<td> 170Ensure that all the array types meet the defined Concepts. 171</td> 172</tr> 173 174<tr> 175<td><a href="../test/assert.cpp">libs/multi_array/test/assert.cpp</a></td> 176<td> 177Ensure that uses of BOOST_ASSERT within the library can be customized 178by library users. 179</td> 180</tr> 181 182<tr> 183<td><a href="../test/allocators.cpp">libs/multi_array/test/allocators.cpp</a></td> 184<td> 185Test support for custom allocators. 186</td> 187</tr> 188 189<tr> 190<td><a href="../test/generative_tests.hpp">libs/multi_array/test/generative_tests.hpp</a></td> 191<td> 192A test harness used to simplify testing operations upon all array 193types. Used by slice.cpp, iterators.cpp, and access.cpp. 194</td> 195</tr> 196</table> 197 198<h2>Compile-Fail Tests</h2> 199 200 The following tests check to make sure that various constructs not 201 accepted by the library fail to compile. Each test checks only 202 one fault in order to more easily ensure the cause of the 203 compilation failure. 204<p> 205 206<table border="1" cellspacing="0" cellpadding="5" 207summary="This table describes the tests in the multi array test suite 208 that should fail to compile"> 209<tr> 210<td>Program</td> 211<td>Description</td> 212</tr> 213 214<tr> 215<td><a href="../test/fail_cbracket.cpp">libs/multi_array/test/fail_cbracket.cpp</a> 216<br><a href="../test/fail_ref_cbracket.cpp">libs/multi_array/test/fail_ref_cbracket.cpp</a></td> 217<td> 218<tt>operator[]</tt> on a const array must not modify elements. 219</td> 220</tr> 221 222<tr> 223<td><a href="../test/fail_cdata.cpp">libs/multi_array/test/fail_cdata.cpp</a> 224<br><a href="../test/fail_ref_cdata.cpp">libs/multi_array/test/fail_ref_cdata.cpp</a></td> 225<td> 226<tt>array::data() const</tt> must return a pointer to const data. 227</td> 228</tr> 229 230<tr> 231<td><a href="../test/fail_citerator.cpp">libs/multi_array/test/fail_citerator.cpp</a> 232<br><a href="../test/fail_ref_citerator.cpp">libs/multi_array/test/fail_ref_citerator.cpp</a></td> 233<td> 234<tt>const_iterator</tt> must not be convertible to <tt>iterator</tt>. 235</td> 236</tr> 237 238<tr> 239<td><a href="../test/fail_cparen.cpp">libs/multi_array/test/fail_cparen.cpp</a> 240<br><a href="../test/fail_ref_cparen.cpp">libs/multi_array/test/fail_ref_cparen.cpp</a></td> 241<td> 242<tt>operator()</tt> on a const array must not modify elements. 243</td> 244</tr> 245 246<tr> 247<td><a href="../test/fail_criterator.cpp">libs/multi_array/test/fail_criterator.cpp</a> 248<br><a href="../test/fail_ref_criterator.cpp">libs/multi_array/test/fail_ref_criterator.cpp</a></td> 249<td> 250<tt>const_reverse_iterator</tt> must not be convertible to 251<tt>reverse_iterator</tt>. 252</td> 253</tr> 254 255<tr> 256<td><a href="../test/fail_csubarray.cpp">libs/multi_array/test/fail_csubarray.cpp</a> 257<br><a href="../test/fail_ref_csubarray.cpp">libs/multi_array/test/fail_ref_csubarray.cpp</a></td> 258<td> 259<tt>const_subarray</tt> must not be convertible to <tt>subarray</tt>. 260</td> 261</tr> 262 263<tr> 264<td><a href="../test/fail_csubarray2.cpp">libs/multi_array/test/fail_csubarray2.cpp</a> 265<br><a href="../test/fail_ref_csubarray2.cpp">libs/multi_array/test/fail_ref_csubarray2.cpp</a></td> 266<td> 267<tt>array::operator[] const</tt> must not be convertible to <tt>subarray</tt>. 268</td> 269</tr> 270 271<tr> 272<td><a href="../test/fail_csubarray3.cpp">libs/multi_array/test/fail_csubarray3.cpp</a> 273<br><a href="../test/fail_ref_csubarray3.cpp">libs/multi_array/test/fail_ref_csubarray3.cpp</a></td> 274<td> 275<tt>const_subarray</tt> into an array must not modify elements. 276</td> 277</tr> 278 279<tr> 280<td><a href="../test/fail_cview.cpp">libs/multi_array/test/fail_cview.cpp</a> 281<br><a href="../test/fail_ref_cview.cpp">libs/multi_array/test/fail_ref_cview.cpp</a></td> 282<td> 283<tt>const_array_view</tt> of an array must not modify elements. 284</td> 285</tr> 286 287<tr> 288<td><a href="../test/fail_cview2.cpp">libs/multi_array/test/fail_cview2.cpp</a> 289<br><a href="../test/fail_ref_cview2.cpp">libs/multi_array/test/fail_ref_cview2.cpp</a></td> 290<td> 291<tt>array::operator[] const</tt> must not be convertible to 292<tt>array_view</tt>. 293</td> 294</tr> 295 296<tr> 297<td><a href="../test/fail_cview3.cpp">libs/multi_array/test/fail_cview3.cpp</a> 298<br><a href="../test/fail_ref_cview3.cpp">libs/multi_array/test/fail_ref_cview3.cpp</a></td> 299<td> 300<tt>const_array_view</tt> of an array must not modify elements. 301</td> 302</tr> 303 304</table> 305 306<br> 307<table summary="Copyright information"> 308<tr valign="top"> 309<td nowrap>Copyright © 2001</td> 310<td><a href="http://www.boost.org/people/ronald_garcia.htm">Ronald Garcia</a>, 311Indiana University (<a href= 312"mailto:garcia@cs.indiana.edu">garcia@cs.indiana.edu</a>)<br> 313<a href="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</a>, Indiana 314University (<a href= 315"mailto:jsiek@cs.indiana.edu">jsiek@cs.indiana.edu</a>)<br> 316<a href="http://www.lsc.nd.edu/~lums">Andrew Lumsdaine</a>, Indiana 317University (<a href= 318"mailto:lums@cs.indiana.edu">lums@cs.indiana.edu</a>)</td> 319</tr> 320</table> 321 322<hr> 323 324<address> 325<a href="mailto:garcia@.cs.indiana.edu">Ronald Garcia</a> 326</address> 327<!-- hhmts start --> 328Last modified: Wed Oct 31 19:46:44 EST 2001 329<!-- hhmts end --> 330 331</body> 332</html> 333 334
