File: reference.htm

package info (click to toggle)
boost 1.27.0-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 19,908 kB
  • ctags: 26,546
  • sloc: cpp: 122,225; ansic: 10,956; python: 4,412; sh: 855; yacc: 803; makefile: 257; perl: 165; lex: 90; csh: 6
file content (305 lines) | stat: -rw-r--r-- 10,836 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<HTML>
<!--
  -- Copyright (c) Jeremy Siek and Andrew Lumsdaine 2000
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  We make no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  -->
<Head>
<Title>Boost Concept Checking Reference</Title>
</Head>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
        ALINK="#ff0000"> 
<IMG SRC="../../c++boost.gif" 
     ALT="C++ Boost" width="277" height="86"> 

<BR Clear>

<h2><a name="reference">Reference</a></h2>

  <OL>
  <LI><a href="#functions">Functions</a></LI>
  <LI><a href="#macros">Macros</a></LI>
  <LI><a href="#basic-concepts">Basic Concept Checking Classes</a></LI>
  <LI><a href="#iterator-concepts">Iterator Concept Checking Classes</a></LI>
  <LI><a href="#function-object-concepts">Function Object Concept Checking Classes</a></LI>
  <LI><a href="#container-concepts">Container Concept Checking Classes</a></LI>
  <LI><a href="#basic-archetype">Basic Archetype Classes</a></LI>
  <LI><a href="#iterator-archetype">Iterator Archetype Classes</a></LI>
  <LI><a href="#function-object-archetype">Function Object Archetype Classes</a></LI>
  <LI><a href="#container-archetype">Container Archetype Classes</a></LI>
  </OL>

<h3><a name="functions">Functions</a></h3>

<pre>
  template &lt;class Concept&gt;
  void function_requires();
</pre>

<h3><a name="macros">Macros</a></h3>

<pre>
  // Apply concept checks in class definitions.
  BOOST_CLASS_REQUIRES(<i>type</i>, <i>concept</i>);
  BOOST_CLASS_REQUIRES2(<i>type1</i>, <i>type2</i>, <i>concept</i>);
  BOOST_CLASS_REQUIRES3(<i>type1</i>, <i>type2</i>, <i>type3</i>, <i>concept</i>);
  BOOST_CLASS_REQUIRES4(<i>type1</i>, <i>type2</i>, <i>type3</i>, <i>type4</i>, <i>concept</i>);
</pre>


<h3><a name="basic-concepts">Basic Concept Checking Classes</a></h3>

<pre>
  template &lt;class T&gt;
  struct IntegerConcept; // Is T a built-in integer type?

  template &lt;class T&gt;
  struct SignedIntegerConcept; // Is T a built-in signed integer type?

  template &lt;class T&gt;
  struct UnsignedIntegerConcept; // Is T a built-in unsigned integer type?

  template &lt;class X, class Y&gt;
  struct ConvertibleConcept; // Is X convertible to Y?

  template &lt;class T&gt;
  struct <a href="../utility/Assignable.html">Assignable</a>Concept; // Standard ref 23.1

  template &lt;class T&gt;
  struct SGI<a href="http://www.sgi.com/tech/stl/Assignable.html">Assignable</a>Concept;

  template &lt;class T&gt;
  struct <a
  href="http://www.sgi.com/tech/stl/DefaultConstructible.html">DefaultConstructible</a>Concept;

  template &lt;class T&gt; 
  struct <a href="../utility/CopyConstructible.html">CopyConstructible</a>Concept; // Standard ref 20.1.3

  template &lt;class T&gt; 
  struct <a href="http://www.sgi.com/tech/stl/EqualityComparable.html">EqualityComparable</a>Concept; // Standard ref 20.1.1

  template &lt;class T&gt;
  struct <a href="../utility/LessThanComparable.html">LessThanComparable</a>Concept; // Standard ref 20.1.2

  template &lt;class T&gt;
  struct ComparableConcept; // The SGI STL <a href="http://www.sgi.com/tech/stl/LessThanComparable.html">LessThanComparable</a> concept
</pre>

<h3><a name="iterator-concepts">Iterator Concept Checking Classes</a></h3>

<pre>
  template &lt;class Iter&gt;
  struct <a href="http://www.sgi.com/tech/stl/trivial.html">TrivialIterator</a>Concept;

  template &lt;class Iter&gt;
  struct Mutable_TrivialIteratorConcept;

  template &lt;class Iter&gt;
  struct <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>Concept; // Standard ref 24.1.1 Table 72

  template &lt;class Iter, class T&gt; 
  struct <a href="http://www.sgi.com/tech/stl/OutputIterator.html">OutputIterator</a>Concept; // Standard ref 24.1.2 Table 73

  template &lt;class Iter&gt; 
  struct <a href="http://www.sgi.com/tech/stl/ForwardIterator.html">ForwardIterator</a>Concept; // Standard ref 24.1.3 Table 74

  template &lt;class Iter&gt; 
  struct Mutable_ForwardIteratorConcept;

  template &lt;class Iter&gt; 
  struct <a href="http://www.sgi.com/tech/stl/BidirectionalIterator.html">BidirectionalIterator</a>Concept; // Standard ref 24.1.4 Table 75

  template &lt;class Iter&gt; 
  struct Mutable_BidirectionalIteratorConcept;

  template &lt;class Iter&gt; 
  struct <a href="http://www.sgi.com/tech/stl/RandomAccessIterator.html">RandomAccessIterator</a>Concept; // Standard ref 24.1.5 Table 76

  template &lt;class Iter&gt; 
  struct Mutable_RandomAccessIteratorConcept;
</pre>

