|
|
Boost-Commit : |
From: daniel_james_at_[hidden]
Date: 2008-06-01 13:54:37
Author: danieljames
Date: 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
New Revision: 46030
URL: http://svn.boost.org/trac/boost/changeset/46030
Log:
Merge in documentation improvements from the doc branch.
Merged revisions 45892-46020 via svnmerge from
https://svn.boost.org/svn/boost/branches/doc
........
r45892 | danieljames | 2008-05-29 00:30:07 +0100 (Thu, 29 May 2008) | 1 line
Merge latest changes from unordered.
........
r46017 | danieljames | 2008-06-01 18:18:15 +0100 (Sun, 01 Jun 2008) | 2 lines
Use both PNG and SVG versions of the buckets diagram.
........
r46018 | danieljames | 2008-06-01 18:18:27 +0100 (Sun, 01 Jun 2008) | 2 lines
Improved function summary tables in unordered documenations.
........
r46019 | danieljames | 2008-06-01 18:18:39 +0100 (Sun, 01 Jun 2008) | 3 lines
I'd hacked the bibliography to avoid showing the title twice, but this was
causing problems when generating PDFs, so show the title twice.
........
r46020 | danieljames | 2008-06-01 18:18:52 +0100 (Sun, 01 Jun 2008) | 3 lines
Don't use the compact boostbook refernce style in the standalone documentation
as it is too wide for printing out.
........
Properties modified:
branches/unordered/trunk/ (props changed)
Text files modified:
branches/unordered/trunk/libs/unordered/doc/Jamfile.v2 | 4 +
branches/unordered/trunk/libs/unordered/doc/bibliography.xml | 4
branches/unordered/trunk/libs/unordered/doc/buckets.qbk | 88 +++++++++++++++++++++++----------------
branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk | 4
branches/unordered/trunk/libs/unordered/doc/unordered.qbk | 10 ++++
5 files changed, 70 insertions(+), 40 deletions(-)
Modified: branches/unordered/trunk/libs/unordered/doc/Jamfile.v2
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/Jamfile.v2 (original)
+++ branches/unordered/trunk/libs/unordered/doc/Jamfile.v2 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
@@ -19,6 +19,10 @@
<xsl:param>toc.section.depth=1
<xsl:param>toc.max.depth=1
+ <xsl:param>boost.compact.typedef=0
+ <xsl:param>boost.compact.function=0
+ <xsl:param>boost.compact.enum=0
+
<dependency>css
<dependency>images
Modified: branches/unordered/trunk/libs/unordered/doc/bibliography.xml
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/bibliography.xml (original)
+++ branches/unordered/trunk/libs/unordered/doc/bibliography.xml 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
@@ -1,6 +1,6 @@
-<section id="unordered.bibliography" label="Bibliography">
+<section id="unordered.bibliography">
+<title>Bibliography</title>
<bibliography>
- <title>Bibliography</title>
<biblioentry>
<biblioset relation="journal">
<title>C/C++ Users Journal</title>
Modified: branches/unordered/trunk/libs/unordered/doc/buckets.qbk
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/buckets.qbk (original)
+++ branches/unordered/trunk/libs/unordered/doc/buckets.qbk 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
@@ -10,7 +10,7 @@
`B`, `C`, `D` and `E` (this is just for illustration, containers will typically
have more buckets).
-[$../../libs/unordered/doc/diagrams/buckets.png]
+[diagram buckets]
In order to decide which bucket to place an element in, the container applies
the hash function, `Hash`, to the element's key (for `unordered_set` and
@@ -35,37 +35,53 @@
the search slower. This is known as a collision. To keep things fast we try to
keep collisions to a minimum.
-[table Methods for Accessing Buckets
- [[Method] [Description]]
-
- [
- [``size_type bucket_count() const``]
- [The number of buckets.]
- ]
- [
- [``size_type max_bucket_count() const``]
- [An upper bound on the number of buckets.]
- ]
- [
- [``size_type bucket_size(size_type n) const``]
- [The number of elements in bucket `n`.]
- ]
- [
- [``size_type bucket(key_type const& k) const``]
- [Returns the index of the bucket which would contain k]
- ]
- [
- [``
- local_iterator begin(size_type n);
- local_iterator end(size_type n);
- const_local_iterator begin(size_type n) const;
- const_local_iterator end(size_type n) const;
- const_local_iterator cbegin(size_type n) const;
- const_local_iterator cend(size_type n) const;
- ``]
- [Return begin and end iterators for bucket `n`.]
- ]
-]
+'''
+<table frame="all"><title>Methods for Accessing Buckets</title>
+ <tgroup cols="2">
+ <thead><row>
+ <entry><para>Method</para></entry>
+ <entry><para>Description</para></entry>
+ </row></thead>
+ <tbody>
+ <row>
+ <entry>'''`size_type bucket_count() const`'''</entry>
+ <entry>'''The number of buckets.'''</entry>
+ </row>
+ <row>
+ <entry>'''`size_type max_bucket_count() const`'''</entry>
+ <entry>'''An upper bound on the number of buckets.'''</entry>
+ </row>
+ <row>
+ <entry>'''`size_type bucket_size(size_type n) const`'''</entry>
+ <entry>'''The number of elements in bucket `n`.'''</entry>
+ </row>
+ <row>
+ <entry>'''`size_type bucket(key_type const& k) const`'''</entry>
+ <entry>'''Returns the index of the bucket which would contain k'''</entry>
+ </row>
+ <row>
+ <entry>'''`local_iterator begin(size_type n);`'''</entry>
+ <entry morerows='5'>'''Return begin and end iterators for bucket `n`.'''</entry>
+ </row>
+ <row>
+ <entry>'''`local_iterator end(size_type n);`'''</entry>
+ </row>
+ <row>
+ <entry>'''`const_local_iterator begin(size_type n) const;`'''</entry>
+ </row>
+ <row>
+ <entry>'''`const_local_iterator end(size_type n) const;`'''</entry>
+ </row>
+ <row>
+ <entry>'''`const_local_iterator cbegin(size_type n) const;`'''</entry>
+ </row>
+ <row>
+ <entry>'''`const_local_iterator cend(size_type n) const;`'''</entry>
+ </row>
+ </tbody>
+ </tgroup>
+</table>
+'''
[h2 Controlling the number of buckets]
@@ -100,19 +116,19 @@
[[Method] [Description]]
[
- [``float load_factor() const``]
+ [`float load_factor() const`]
[The average number of elements per bucket.]
]
[
- [``float max_load_factor() const``]
+ [`float max_load_factor() const`]
[Returns the current maximum load factor.]
]
[
- [``float max_load_factor(float z)``]
+ [`float max_load_factor(float z)`]
[Changes the container's maximum load factor, using `z` as a hint.]
]
[
- [``void rehash(size_type n)``]
+ [`void rehash(size_type n)`]
[Changes the number of buckets so that there at least n buckets, and
so that the load factor is less than the maximum load factor.]
]
Modified: branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk (original)
+++ branches/unordered/trunk/libs/unordered/doc/hash_equality.qbk 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
@@ -63,11 +63,11 @@
[[Method] [Description]]
[
- [``hasher hash_function() const``]
+ [`hasher hash_function() const`]
[Returns the container's hash function.]
]
[
- [``key_equal key_eq() const``]
+ [`key_equal key_eq() const`]
[Returns the container's key equality function.]
]
]
Modified: branches/unordered/trunk/libs/unordered/doc/unordered.qbk
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/unordered.qbk (original)
+++ branches/unordered/trunk/libs/unordered/doc/unordered.qbk 2008-06-01 13:54:36 EDT (Sun, 01 Jun 2008)
@@ -17,6 +17,16 @@
]
]
+[template diagram[name] '''<inlinemediaobject>
+<imageobject role="html">
+<imagedata align = "center" fileref="../../libs/unordered/doc/diagrams/'''[name]'''.png"></imagedata>
+</imageobject>
+<imageobject role="print">
+<imagedata align = "center" fileref="../../libs/unordered/doc/diagrams/'''[name]'''.svg"></imagedata>
+</imageobject>
+</inlinemediaobject>''']
+
+
[include:unordered intro.qbk]
[include:unordered buckets.qbk]
[include:unordered hash_equality.qbk]
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk