diff options
author | Phil Edwards <pme@gcc.gnu.org> | 2002-03-27 21:41:36 +0000 |
---|---|---|
committer | Phil Edwards <pme@gcc.gnu.org> | 2002-03-27 21:41:36 +0000 |
commit | 04b7c941e90c9f6df2c35121b36264941ec28dd5 (patch) | |
tree | 0e3d7dd60cff63506900f69b03ab54b8c380f073 /libstdc++-v3/docs | |
parent | 8a12f34cfca8cfcd5c7e5904ab283c73565e8be6 (diff) | |
download | gcc-04b7c941e90c9f6df2c35121b36264941ec28dd5.zip gcc-04b7c941e90c9f6df2c35121b36264941ec28dd5.tar.gz gcc-04b7c941e90c9f6df2c35121b36264941ec28dd5.tar.bz2 |
Intro.3: Date tweak.
2002-03-27 Phil Edwards <pme@gcc.gnu.org>
* docs/doxygen/Intro.3: Date tweak.
* docs/doxygen/TODO: Update.
* docs/doxygen/doxygroups.cc: Point to tables.html.
* docs/doxygen/mainpage.html: Date tweak.
* docs/doxygen/run_doxygen: Version tweak. Copy tables.html over.
* docs/doxygen/tables.html: Fill in the blanks.
* docs/doxygen/user.cfg.in (ALIASES): Remove maint and endmaint.
* include/bits/stl_algo.h: Likewise; use expanded form.
* include/bits/stl_alloc.h: Likewise.
* include/bits/stl_construct.h: Likewise.
* include/bits/stl_deque.h: Likewise.
* include/bits/stl_iterator_base_types.h: Likewise.
* include/bits/stl_list.h: Likewise.
* include/bits/stl_relops.h: Likewise.
* include/bits/stl_tempbuf.h: Likewise.
* include/bits/stl_vector.h: Likewise.
* include/std/std_memory.h: Likewise.
* include/bits/stl_deque.h: Point into tables.html and add @ingroup.
* include/bits/stl_list.h: Likewise.
* include/bits/stl_vector.h: Likewise.
From-SVN: r51471
Diffstat (limited to 'libstdc++-v3/docs')
-rw-r--r-- | libstdc++-v3/docs/doxygen/Intro.3 | 4 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/TODO | 6 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/doxygroups.cc | 16 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/mainpage.html | 10 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/run_doxygen | 7 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/tables.html | 576 | ||||
-rw-r--r-- | libstdc++-v3/docs/doxygen/user.cfg.in | 4 |
7 files changed, 502 insertions, 121 deletions
diff --git a/libstdc++-v3/docs/doxygen/Intro.3 b/libstdc++-v3/docs/doxygen/Intro.3 index 3e963aa..fc44025 100644 --- a/libstdc++-v3/docs/doxygen/Intro.3 +++ b/libstdc++-v3/docs/doxygen/Intro.3 @@ -1,6 +1,6 @@ .\" t .\" This man page is released under the FDL as part of libstdc++-v3. -.TH Intro 3 "27 September 2001" "GNU libstdc++-v3" "Standard C++ Library" +.TH Intro 3 "27 March 2002" "GNU libstdc++-v3" "Standard C++ Library" .SH NAME Intro \- Introduction to the GNU libstdc++-v3 man pages .SH DESCRIPTION @@ -48,7 +48,7 @@ SGIextensions A list of the extensions from the SGI STL subset. Sequences Linear containers. .TE .P -The HTML documentation goes into more depth. +The HTML documentation typically goes into much more depth. .SH FILES Lots! .SS Standard Headers diff --git a/libstdc++-v3/docs/doxygen/TODO b/libstdc++-v3/docs/doxygen/TODO index 375cd5f..6629933 100644 --- a/libstdc++-v3/docs/doxygen/TODO +++ b/libstdc++-v3/docs/doxygen/TODO @@ -48,10 +48,10 @@ do not have the C code (to which the doxygen comments would be attached), this would need to be done in entirely separate files, a la doxygroups.cc. B) Huge chunks of containers and strings are described in common "Tables" -in the standard. These are being pseudo-duplicated in tables.html. We can +in the standard. These are pseudo-duplicated in tables.html. We can use doxygen hooks like @pre and @see to reference the tables. Then the -individual classes would do like the standard does, and only document -members for which additional info is available. +individual classes do like the standard does, and only document members for +which additional info is available. STYLE: diff --git a/libstdc++-v3/docs/doxygen/doxygroups.cc b/libstdc++-v3/docs/doxygen/doxygroups.cc index 8af04b1..c6139f3 100644 --- a/libstdc++-v3/docs/doxygen/doxygroups.cc +++ b/libstdc++-v3/docs/doxygen/doxygroups.cc @@ -1,5 +1,8 @@ /* + Copyright (C) 2001, 2002 Free Software Foundation, Inc. + See license.html for license. + This just provides documentation for stuff that doesn't need to be in the source headers themselves. It is a ".cc" file for the sole cheesy reason that it triggers many different text editors into doing Nice Things when @@ -67,9 +70,8 @@ storing your objects. The objects are destroyed when the container is itself destroyed. Note that if you are storing pointers in a container, @c delete is @e not automatically called on the pointers before destroying them. -All containers must meet certain requirements. They would be listed here -except I'm not certain how much of 14882 can be reproduced without a -copyright violation. Reproducing Tables 65 through 69 is a lot of typing... +All containers must meet certain requirements, summarized in +<a href="tables.html">tables</a>. The standard containers are further refined into @link Sequences Sequences@endlink and @@ -92,6 +94,9 @@ the second category of differences, algorithmic complexity. For example, if you need to perform many inserts and removals from the middle of a sequence, @c list would be ideal. But if you need to perform constant-time access to random elements of the sequence, then @c list should not be used. + +All sequences must meet certain requirements, summarized in +<a href="tables.html">tables</a>. */ /** @addtogroup Assoc_containers Associative Containers @@ -99,6 +104,11 @@ Associative containers allow fast retrieval of data based on keys. Each container type is parameterized on a @c Key type, and an ordering relation used to sort the elements of the container. + +There should be more text here. + +All associative containers must meet certain requirements, summarized in +<a href="tables.html">tables</a>. */ // // // // // // // // // // // // // // // // // // // // // // // // diff --git a/libstdc++-v3/docs/doxygen/mainpage.html b/libstdc++-v3/docs/doxygen/mainpage.html index 88ea279..431344b 100644 --- a/libstdc++-v3/docs/doxygen/mainpage.html +++ b/libstdc++-v3/docs/doxygen/mainpage.html @@ -16,16 +16,16 @@ directly; it all gets run through Doxygen and re-output.) So lots of tags were all being mangled. - Funk 'dat. Now we let Doxygen do whateer it feels like doing for the + Funk 'dat. Now we let Doxygen do whatever it feels like doing for the index page, and then we just flat copy this over top of it. Voila! - Tags actually work like they're supposed to. + Tags actually work like they're supposed to in HTML. --> <h1>libstdc++-v3 Source Documentation</h1> <h2> Documentation Overview </h2> -<p class="smallertext">Generated 2002-02-08.</p> +<p class="smallertext">Generated 2002-03-27.</p> <p>There are two types of documentation for libstdc++-v3. One is the distribution documentation, which can be read online at @@ -122,8 +122,8 @@ href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>. Hewlett-Packard Company </blockquote> </p> -<p>Part of the generated documentation is quoted from the C++ standard, which - is copyright 1998 by Information Technology Industry Council. +<p>Part of the generated documentation is quoted from the ISO C++ Standard, + which is Copyright © 1998 by Information Technology Industry Council. </p> </body> diff --git a/libstdc++-v3/docs/doxygen/run_doxygen b/libstdc++-v3/docs/doxygen/run_doxygen index e93c947..7b3b7f5 100644 --- a/libstdc++-v3/docs/doxygen/run_doxygen +++ b/libstdc++-v3/docs/doxygen/run_doxygen @@ -1,6 +1,7 @@ #!/bin/sh # Runs doxygen and massages the output files. +# Copyright (C) 2001, 2002 Free Software Foundation, Inc. # # Synopsis: run_doxygen --mode=[user|maint|man] v3srcdir v3builddir # @@ -8,7 +9,7 @@ # We can check now that the version of doxygen is >= this variable. -DOXYVER=1.2.12 +DOXYVER=1.2.14 doxygen= find_doxygen() { @@ -147,6 +148,7 @@ set +e test $do_html = yes && { cp ${srcdir}/docs/doxygen/mainpage.html ${outdir}/html_${mode}/index.html + cp ${srcdir}/docs/doxygen/tables.html ${outdir}/html_${mode}/tables.html echo :: echo :: HTML pages begin with echo :: ${outdir}/html_${mode}/index.html @@ -185,7 +187,8 @@ mv iterator_tags.3 Iterator_types.3 find . -name "[a-z]*" -a ! -name "std_*" -print | xargs rm rm -f *.h.3 *config* *.cc.3 *.tcc.3 rm -f *_t.3 # workaround doxygen template parsing bug for now -#mkdir trash # this is used to examine what we would have deleted +# this is used to examine what we would have deleted, for debugging +#mkdir trash #find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash #mv *.h.3 *config* *.cc.3 *.tcc.3 *_t.3 trash diff --git a/libstdc++-v3/docs/doxygen/tables.html b/libstdc++-v3/docs/doxygen/tables.html index d38e461..2382d25 100644 --- a/libstdc++-v3/docs/doxygen/tables.html +++ b/libstdc++-v3/docs/doxygen/tables.html @@ -6,27 +6,40 @@ </head> <body bgcolor="#ffffff"> -<!-- - Tables can be jumped to with their number, e.g., "tables.html#67". ---> <h1>Tables</h1> <p>Most of the requirements on containers are presented in the ISO standard - in the form of tables. In order to avoid massive duplication of effort, - we follow the standard's lead and present the information here. - Individual classes will only document their departures from these tables - (removed functions, additional functions, changes, etc). + in the form of tables. In order to avoid massive duplication of effort + while documenting all the classes, we follow the standard's lead and + present the base information here. Individual classes will only document + their departures from these tables (removed functions, additional functions, + changes, etc). </p> -<p>The numbers are the same as those used in the standard. +<p>We will not try to duplicate all of the surrounding text (footnotes, + explanations, etc) from the standard, because that would also entail a + duplication of effort. Some of the surrounding text has been paraphrased + here for clarity. If you are uncertain about the meaning or interpretation + of these notes, consult a good textbook, and/or purchase your own copy of + the standard (it's cheap, see our FAQ). </p> +<p>The table numbers are the same as those used in the standard. Tables can + be jumped to using their number, e.g., "tables.html#67". Only + Tables 65 through 69 are presented. Some of the active Defect Reports + are also noted or incorporated. +</p> + +<p class="smallertext">This will probably be incomplete for a while because +filling out the tables is mind-frothingly boring. Also, the HTML table +rendering is ugly. (Update: mozilla 0.9.9 looks MUCH better.)</p> + <hr /> <a name="65"><p> <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3" - cols="3" title="Table 65"> + cols="4" title="Table 65"> <caption><h2>Table 65 --- Container Requirements</h2></caption> <tr><th colspan="4"> Anything calling itself a container must meet these minimum requirements. @@ -34,82 +47,240 @@ Anything calling itself a container must meet these minimum requirements. <tr> <td><strong>expression</strong></td> <td><strong>result type</strong></td> -<td><strong>notes</strong></td> +<td><strong>notes, pre-/post-conditions, assertions</strong></td> <td><strong>complexity</strong></td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>X::value_type</td> +<td>T</td> +<td>T is Assignable</td> +<td>compile time</td> +</tr> + +<tr> +<td>X::reference</td> +<td>lvalue of T</td> +<td> </td> +<td>compile time</td> +</tr> + +<tr> +<td>X::const_reference</td> +<td>const lvalue of T</td> +<td> </td> +<td>compile time</td> +</tr> + +<tr> +<td>X::iterator</td> +<td>iterator type pointing to T</td> +<td>Any iterator category except output iterator. + Convertible to X::const_iterator.</td> +<td>compile time</td> +</tr> + +<tr> +<td>X::const_iterator</td> +<td>iterator type pointing to const T</td> +<td>Any iterator category except output iterator.</td> +<td>compile time</td> +</tr> + +<tr> +<td>X::difference_type</td> +<td>signed integral type</td> +<td>identical to the difference type of X::iterator and X::const_iterator</td> +<td>compile time</td> +</tr> + +<tr> +<td>X::size_type</td> +<td>unsigned integral type</td> +<td>size_type can represent any non-negative value of difference_type</td> +<td>compile time</td> +</tr> + +<tr> +<td>X u;</td> +<td> </td> +<td>post: u.size() == 0</td> +<td>constant</td> +</tr> + +<tr> +<td>X();</td> +<td> </td> +<td>X().size == 0</td> +<td>constant</td> +</tr> + +<tr> +<td>X(a);</td> +<td> </td> +<td>a == X(a)</td> +<td>linear</td> +</tr> + +<tr> +<td>X u(a);<br />X u = a;</td> +<td> </td> +<td>post: u == a. Equivalent to: X u; u = a;</td> +<td>linear</td> +</tr> + +<tr> +<td>(&a)->~X();</td> +<td>void</td> +<td>dtor is applied to every element of a; all the memory is deallocated</td> +<td>linear</td> +</tr> + +<tr> +<td>a.begin()</td> +<td>iterator; const_iterator for constant a</td> +<td> </td> +<td>constant</td> +</tr> + +<tr> +<td>a.end()</td> +<td>iterator; const_iterator for constant a</td> +<td> </td> +<td>constant</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a == b</td> +<td>convertible to bool</td> +<td>== is an equivalence relation. a.size()==b.size() && + equal(a.begin(),a.end(),b.begin())</td> +<td>linear</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a != b</td> +<td>convertible to bool</td> +<td>equivalent to !(a==b)</td> +<td>linear</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.swap(b)</td> +<td>void</td> +<td>swap(a,b)</td> +<td>may or may not have constant complexity</td> +</tr> + +<tr> +<td>r = a</td> +<td>X&</td> +<td>r == a</td> +<td>linear</td> +</tr> + +<!-- a fifth column, "operation semantics," magically appears in the table + at this point... wtf? --> +<tr> +<td>a.size()</td> +<td>size_type</td> +<!--<td>a.end() - a.begin()</td>--> +<td> </td> +<td>may or may not have constant complexity</td> +</tr> + +<tr> +<td>a.max_size()</td> +<td>size_type</td> +<!--<td>size() of the largest possible container</td>--> +<td> </td> +<td>may or may not have constant complexity</td> +</tr> + +<tr> +<td>a.empty()</td> +<td>convertible to bool</td> +<!--<td>a.size() == 0</td>--> +<td> </td> +<td>constant</td> +</tr> + +<tr> +<td>a < b</td> +<td>convertible to bool</td> +<!--<td>lexographical_compare(a.begin,a.end(),b.begin(),b.end())</td>--> +<td>pre: < is defined for T and is a total ordering relation</td> +<td>linear</td> +</tr> + +<tr> +<td>a > b</td> +<td>convertible to bool</td> +<!--<td>b < a</td>--> +<td> </td> +<td>linear</td> +</tr> + +<tr> +<td>a <= b</td> +<td>convertible to bool</td> +<!--<td>!(a > b)</td>--> +<td> </td> +<td>linear</td> +</tr> + +<tr> +<td>a >= b</td> +<td>convertible to bool</td> +<!--<td>!(a < b)</td>--> +<td> </td> +<td>linear</td> </tr> </table title="Table 65"></p></a> <a name="66"><p> <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3" - cols="3" title="Table 66"> + cols="4" title="Table 66"> <caption><h2>Table 66 --- Reversible Container Requirements</h2></caption> <tr><th colspan="4"> If a container's iterator is bidirectional or random-access, then the container also meets these requirements. -Foo, bar, and baz are such containers. +Deque, list, vector, map, multimap, set, and multiset are such containers. </th></tr> <tr> <td><strong>expression</strong></td> <td><strong>result type</strong></td> -<td><strong>notes</strong></td> +<td><strong>notes, pre-/post-conditions, assertions</strong></td> <td><strong>complexity</strong></td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>X::reverse_iterator</td> +<td>iterator type pointing to T</td> +<td>reverse_iterator<iterator></td> +<td>compile time</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>X::const_reverse_iterator</td> +<td>iterator type pointing to const T</td> +<td>reverse_iterator<const_iterator></td> +<td>compile time</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.rbegin()</td> +<td>reverse_iterator; const_reverse_iterator for constant a</td> +<td>reverse_iterator(end())</td> +<td>constant</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.rend()</td> +<td>reverse_iterator; const_reverse_iterator for constant a</td> +<td>reverse_iterator(begin())</td> +<td>constant</td> </tr> </table title="Table 66"></p></a> @@ -118,133 +289,330 @@ Foo, bar, and baz are such containers. <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3" cols="3" title="Table 67"> <caption><h2>Table 67 --- Sequence Requirements</h2></caption> -<tr><th colspan="4"> +<tr><th colspan="3"> These are in addition to the requirements of <a href="#65">containers</a>. -Foo, bar, and baz are such containers. +Deque, list, and vector are such containers. </th></tr> <tr> <td><strong>expression</strong></td> <td><strong>result type</strong></td> -<td><strong>notes</strong></td> -<td><strong>complexity</strong></td> +<td><strong>notes, pre-/post-conditions, assertions</strong></td> +</tr> + +<tr> +<td>X(n,t)<br />X a(n,t)</td> +<td> </td> +<td>constructs a sequence with n copies of t<br />post: size() == n</td> +</tr> + +<tr> +<td>X(i,j)<br />X a(i,j)</td> +<td> </td> +<td>constructs a sequence equal to the range [i,j)<br /> + post: size() == distance(i,j)</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.insert(p,t)</td> +<td>iterator (points to the inserted copy of t)</td> +<td>inserts a copy of t before p</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.insert(p,n,t)</td> +<td>void</td> +<td>inserts n copies of t before p</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.insert(p,i,j)</td> +<td>void</td> +<td>inserts copies of elements in [i,j) before p<br /> + pre: i, j are not iterators into a</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.erase(q)</td> +<td>iterator (points to the element following q (prior to erasure))</td> +<td>erases the element pointed to by q</td> +</tr> + +<tr> +<td>a.erase(q1,q1)</td> +<td>iterator (points to the element pointed to by q2 (prior to erasure))</td> +<td>erases the elements in the range [q1,q2)</td> +</tr> + +<tr> +<td>a.clear()</td> +<td>void</td> +<td>erase(begin(),end())<br />post: size() == 0</td> </tr> </table title="Table 67"></p></a> <a name="68"><p> <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3" - cols="3" title="Table 68"> + cols="4" title="Table 68"> <caption><h2>Table 68 --- Optional Sequence Operations</h2></caption> <tr><th colspan="4"> These operations are only included in containers when the operation can be done in constant time. -Foo, bar, and baz are such containers. </th></tr> <tr> <td><strong>expression</strong></td> <td><strong>result type</strong></td> -<td><strong>notes</strong></td> -<td><strong>complexity</strong></td> +<td><strong>operational semantics</strong></td> +<td><strong>container</strong></td> +</tr> + +<tr> +<td>a.front()</td> +<td>reference; const_reference for constant a</td> +<td>*a.begin()</td> +<td>vector, list, deque</td> +</tr> + +<tr> +<td>a.back()</td> +<td>reference; const_reference for constant a</td> +<td>*--a.end()</td> +<td>vector, list, deque</td> +</tr> + +<tr> +<td>a.push_front(x)</td> +<td>void</td> +<td>a.insert(a.begin(),x)</td> +<td>list, deque</td> +</tr> + +<tr> +<td>a.push_back(x)</td> +<td>void</td> +<td>a.insert(a.end(),x)</td> +<td>vector, list, deque</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.pop_front()</td> +<td>void</td> +<td>a.erase(a.begin())</td> +<td>list, deque</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.pop_back()</td> +<td>void</td> +<td>a.erase(--a.end())</td> +<td>vector, list, deque</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a[n]</td> +<td>reference; const_reference for constant a</td> +<td>*(a.begin() + n)</td> +<td>vector, deque</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.at(n)</td> +<td>reference; const_reference for constant a</td> +<td>*(a.begin() + n)<br />throws out_of_range if n>=a.size()</td> +<td>vector, deque</td> </tr> </table title="Table 68"></p></a> <a name="69"><p> <table cellpadding="3" cellspacing="5" align="center" rules="rows" border="3" - cols="3" title="Table 69"> + cols="4" title="Table 69"> <caption><h2>Table 69 --- Associative Container Requirements</h2></caption> <tr><th colspan="4"> These are in addition to the requirements of <a href="#65">containers</a>. +Map, multimap, set, and multiset are such containers. An associative +container supports <em>unique keys</em> (and is written as +<code>a_uniq</code> instead of <code>a</code>) if it may contain at most +one element for each key. Otherwise it supports <em>equivalent keys</em> +(and is written <code>a_eq</code>). Examples of the former are set and map, +examples of the latter are multiset and multimap. </th></tr> <tr> <td><strong>expression</strong></td> <td><strong>result type</strong></td> -<td><strong>notes</strong></td> +<td><strong>notes, pre-/post-conditions, assertions</strong></td> <td><strong>complexity</strong></td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>X::key_type</td> +<td>Key</td> +<td>Key is Assignable</td> +<td>compile time</td> +</tr> + +<tr> +<td>X::key_compare</td> +<td>Compare</td> +<td>defaults to less<key_type></td> +<td>compile time</td> +</tr> + +<tr> +<td>X::value_compare</td> +<td>a binary predicate type</td> +<td>same as key_compare for set and multiset; an ordering relation on + pairs induced by the first component (Key) for map and multimap</td> +<td>compile time</td> +</tr> + +<tr> +<td>X(c)<br />X a(c)</td> +<td> </td> +<td>constructs an empty container which uses c as a comparison object</td> +<td>constant</td> +</tr> + +<tr> +<td>X()<br />X a</td> +<td> </td> +<td>constructs an empty container using Compare() as a comparison object</td> +<td>constant</td> +</tr> + +<tr> +<td>X(i,j,c)<br />X a(i,j,c)</td> +<td> </td> +<td>constructs an empty container and inserts elements from the range [i,j) + into it; uses c as a comparison object</td> +<td>NlogN in general where N is distance(i,j); linear if [i,j) is + sorted with value_comp()</td> +</tr> + +<tr> +<td>X(i,j)<br />X a(i,j)</td> +<td> </td> +<td>same as previous, but uses Compare() as a comparison object</td> +<td>same as previous</td> +</tr> + +<tr> +<td>a.key_comp()</td> +<td>X::key_compare</td> +<td>returns the comparison object out of which a was constructed</td> +<td>constant</td> +</tr> + +<tr> +<td>a.value_comp()</td> +<td>X::value_compare</td> +<td>returns an object constructed out of the comparison object</td> +<td>constant</td> +</tr> + +<tr> +<td>a_uniq.insert(t)</td> +<td>pair<iterator,bool></td> +<td>"Inserts t if and only if there is no element in the container with + key equivalent to the key of t. The bool component of the returned pair + is true -iff- the insertion took place, and the iterator component of + the pair points to the element with key equivalent to the key of + t."</td> <!-- DR 316 --> +<td>logarithmic</td> +</tr> + +<tr> +<td>a_eq.insert(t)</td> +<td>iterator</td> +<td>inserts t, returns the iterator pointing to the inserted element</td> +<td>logarithmic</td> +</tr> + +<tr> +<td>a.insert(p,t)</td> +<td>iterator</td> +<td>possibly inserts t (depending on whether a_uniq or a_eq); returns iterator + pointing to the element with key equivalent to the key of t; iterator p + is a hint pointing to where the insert should start to search</td> +<td>logarithmic in general, amortized constant if t is inserted right + after p<br /> + <strong>[but see DR 233 and <a href=" + http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4">our + specific notes</a>]</strong></td> +</tr> + +<tr> +<td>a.insert(i,j)</td> +<td>void</td> +<td>pre: i, j are not iterators into a. possibly inserts each element from + the range [i,j) (depending on whether a_uniq or a_eq)</td> +<td>Nlog(size()+N) where N is distance(i,j) in general</td> <!-- DR 264 --> +</tr> + +<tr> +<td>a.erase(k)</td> +<td>size_type</td> +<td>erases all elements with key equivalent to k; returns number of erased + elements</td> +<td>log(size()) + count(k)</td> +</tr> + +<tr> +<td>a.erase(q)</td> +<td>void</td> +<td>erases the element pointed to by q</td> +<td>amortized constant</td> +</tr> + +<tr> +<td>a.erase(q1,q2)</td> +<td>void</td> +<td>erases all the elements in the range [q1,q2)</td> +<td>log(size()) + distance(q1,q2)</td> +</tr> + +<tr> +<td>a.clear()</td> +<td>void</td> +<td>erases everthing; post: size() == 0</td> +<td>linear</td> <!-- DR 224 --> +</tr> + +<tr> +<td>a.find(k)</td> +<td>iterator; const_iterator for constant a</td> +<td>returns iterator pointing to element with key equivalent to k, or + a.end() if no such element found</td> +<td>logarithmic</td> +</tr> + +<tr> +<td>a.count(k)</td> +<td>size_type</td> +<td>returns number of elements with key equivalent to k</td> +<td>log(size()) + count(k)</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.lower_bound(k)</td> +<td>iterator; const_iterator for constant a</td> +<td>returns iterator pointing to the first element with key not less than k</td> +<td>logarithmic</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.upper_bound(k)</td> +<td>iterator; const_iterator for constant a</td> +<td>returns iterator pointing to the first element with key greater than k</td> +<td>logarithmic</td> </tr> <tr> -<td></td> -<td></td> -<td></td> -<td></td> +<td>a.equal_range(k)</td> +<td>pair<iterator,iterator>; + pair<const_iterator, const_iterator> for constant a</td> +<td>equivalent to make_pair(a.lower_bound(k), a.upper_bound(k))</td> +<td>logarithmic</td> </tr> </table title="Table 69"></p></a> @@ -252,6 +620,8 @@ These are in addition to the requirements of <a href="#65">containers</a>. <hr /> <p class="smallertext"><em> See <a href="mainpage.html">mainpage.html</a> for copying conditions. +See <a href="http://gcc.gnu.org/libstdc++/">the libstdc++-v3 homepage</a> +for more information. </em></p> diff --git a/libstdc++-v3/docs/doxygen/user.cfg.in b/libstdc++-v3/docs/doxygen/user.cfg.in index 475dd53..bb9809a 100644 --- a/libstdc++-v3/docs/doxygen/user.cfg.in +++ b/libstdc++-v3/docs/doxygen/user.cfg.in @@ -222,9 +222,7 @@ GENERATE_BUGLIST = YES # will result in a user defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = "maint=@if maint" \ - "endmaint=@endif" \ - "doctodo=@todo\nDoc me! See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more." +ALIASES = "doctodo=@todo\nDoc me! See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more." # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. |