<h3><a name="function-object-concepts">Function Object Concept Checking Classes</a></h3>

<pre>
  template &lt;class Func, class Return&gt;
  struct <a href="http://www.sgi.com/tech/stl/Generator.html">Generator</a>Concept;

  template &lt;class Func, class Return, class Arg&gt;
  struct <a href="http://www.sgi.com/tech/stl/UnaryFunction.html">UnaryFunction</a>Concept;

  template &lt;class Func, class Return, class First, class Second&gt;
  struct <a href="http://www.sgi.com/tech/stl/BinaryFunction.html">BinaryFunction</a>Concept;

  template &lt;class Func, class Arg&gt;
  struct Unary<a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>Concept;

  template &lt;class Func, class First, class Second&gt;
  struct <a href="http://www.sgi.com/tech/stl/BinaryPredicate.html">BinaryPredicate</a>Concept;

  template &lt;class Func, class First, class Second&gt;
  struct Const_BinaryPredicateConcept;

  template &lt;class Func, class Return&gt;
  struct <a href="http://www.sgi.com/tech/stl/AdaptableGenerator.html">AdaptableGenerator</a>Concept;

  template &lt;class Func, class Return, class Arg&gt;
  struct <a href="http://www.sgi.com/tech/stl/AdaptableUnaryFunction.html">AdaptableUnaryFunction</a>Concept;

  template &lt;class Func, class First, class Second&gt;
  struct <a href="http://www.sgi.com/tech/stl/AdaptableBinaryFunction.html">AdaptableBinaryFunction</a>Concept;

  template &lt;class Func, class Arg&gt;
  struct <a href="http://www.sgi.com/tech/stl/AdaptablePredicate.html">AdaptablePredicate</a>Concept;

  template &lt;class Func, class First, class Second&gt;
  struct <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">AdaptableBinaryPredicate</a>Concept;
  
</pre>

<h3><a name="container-concepts">Container Concept Checking Classes</a></h3>

<pre>
  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/Container.html">Container</a>Concept; // Standard ref 23.1 Table 65

  template &lt;class C&gt;
  struct Mutable_ContainerConcept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/ForwardContainer.html">ForwardContainer</a>Concept;

  template &lt;class C&gt;
  struct Mutable_ForwardContainerConcept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/ReversibleContainer.html">ReversibleContainer</a>Concept; // Standard ref 23.1 Table 66

  template &lt;class C&gt;
  struct Mutable_ReversibleContainerConcept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">RandomAccessContainer</a>Concept;

  template &lt;class C&gt;
  struct Mutable_RandomAccessContainerConcept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/SequenceContainer.html">Sequence</a>Concept; // Standard ref 23.1.1

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/FrontInsertionSequence.html">FrontInsertionSequence</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/BackInsertionSequence.html">BackInsertionSequence</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/Associative.html">AssociativeContainer</a>Concept; // Standard ref 23.1.2 Table 69

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/UniqueAssociativeContainer.html">UniqueAssociativeContainer</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/MultipleAssociativeContainer.html">MultipleAssociativeContainer</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/SimpleAssociativeContainer.html">SimpleAssociativeContainer</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/PairAssociativeContainer.html">PairAssociativeContainer</a>Concept;

  template &lt;class C&gt;
  struct <a href="http://www.sgi.com/tech/stl/SortedAssociativeContainer.html">SortedAssociativeContainer</a>Concept;
</pre>


<h3><a name="basic-archetype">Basic Archetype Classes</a></h3>

<pre>
  template &lt;class T = int&gt;
  class null_archetype; // A type that models no concepts.

  template &lt;class Base = null_archetype&gt;
  class default_constructible_archetype;

  template &lt;class Base = null_archetype&gt;
  class assignable_archetype;

  template &lt;class Base = null_archetype&gt;
  class copy_constructible_archetype;

  template &lt;class Base = null_archetype&gt;
  class equality_comparable_archetype;

  template &lt;class T, class Base = null_archetype&gt;
  class convertible_to_archetype;
</pre>

<h3><a name="iterator-archetype">Iterator Archetype Classes</a></h3>

<pre>
  template &lt;class ValueType&gt;
  class trivial_iterator_archetype;

  template &lt;class ValueType&gt;
  class mutable_trivial_iterator_archetype;

  template &lt;class ValueType&gt;
  class input_iterator_archetype;

  template &lt;class ValueType&gt;
  class forward_iterator_archetype;

  template &lt;class ValueType&gt;
  class bidirectional_iterator_archetype;

  template &lt;class ValueType&gt;
  class random_access_iterator_archetype;

</pre>

<h3><a name="function-object-archetype">Function Object Archetype Classes</a></h3>

<pre>
  template &lt;class Arg, class Return&gt;
  class unary_function_archetype;

  template &lt;class Arg1, class Arg2, class Return&gt;
  class binary_function_archetype;

  template &lt;class Arg&gt;
  class predicate_archetype;

  template &lt;class Arg1, class Arg2&gt;
  class binary_predicate_archetype;
</pre>

<h3><a name="container-archetype">Container Archetype Classes</a></h3>

<pre>
UNDER CONSTRUCTION
</pre>

<p>
<a href="./concept_check.htm">Back to Introduction</a>
<br>
<a href="./implementation.htm">Prev: Implementation</a>

<br>
<HR>
<TABLE>
<TR valign=top>
<TD nowrap>Copyright &copy 2000</TD><TD>
<A HREF="../../people/jeremy_siek.htm">Jeremy Siek</A>,
Univ.of Notre Dame (<A
HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)
</TD></TR></TABLE>

</BODY>
</HTML>