1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
5 <link href="style.css" rel="stylesheet" type="text/css">
8 <body bgcolor="#ffffff">
12 <p>Most of the requirements on containers are presented in the ISO standard
13 in the form of tables. In order to avoid massive duplication of effort
14 while documenting all the classes, we follow the standard's lead and
15 present the base information here. Individual classes will only document
16 their departures from these tables (removed functions, additional functions,
20 <p>We will not try to duplicate all of the surrounding text (footnotes,
21 explanations, etc) from the standard, because that would also entail a
22 duplication of effort. Some of the surrounding text has been paraphrased
23 here for clarity. If you are uncertain about the meaning or interpretation
24 of these notes, consult a good textbook, and/or purchase your own copy of
25 the standard (it's cheap, see our FAQ).
28 <p>The table numbers are the same as those used in the standard. Tables can
29 be jumped to using their number, e.g., "tables.html#67". Only
30 Tables 65 through 69 are presented. Some of the active Defect Reports
31 are also noted or incorporated.
37 <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3"
38 cols="5" title="Table 65">
39 <caption><h2>Table 65 --- Container Requirements</h2></caption>
41 Anything calling itself a container must meet these minimum requirements.
44 <td><strong>expression</strong></td>
45 <td><strong>result type</strong></td>
46 <td><strong>operational semantics</strong></td>
47 <td><strong>notes, pre-/post-conditions, assertions</strong></td>
48 <td><strong>complexity</strong></td>
52 <td>X::value_type</td>
55 <td>T is Assignable</td>
68 <td>X::const_reference</td>
69 <td>const lvalue of T</td>
77 <td>iterator type pointing to T</td>
79 <td>Any iterator category except output iterator.
80 Convertible to X::const_iterator.</td>
85 <td>X::const_iterator</td>
86 <td>iterator type pointing to const T</td>
88 <td>Any iterator category except output iterator.</td>
93 <td>X::difference_type</td>
94 <td>signed integral type</td>
96 <td>identical to the difference type of X::iterator and X::const_iterator</td>
101 <td>X::size_type</td>
102 <td>unsigned integral type</td>
104 <td>size_type can represent any non-negative value of difference_type</td>
105 <td>compile time</td>
112 <td>post: u.size() == 0</td>
120 <td>X().size == 0</td>
133 <td>X u(a);<br />X u = a;</td>
136 <td>post: u == a. Equivalent to: X u; u = a;</td>
141 <td>(&a)->~X();</td>
144 <td>dtor is applied to every element of a; all the memory is deallocated</td>
150 <td>iterator; const_iterator for constant a</td>
158 <td>iterator; const_iterator for constant a</td>
166 <td>convertible to bool</td>
168 <td>== is an equivalence relation. a.size()==b.size() &&
169 equal(a.begin(),a.end(),b.begin())</td>
175 <td>convertible to bool</td>
177 <td>equivalent to !(a==b)</td>
186 <td>may or may not have constant complexity</td>
197 <!-- a fifth column, "operation semantics," magically appears in the table
198 at this point... wtf? -->
202 <td>a.end() - a.begin()</td>
204 <td>may or may not have constant complexity</td>
208 <td>a.max_size()</td>
210 <td>size() of the largest possible container</td>
212 <td>may or may not have constant complexity</td>
217 <td>convertible to bool</td>
218 <td>a.size() == 0</td>
225 <td>convertible to bool</td>
226 <td>lexographical_compare( a.begin, a.end(), b.begin(), b.end())</td>
227 <td>pre: < is defined for T and is a total ordering relation</td>
233 <td>convertible to bool</td>
241 <td>convertible to bool</td>
249 <td>convertible to bool</td>
254 </table title="Table 65"></p></a>
258 <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3"
259 cols="4" title="Table 66">
260 <caption><h2>Table 66 --- Reversible Container Requirements</h2></caption>
262 If a container's iterator is bidirectional or random-access, then the
263 container also meets these requirements.
264 Deque, list, vector, map, multimap, set, and multiset are such containers.
267 <td><strong>expression</strong></td>
268 <td><strong>result type</strong></td>
269 <td><strong>notes, pre-/post-conditions, assertions</strong></td>
270 <td><strong>complexity</strong></td>
274 <td>X::reverse_iterator</td>
275 <td>iterator type pointing to T</td>
276 <td>reverse_iterator<iterator></td>
277 <td>compile time</td>
281 <td>X::const_reverse_iterator</td>
282 <td>iterator type pointing to const T</td>
283 <td>reverse_iterator<const_iterator></td>
284 <td>compile time</td>
289 <td>reverse_iterator; const_reverse_iterator for constant a</td>
290 <td>reverse_iterator(end())</td>
296 <td>reverse_iterator; const_reverse_iterator for constant a</td>
297 <td>reverse_iterator(begin())</td>
300 </table title="Table 66"></p></a>
304 <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3"
305 cols="3" title="Table 67">
306 <caption><h2>Table 67 --- Sequence Requirements</h2></caption>
308 These are in addition to the requirements of <a href="#65">containers</a>.
309 Deque, list, and vector are such containers.
312 <td><strong>expression</strong></td>
313 <td><strong>result type</strong></td>
314 <td><strong>notes, pre-/post-conditions, assertions</strong></td>
318 <td>X(n,t)<br />X a(n,t)</td>
320 <td>constructs a sequence with n copies of t<br />post: size() == n</td>
324 <td>X(i,j)<br />X a(i,j)</td>
326 <td>constructs a sequence equal to the range [i,j)<br />
327 post: size() == distance(i,j)</td>
331 <td>a.insert(p,t)</td>
332 <td>iterator (points to the inserted copy of t)</td>
333 <td>inserts a copy of t before p</td>
337 <td>a.insert(p,n,t)</td>
339 <td>inserts n copies of t before p</td>
343 <td>a.insert(p,i,j)</td>
345 <td>inserts copies of elements in [i,j) before p<br />
346 pre: i, j are not iterators into a</td>
351 <td>iterator (points to the element following q (prior to erasure))</td>
352 <td>erases the element pointed to by q</td>
356 <td>a.erase(q1,q1)</td>
357 <td>iterator (points to the element pointed to by q2 (prior to erasure))</td>
358 <td>erases the elements in the range [q1,q2)</td>
364 <td>erase(begin(),end())<br />post: size() == 0</td>
366 </table title="Table 67"></p></a>
370 <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3"
371 cols="4" title="Table 68">
372 <caption><h2>Table 68 --- Optional Sequence Operations</h2></caption>
374 These operations are only included in containers when the operation can be
375 done in constant time.
378 <td><strong>expression</strong></td>
379 <td><strong>result type</strong></td>
380 <td><strong>operational semantics</strong></td>
381 <td><strong>container</strong></td>
386 <td>reference; const_reference for constant a</td>
388 <td>vector, list, deque</td>
393 <td>reference; const_reference for constant a</td>
395 <td>vector, list, deque</td>
399 <td>a.push_front(x)</td>
401 <td>a.insert(a.begin(),x)</td>
406 <td>a.push_back(x)</td>
408 <td>a.insert(a.end(),x)</td>
409 <td>vector, list, deque</td>
413 <td>a.pop_front()</td>
415 <td>a.erase(a.begin())</td>
420 <td>a.pop_back()</td>
422 <td>a.erase(--a.end())</td>
423 <td>vector, list, deque</td>
428 <td>reference; const_reference for constant a</td>
429 <td>*(a.begin() + n)</td>
430 <td>vector, deque</td>
435 <td>reference; const_reference for constant a</td>
436 <td>*(a.begin() + n)<br />throws out_of_range if n>=a.size()</td>
437 <td>vector, deque</td>
439 </table title="Table 68"></p></a>
443 <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3"
444 cols="4" title="Table 69">
445 <caption><h2>Table 69 --- Associative Container Requirements</h2></caption>
447 These are in addition to the requirements of <a href="#65">containers</a>.
448 Map, multimap, set, and multiset are such containers. An associative
449 container supports <em>unique keys</em> (and is written as
450 <code>a_uniq</code> instead of <code>a</code>) if it may contain at most
451 one element for each key. Otherwise it supports <em>equivalent keys</em>
452 (and is written <code>a_eq</code>). Examples of the former are set and map,
453 examples of the latter are multiset and multimap.
456 <td><strong>expression</strong></td>
457 <td><strong>result type</strong></td>
458 <td><strong>notes, pre-/post-conditions, assertions</strong></td>
459 <td><strong>complexity</strong></td>
465 <td>Key is Assignable</td>
466 <td>compile time</td>
470 <td>X::key_compare</td>
472 <td>defaults to less<key_type></td>
473 <td>compile time</td>
477 <td>X::value_compare</td>
478 <td>a binary predicate type</td>
479 <td>same as key_compare for set and multiset; an ordering relation on
480 pairs induced by the first component (Key) for map and multimap</td>
481 <td>compile time</td>
485 <td>X(c)<br />X a(c)</td>
487 <td>constructs an empty container which uses c as a comparison object</td>
492 <td>X()<br />X a</td>
494 <td>constructs an empty container using Compare() as a comparison object</td>
499 <td>X(i,j,c)<br />X a(i,j,c)</td>
501 <td>constructs an empty container and inserts elements from the range [i,j)
502 into it; uses c as a comparison object</td>
503 <td>NlogN in general where N is distance(i,j); linear if [i,j) is
504 sorted with value_comp()</td>
508 <td>X(i,j)<br />X a(i,j)</td>
510 <td>same as previous, but uses Compare() as a comparison object</td>
511 <td>same as previous</td>
515 <td>a.key_comp()</td>
516 <td>X::key_compare</td>
517 <td>returns the comparison object out of which a was constructed</td>
522 <td>a.value_comp()</td>
523 <td>X::value_compare</td>
524 <td>returns an object constructed out of the comparison object</td>
529 <td>a_uniq.insert(t)</td>
530 <td>pair<iterator,bool></td>
531 <td>"Inserts t if and only if there is no element in the container with
532 key equivalent to the key of t. The bool component of the returned pair
533 is true -iff- the insertion took place, and the iterator component of
534 the pair points to the element with key equivalent to the key of
535 t."</td> <!-- DR 316 -->
540 <td>a_eq.insert(t)</td>
542 <td>inserts t, returns the iterator pointing to the inserted element</td>
547 <td>a.insert(p,t)</td>
549 <td>possibly inserts t (depending on whether a_uniq or a_eq); returns iterator
550 pointing to the element with key equivalent to the key of t; iterator p
551 is a hint pointing to where the insert should start to search</td>
552 <td>logarithmic in general, amortized constant if t is inserted right
554 <strong>[but see DR 233 and <a href="
555 http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4">our
556 specific notes</a>]</strong></td>
560 <td>a.insert(i,j)</td>
562 <td>pre: i, j are not iterators into a. possibly inserts each element from
563 the range [i,j) (depending on whether a_uniq or a_eq)</td>
564 <td>Nlog(size()+N) where N is distance(i,j) in general</td> <!-- DR 264 -->
570 <td>erases all elements with key equivalent to k; returns number of erased
572 <td>log(size()) + count(k)</td>
578 <td>erases the element pointed to by q</td>
579 <td>amortized constant</td>
583 <td>a.erase(q1,q2)</td>
585 <td>erases all the elements in the range [q1,q2)</td>
586 <td>log(size()) + distance(q1,q2)</td>
592 <td>erases everthing; post: size() == 0</td>
593 <td>linear</td> <!-- DR 224 -->
598 <td>iterator; const_iterator for constant a</td>
599 <td>returns iterator pointing to element with key equivalent to k, or
600 a.end() if no such element found</td>
607 <td>returns number of elements with key equivalent to k</td>
608 <td>log(size()) + count(k)</td>
612 <td>a.lower_bound(k)</td>
613 <td>iterator; const_iterator for constant a</td>
614 <td>returns iterator pointing to the first element with key not less than k</td>
619 <td>a.upper_bound(k)</td>
620 <td>iterator; const_iterator for constant a</td>
621 <td>returns iterator pointing to the first element with key greater than k</td>
626 <td>a.equal_range(k)</td>
627 <td>pair<iterator,iterator>;
628 pair<const_iterator, const_iterator> for constant a</td>
629 <td>equivalent to make_pair(a.lower_bound(k), a.upper_bound(k))</td>
632 </table title="Table 69"></p></a>
636 <p class="smallertext"><em>
637 See <a href="mainpage.html">mainpage.html</a> for copying conditions.
638 See <a href="http://gcc.gnu.org/libstdc++/">the libstdc++-v3 homepage</a>
639 for more information.
projects / l4.git / blob