Boost-Commit :

Date view	Thread view	Subject view	Author view

From: matias.capeletto_at_[hidden]
Date: 2008-02-04 16:01:06

Next message: matias.capeletto_at_[hidden]: "[Boost-commit] svn:boost r43104 - branches/release/libs/bimap/doc/html/boost_bimap/the_tutorial"
Previous message: john.groups_at_[hidden]: "[Boost-commit] svn:boost r43102 - sandbox/logging/libs/logging"

Author: matias
Date: 2008-02-04 16:01:06 EST (Mon, 04 Feb 2008)
New Revision: 43103
URL: http://svn.boost.org/trac/boost/changeset/43103

Log:
hooking --> additional information in html docs
Added:
trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/additional_information.html (contents, props changed)
Removed:
trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/hooking_information.html

Added: trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/additional_information.html
==============================================================================
--- (empty file)
+++ trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/additional_information.html 2008-02-04 16:01:06 EST (Mon, 04 Feb 2008)
@@ -0,0 +1,249 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Additional
+ information</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
+<link rel="start" href="../../index.html" title="Chapter 1. Boost.Bimap">
+<link rel="up" href="../the_tutorial.html" title="The tutorial">
+<link rel="prev" href="unconstrained_sets.html" title="Unconstrained
+ Sets">
+<link rel="next" href="complete_instantiation_scheme.html" title="Complete
+ instantiation scheme">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="unconstrained_sets.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="complete_instantiation_scheme.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_bimap.the_tutorial.additional_information"></a><a href="additional_information.html" title="Additional
+ information">Additional
+ information</a>
+</h3></div></div></div>
+
+ Bidirectional maps may have associated information about each relation. Suppose
+ we want to represent a books and author bidirectional map.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+typedef bimap<
+
+ multiset_of< std::string >, // author
+ set_of< std::string > // title
+
+> bm_type;
+typedef bm_type::value_type book;
+
+bm_type bm;
+
+bm.insert( book( "Bjarne Stroustrup" , "The C++ Programming Language" ) );
+bm.insert( book( "Scott Meyers" , "Effective C++" ) );
+bm.insert( book( "Andrei Alexandrescu" , "Modern C++ Design" ) );
+
+// Print the author of Modern C++
+std::cout << bm.right.at( "Modern C++ Design" );
+</pre>
+
+ 
+
+ 
+
+ Suppose now that we want to store abstract of each book. We have two options:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ Books name are unique identifiers, so we can create a separate <code class="computeroutput">std::map< string, string ></code>
+ that relates books names with abstracts.
+ </li>
+<li>
+ We can use Boost.MultiIndex for the new beast.
+ </li>
+</ol></div>
+
+ Option 1 is the wrong approach, if we go this path we lost what bimap has
+ won us. We now have to maintain the logic of two interdependent containers,
+ there is an extra string stored for each book name, and the performance will
+ be worse. This is far away from being a good solution.
+ 
+
+ Option 2 is correct. We start thinking books as entries in a table. So it
+ makes sense to start using Boost.MultiIndex. We can then add the year of
+ publication, the price, etc... and we can index this new items too. So Boost.MultiIndex
+ is a sound solution for our problem.
+ 
+
+ The thing is that there are cases where we want to maintain bimap semantics
+ (use <code class="computeroutput">at()</code>
+ to find an author given a book name and the other way around) and add information
+ about the relations that we are sure we will not want to index later (like
+ the abstracts). Option 1 is not possible, option 2 neither.
+ 
+
+ Boost.Bimap provides support for this kind of situations by means of an embedded
+ information member. You can pass an extra parameter to a bimap: <code class="computeroutput">with_info<
+ InfoType ></code>
+ and an <code class="computeroutput">info</code> member of type
+ <code class="computeroutput">InfoType</code> will appear in the
+ relation and bimap pairs.
+ 
+
+ <img src="../../images/bimap/relation.and.pair.with.info.png" alt="relation.and.pair.with.info">
+ 
+
+ Relations and bimap pairs constructors will take an extra argument. If only
+ two arguments are used, the information will be initialized with their default
+ constructor.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+typedef bimap<
+
+ multiset_of< std::string >, // author
+ set_of< std::string >, // title
+
+ with_info< std::string > // abstract
+
+> bm_type;
+typedef bm_type::value_type book;
+
+bm_type bm;
+
+bm.insert(
+
+ book( "Bjarne Stroustrup" , "The C++ Programming Language",
+
+ "For C++ old-timers, the first edition of this book is"
+ "the one that started it all—the font of our knowledge." )
+);
+
+
+// Print the author of the bible
+std::cout << bm.right.at("The C++ Programming Language");
+
+// Print the abstract of this book
+bm_type::left_iterator i = bm.left.find("Bjarne Stroustrup");
+std::cout << i->info;
+</pre>
+
+ 
+
+ 
+
+ Contrary to the two key types, the information will be mutable using iterators.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+i->info += "More details about this book";
+</pre>
+
+ 
+
+ 
+
+ A new function is included in unique map views: <code class="computeroutput">info_at(key)</code>, that
+ mimics the standard <code class="computeroutput">at(key)</code> function
+ but returned the associated information instead of the data.
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+// Print the new abstract
+std::cout << bm.right.info_at("The C++ Programming Language");
+</pre>
+
+ 
+
+ 
+
+ The info member can be tagged just as the left or the right member. The following
+ is a rewrite of the above example using user defined names:
+ 
+
+ 
+
+
+
+<pre class="programlisting">
+typedef bimap<
+
+ multiset_of< tagged< std::string, author > >,
+ set_of< tagged< std::string, title > >,
+
+ with_info< tagged< std::string, abstract > >
+
+> bm_type;
+typedef bm_type::value_type book;
+
+bm_type bm;
+
+bm.insert(
+
+ book( "Bjarne Stroustrup" , "The C++ Programming Language",
+
+ "For C++ old-timers, the first edition of this book is"
+ "the one that started it all—the font of our knowledge." )
+);
+
+// Print the author of the bible
+std::cout << bm.by<title>().at("The C++ Programming Language");
+
+// Print the abstract of this book
+bm_type::map_by<author>::iterator i = bm.by<author>().find("Bjarne Stroustrup");
+std::cout << i->get<abstract>();
+
+// Contrary to the two key types, the information will be mutable
+// using iterators.
+
+i->get<abstract>() += "More details about this book";
+
+// Print the new abstract
+std::cout << bm.by<title>().info_at("The C++ Programming Language");
+</pre>
+
+ 
+
+ 
+
+ Go to source code
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2006 -2007 Matias Capeletto
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="unconstrained_sets.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="complete_instantiation_scheme.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Deleted: trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/hooking_information.html
==============================================================================
--- trunk/libs/bimap/doc/html/boost_bimap/the_tutorial/hooking_information.html 2008-02-04 16:01:06 EST (Mon, 04 Feb 2008)
+++ (empty file)
@@ -1,221 +0,0 @@
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Hooking
- Information</title>
-<link rel="stylesheet" href="../../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
-<link rel="start" href="../../index.html" title="Chapter 1. Boost.Bimap">
-<link rel="up" href="../the_tutorial.html" title="The tutorial">
-<link rel="prev" href="unconstrained_sets.html" title="Unconstrained
- Sets">
-<link rel="next" href="complete_instantiation_scheme.html" title="Complete
- instantiation scheme">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%">
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="unconstrained_sets.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="complete_instantiation_scheme.html"><img src="../../images/next.png" alt="Next"></a>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_bimap.the_tutorial.hooking_information"></a><a href="hooking_information.html" title="Hooking
- Information">Hooking
- Information</a>
-</h3></div></div></div>
-
- Bidirectional maps may have associated information about each relation. Suppose
- we want to represent a books and author bidirectional map.
- 
-
- 
-
-
-
-<pre class="programlisting">
-typedef bimap<
-
- multiset_of< std::string >, // author
- set_of< std::string > // book name
-
-> bm_type;
-typedef bm_type::value_type book;
-
-bm_type bm;
-
-bm.insert( book( "Bjarne Stroustrup" , "The C++ Programming Language" ) );
-bm.insert( book( "Scott Meyers" , "Effective C++" ) );
-bm.insert( book( "Andrei Alexandrescu" , "Modern C++ Design" ) );
-
-// Print the author of Modern C++
-std::cout << bm.right.at( "Modern C++ Design" );
-</pre>
-
- 
-
- 
-
- 
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-
- 
-
- 
-
- Suppose now that we want to store abstract of each book. We have two options:
- 
-<div class="orderedlist"><ol type="1">
-<li>
- Books name are unique identifiers, so we can create a separate <code class="computeroutput">std::map< string, string ></code>
- that relates books names with abstracts.
- </li>
-<li>
- We can use Boost.MultiIndex for the new beast.
- </li>
-</ol></div>
-
- Option 1 is the wrong approach, if we go this path we lost what bimap has
- won us. We now have to maintain the logic of two interdependent containers,
- there is an extra string stored for each book name, and the performance will
- be worse. This is far away from being a good solution.
- 
-
- Option 2 is correct. We start thinking books as entries in a table. So it
- makes sense to start using Boost.MultiIndex. We can then add the year of
- publication, the price, etc... and we can index this new items too. So Boost.MultiIndex
- is a sound solution for our problem.
- 
-
- The thing is that there are cases where we want to maintain bimap semantics
- (use <code class="computeroutput">at()</code>
- to find an author given a book name and the other way around) and add information
- about the relations that we are sure we will not want to index later (like
- the abstracts). Option 1 is not possible, option 2 neither.
- 
-
- Boost.Bimap provides support for this kind of situations by means of information
- hooking. You can pass an extra parameter to a bimap with the type <code class="computeroutput">info_hook<
- InfoType ></code>
- and an <code class="computeroutput">info</code> member of type
- <code class="computeroutput">InfoType</code> will appear in the
- relation and bimap pairs.
- 
-
- Relations and bimap pairs constructors can take an extra argument. If only
- two arguments are used, the information will be initialized with their default
- constructor.
- 
-
- 
-
-
-
-<pre class="programlisting">
-typedef bimap<
-
- multiset_of< std::string >, // author
- set_of< std::string >, // book name
-
- with_info< std::string > // abstract
-
-> bm_type;
-typedef bm_type::value_type book;
-
-bm_type bm;
-
-bm.insert(
-
- book( "Bjarne Stroustrup" , "The C++ Programming Language",
-
- "For C++ old-timers, the first edition of this book is"
- "the one that started it all—the font of our knowledge." )
-);
-
-
-// Print the abstract of the bible
-std::cout << bm.right.at("The C++ Programming Language");
-
-// Print the abstract of this book
-bm_type::left_iterator i = bm.left.find("Bjarne Stroustrup");
-std::cout << i->info;
-</pre>
-
- 
-
- 
-
- 
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-
- 
-
- 
-
- Contrary to the two key types, the information will be mutable using iterators.
- 
-
- 
-
-
-
-<pre class="programlisting">
-i->info += "More details about this book";
-</pre>
-
- 
-
- 
-
- 
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-
- 
-
- 
-
- A new function is included in unique map views: <code class="computeroutput">info_at(key)</code>, that
- mimics the standard <code class="computeroutput">at(key)</code> function
- but returned the associated information instead of the data.
- 
-
- 
-
-
-
-<pre class="programlisting">
-// Print the new abstract
-std::cout << bm.right.info_at("The C++ Programming Language");
-</pre>
-
- 
-
- 
-
- 
-<div class="calloutlist"><table border="0" summary="Callout list"></table></div>
-
- 
-
- 
-
- Go to source code
- 
-</div>
-<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"></td>
-<td align="right">Copyright © 2006 -2007 Matias Capeletto</td>
-</tr></table>
-<hr>
-<div class="spirit-nav">
-<a accesskey="p" href="unconstrained_sets.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../the_tutorial.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="complete_instantiation_scheme.html"><img src="../../images/next.png" alt="Next"></a>
-</div>
-</body>
-</html>

Next message: matias.capeletto_at_[hidden]: "[Boost-commit] svn:boost r43104 - branches/release/libs/bimap/doc/html/boost_bimap/the_tutorial"
Previous message: john.groups_at_[hidden]: "[Boost-commit] svn:boost r43102 - sandbox/logging/libs/logging"

Date view	Thread view	Subject view	Author view

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