Gitiles
Code Review Sign In
realtimeroboticsgroup.org / RealtimeRoboticsGroup / test / 3cbbaca6b1a4c98b648739251c948e49c6980ad9 / . / doc / tests.html
blob: 1adc0f504f32e0d9782b12f873724d5ed6fbda32 [file] [log] [blame]
Brian Silverman3cbbaca2018-08-04 23:38:07 -0700[diff] [blame^]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN">
2
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>Boost.MultiIndex Documentation - Tests</title>
7<link rel="stylesheet" href="style.css" type="text/css">
8<link rel="start" href="index.html">
9<link rel="prev" href="examples.html">
10<link rel="up" href="index.html">
11<link rel="next" href="future_work.html">
12</head>
13
14<body>
15<h1><img src="../../../boost.png" alt="boost.png (6897 bytes)" align=
16"middle" width="277" height="86">Boost.MultiIndex Tests</h1>
17
18<div class="prev_link"><a href="examples.html"><img src="prev.gif" alt="examples" border="0"><br>
19Examples
20</a></div>
21<div class="up_link"><a href="index.html"><img src="up.gif" alt="index" border="0"><br>
22Index
23</a></div>
24<div class="next_link"><a href="future_work.html"><img src="next.gif" alt="future work" border="0"><br>
25Future work
26</a></div><br clear="all" style="clear: all;">
27
28<hr>
29
30<p>
31The Boost.MultiIndex test suite exercises the whole spectrum of
32functionalities provided by the library. Although the tests are not meant
33to serve as a learning guide, the interested reader may find it
34useful to inspect the source code to gain familiarity
35with some of the least common features offered by Boost.MultiIndex.
36</p>
37
38<p align="center">
39<table cellspacing="0" cellpadding="5">
40 <caption><b>Boost.MultiIndex test suite.</b></caption>
41<tr>
42 <th>Program</th>
43 <th>Description</th>
44</tr>
45<tr>
46 <td><a href="../test/test_basic.cpp"><code>test_basic.cpp</code></a></td>
47 <td>Simple program along the lines of the employees example studied in the
48 tutorial.</td>
49</tr>
50<tr class="odd_tr">
51 <td><a href="../test/test_capacity.cpp"><code>test_capacity.cpp</code></a></td>
52 <td><code>empty</code>, <code>size</code>, <code>resize</code>
53 (non key-based indices) and <code>reserve</code>/<code>capacity</code>
54 (random access indices only).</td>
55</tr>
56<tr>
57 <td><a href="../test/test_comparison.cpp"><code>test_comparison.cpp</code></a></td>
58 <td>Comparison between indices.</td>
59</tr>
60<tr class="odd_tr">
61 <td><a href="../test/test_composite_key.cpp"><code>test_composite_key.cpp</code></a></td>
62 <td><code>composite_key</code> and <code>composite_key_compare</code>.</td>
63</tr>
64<tr>
65 <td><a href="../test/test_conv_iterators.cpp"><code>test_conv_iterators.cpp</code></a></td>
66 <td>Checks convertibility of non-constant to constant iterators.</td>
67</tr>
68<tr class="odd_tr">
69 <td><a href="../test/test_copy_assignment.cpp"><code>test_copy_assignment.cpp</code></a></td>
70 <td>Various forms of assignment: copy, <code>operator =</code>, insertion,
71 (non key-based indices only) <code>assign</code> .
72</tr>
73<tr>
74 <td><a href="../test/test_hash_ops.cpp"><code>test_hash_ops.cpp</code></a></td>
75 <td>Hashing operations.</td>
76</tr>
77<tr class="odd_tr">
78 <td><a href="../test/test_iterators.cpp"><code>test_iterators.cpp</code></a></td>
79 <td>Constant and non-constant iterators and their reverse variants.</td>
80</tr>
81<tr>
82 <td><a href="../test/test_key_extractors.cpp"><code>test_key_extractors.cpp</code></a></td>
83 <td>Covers all use cases of key extractors shipped with the library.</td>
84</tr>
85<tr class="odd_tr">
86 <td><a href="../test/test_list_ops.cpp"><code>test_list_ops.cpp</code></a></td>
87 <td>List-like operations particular to sequenced and random access indices.</td>
88</tr>
89<tr>
90 <td><a href="../test/test_modifiers.cpp"><code>test_modifiers.cpp</code></a></td>
91 <td>Checks the family of insertion and erasing operations.</td>
92</tr>
93<tr class="odd_tr">
94 <td><a href="../test/test_mpl_ops.cpp"><code>test_mpl_ops.cpp</code></a></td>
95 <td>Metaprogramming manipulations of <code>multi_index_container</code> types.</td>
96</tr>
97<tr>
98 <td><a href="../test/test_observers.cpp"><code>test_observers.cpp</code></a></td>
99 <td>Checks observer member functions of ordered and hashed indices.</td>
100</tr>
101<tr class="odd_tr">
102 <td><a href="../test/test_projection.cpp"><code>test_projection.cpp</code></a></td>
103 <td>Projection of iterators among indices.</td>
104</tr>
105<tr>
106 <td><a href="../test/test_range.cpp"><code>test_range.cpp</code></a></td>
107 <td>Exercises the <code>range</code> facility (ordered indices only).</td>
108</tr>
109<tr class="odd_tr">
110 <td><a href="../test/test_rank_ops.cpp"><code>test_rank_ops.cpp</code></a></td>
111 <td>Specific operations of ranked indices.</td>
112</tr>
113<tr>
114 <td><a href="../test/test_rearrange.cpp"><code>test_rearrange.cpp</code></a></td>
115 <td>Rearrange functions of sequenced and random access indices.</td>
116</tr>
117<tr class="odd_tr">
118 <td><a href="../test/test_safe_mode.cpp"><code>test_safe_mode.cpp</code></a></td>
119 <td>Comprehensive coverage of all conditions checked in safe mode.</td>
120</tr>
121<tr>
122 <td><a href="../test/test_serialization1.cpp"><code>test_serialization1.cpp</code></a><br>
123 <a href="../test/test_serialization2.cpp"><code>test_serialization2.cpp</code></a><br>
124 <a href="../test/test_serialization3.cpp"><code>test_serialization3.cpp</code></a></td>
125 <td>Serialization support.</td>
126</tr>
127<tr class="odd_tr">
128 <td><a href="../test/test_set_ops.cpp"><code>test_set_ops.cpp</code></a></td>
129 <td>Set-like operations particular to ordered indices.</td>
130</tr>
131<tr>
132 <td><a href="../test/test_special_set_ops.cpp"><code>test_special_set_ops.cpp</code></a></td>
133 <td>Checks special lookup operations using compatible sorting criteria.</td>
134</tr>
135<tr class="odd_tr">
136 <td><a href="../test/test_update.cpp"><code>test_update.cpp</code></a></td>
137 <td><code>replace</code>, <code>modify</code> and <code>modify_key</code>.</td>
138</tr>
139</table>
140</p>
141
142<hr>
143
144<div class="prev_link"><a href="examples.html"><img src="prev.gif" alt="examples" border="0"><br>
145Examples
146</a></div>
147<div class="up_link"><a href="index.html"><img src="up.gif" alt="index" border="0"><br>
148Index
149</a></div>
150<div class="next_link"><a href="future_work.html"><img src="next.gif" alt="future work" border="0"><br>
151Future work
152</a></div><br clear="all" style="clear: all;">
153
154<br>
155
156
157<p>Revised April 19th 2015</p>
158
159<p>&copy; Copyright 2003-2015 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
160Distributed under the Boost Software
161License, Version 1.0. (See accompanying file <a href="../../../LICENSE_1_0.txt">
162LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
163http://www.boost.org/LICENSE_1_0.txt</a>)
164</p>
165
166</body>
167</html>