Imported Upstream version 1.57.0
[platform/upstream/boost.git] / libs / bimap / doc / test_suite.qbk
1 [/license
2
3 Boost.Bimap
4
5 Copyright (c) 2006-2007 Matias Capeletto
6
7 Distributed under the Boost Software License, Version 1.0.
8 (See accompanying file LICENSE_1_0.txt or copy at
9 http://www.boost.org/LICENSE_1_0.txt)
10
11 ]
12
13 [/ QuickBook Document version 1.4 ]
14
15 [section Test suite]
16
17 The Boost.Bimap test suite exercises the whole spectrum of functionalities provided by the library.
18 Although the tests are not meant to serve as a learning guide, the interested reader may find it
19 useful to inspect the source code to gain familiarity with some of the least common features
20 offered by Boost.Bimap.
21
22 [table
23 [[Program                          ][Description                     ]
24 ]
25 [[[@../../test/test_tagged.cpp 
26     test_tagged.cpp                                                 ]]
27     [Tagged idiom checks                                            ]]
28
29 [[[@../../test/test_mutant.cpp 
30     test_mutant.cpp                                                 ]]
31     [Test the mutant idiom                                          ]]
32
33 [[[@../../test/test_structured_pair.cpp 
34     test_structured_pair.cpp                                        ]]
35     [Test structured pair class                                     ]]
36
37 [[[@../../test/test_mutant_relation.cpp 
38     test_mutant_relation.cpp                                        ]]
39     [Test the relation class                                        ]]
40
41 [[[@../../test/test_bimap_set_of.cpp 
42     test_bimap_set_of.cpp                                           ]]
43     [Library interface check                                        ]]
44
45 [[[@../../test/test_bimap_multiset_of.cpp 
46     test_bimap_multiset_of.cpp                                      ]]
47     [Library interface check                                        ]]
48
49 [[[@../../test/test_bimap_unordered_set_of.cpp 
50     test_bimap_unordered_set_of.cpp                                 ]]
51     [Library interface check                                        ]]
52
53 [[[@../../test/test_bimap_unordered_multiset_of.cpp
54     test_bimap_unordered_multiset_of.cpp                            ]]
55     [Library interface check                                        ]]
56
57 [[[@../../test/test_bimap_list_of.cpp 
58     test_bimap_list_of.cpp                                          ]]
59     [Library interface check                                        ]]
60
61 [[[@../../test/test_bimap_vector_of.cpp 
62     test_bimap_vector_of.cpp                                        ]]
63     [Library interface check                                        ]]
64
65 [[[@../../test/test_bimap_convenience_header.cpp 
66     test_bimap_convenience_header.cpp                               ]]
67     [Library interface check                                        ]]
68
69 [[[@../../test/test_bimap_ordered.cpp 
70     test_bimap_ordered.cpp                                          ]]
71     [Test set and multiset based bimaps                             ]]
72
73 [[[@../../test/test_bimap_unordered.cpp 
74     test_bimap_unordered.cpp                                        ]]
75     [Test unordered_set and unordered_multiset based bimaps         ]]
76
77 [[[@../../test/test_bimap_sequenced.cpp 
78     test_bimap_sequenced.cpp                                        ]]
79     [Test list and vector based bimaps                              ]]
80
81 [[[@../../test/test_bimap_unconstrained.cpp 
82     test_bimap_unconstrained.cpp                                    ]]
83     [Test bimaps with unconstrained views                           ]]
84
85 [[[@../../test/test_bimap_serialization.cpp 
86     test_bimap_serialization.cpp                                    ]]
87     [Serialization support checks                                   ]]
88
89 [[[@../../test/test_bimap_property_map.cpp 
90     test_bimap_property_map.cpp                                     ]]
91     [Property map concepts for the set and unordered set views      ]]
92
93 [[[@../../test/test_bimap_modify.cpp 
94     test_bimap_modify.cpp                                           ]]
95     [`replace`, `modify` and `operator[]`                           ]]
96
97 [[[@../../test/test_bimap_lambda.cpp 
98     test_bimap_lambda.cpp                                           ]]
99     [Test lambda modified idom support                              ]]
100
101 [[[@../../test/test_bimap_assign.cpp 
102     test_bimap_assign.cpp                                           ]]
103     [Test Boost.Assign support                                      ]]
104
105 [[[@../../test/test_bimap_project.cpp 
106     test_bimap_project.cpp                                          ]]
107     [Projection of iterators support                                ]]
108
109 [[[@../../test/test_bimap_operator_bracket.cpp 
110     test_bimap_operator_bracket.cpp                                 ]]
111     [`operator[]` and `at()` functions                              ]]
112
113 [[[@../../test/test_bimap_info.cpp 
114     test_bimap_info.cpp                                             ]]
115     [Information hooking support                                    ]]
116
117 [[[@../../test/test_bimap_extra.cpp 
118     test_bimap_extra.cpp                                            ]]
119     [Additional checks                                              ]]
120
121 [[[@../../test/compile_fail/test_bimap_info_1.cpp 
122     test_bimap_info_1.cpp                                           ]]
123     [Information hooking compilation fail test                      ]]
124
125 [[[@../../test/compile_fail/test_bimap_info_2.cpp 
126     test_bimap_info_2.cpp                                           ]]
127     [Information hooking compilation fail test                      ]]
128
129 [[[@../../test/compile_fail/test_bimap_info_3.cpp 
130     test_bimap_info_3.cpp                                           ]]
131     [Information hooking compilation fail test                      ]]
132
133 [[[@../../test/compile_fail/test_bimap_mutable_1.cpp 
134     test_bimap_mutable_1.cpp                                        ]]
135     [Mutable members compilation fail test                          ]]
136
137 [[[@../../test/compile_fail/test_bimap_mutable_2.cpp 
138     test_bimap_mutable_2.cpp                                        ]]
139     [Mutable members compilation fail test                          ]]
140
141 [[[@../../test/compile_fail/test_bimap_mutable_3.cpp 
142     test_bimap_mutable_3.cpp                                        ]]
143     [Mutable members compilation fail test                          ]]
144
145 ]
146
147 [endsect]