projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | <html> |
| 2 | <head> | |
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> | |
| 4 | <title>Introduction</title> | |
| 5 | <link rel="stylesheet" href="../boostbook.css" type="text/css"> | |
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> | |
| 7 | <link rel="home" href="../index.html" title="Chapter 1. Boost.Bimap"> | |
| 8 | <link rel="up" href="../index.html" title="Chapter 1. Boost.Bimap"> | |
| 9 | <link rel="prev" href="../index.html" title="Chapter 1. Boost.Bimap"> | |
| 10 | <link rel="next" href="one_minute_tutorial.html" title="One minute tutorial"> | |
| 11 | </head> | |
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
| 13 | <table cellpadding="2" width="100%"><tr> | |
| 14 | <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> | |
| 15 | <td align="center"><a href="../../../../../index.html">Home</a></td> | |
| 16 | <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> | |
| 17 | <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> | |
| 18 | <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> | |
| 19 | <td align="center"><a href="../../../../../more/index.htm">More</a></td> | |
| 20 | </tr></table> | |
| 21 | <hr> | |
| 22 | <div class="spirit-nav"> | |
| 23 | <a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="one_minute_tutorial.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> | |
| 24 | </div> | |
| 25 | <div class="section boost_bimap_introduction"> | |
| 26 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> | |
| 27 | <a name="boost_bimap.introduction"></a><a class="link" href="introduction.html" title="Introduction">Introduction</a> | |
| 28 | </h2></div></div></div> | |
| 29 | <h4> | |
| 30 | <a name="boost_bimap.introduction.h0"></a> | |
| 31 | <span class="phrase"><a name="boost_bimap.introduction.how_to_use_this_document"></a></span><a class="link" href="introduction.html#boost_bimap.introduction.how_to_use_this_document">How | |
| 32 | to use this document</a> | |
| 33 | </h4> | |
| 34 | <p> | |
| 35 | This documentation contains a large amount of information. Whereas it may be | |
| 36 | worth reading it all, this documentation is intended for programmers with various | |
| 37 | motives: | |
| 38 | </p> | |
| 39 | <div class="variablelist"> | |
| 40 | <p class="title"><b></b></p> | |
| 41 | <dl class="variablelist"> | |
| 42 | <dt><span class="term">I have to finished this today, I just want a bidirectional map!</span></dt> | |
| 43 | <dd><p> | |
| 44 | If your boss will kill you if the project is not finished by the end | |
| 45 | of the day, just read the <a class="link" href="one_minute_tutorial.html" title="One minute tutorial">One-minute | |
| 46 | tutorial</a>. If you have a background in STL, you can be testing | |
| 47 | a bimap within ten minutes. | |
| 48 | </p></dd> | |
| 49 | <dt><span class="term">I am a serious programmer and want to learn Boost.Bimap</span></dt> | |
| 50 | <dd><p> | |
| 51 | Boost.Bimap has a lot to offer if you are prepared to spend some time | |
| 52 | reading this documentation. You will need to read <a class="link" href="the_tutorial.html" title="The tutorial">The | |
| 53 | tutorial</a> and skim through some of the <a class="link" href="examples.html" title="Examples">Examples</a>. | |
| 54 | The best way to read this documentation is in the order given here. Just | |
| 55 | click on the arrow at the right bottom corner as you finish each page. | |
| 56 | You may skip the reference section, and return to it later to look up | |
| 57 | a function signature or to find a specific metafunction. | |
| 58 | </p></dd> | |
| 59 | <dt><span class="term">I just love C++, I want to see the inner workings of Boost.Bimap.</span></dt> | |
| 60 | <dd><p> | |
| 61 | If you are a library developer, this documentation is the best place | |
| 62 | to learn how Boost.Bimap is implemented. It is strongly recommended that | |
| 63 | you first learn to use the library as if you were the second type of | |
| 64 | programmer above. This library was developed in the Google SoC 2006, | |
| 65 | and the mentor and student generated a great deal of documentation in | |
| 66 | the building process. The rationale section is very large and contains | |
| 67 | a lot of information. There is a history section for those who might | |
| 68 | find it useful. Finally, in the reference section, each entity of the | |
| 69 | library is documented and its source code is presented. | |
| 70 | </p></dd> | |
| 71 | </dl> | |
| 72 | </div> | |
| 73 | <div class="note"><table border="0" summary="Note"> | |
| 74 | <tr> | |
| 75 | <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> | |
| 76 | <th align="left">Note</th> | |
| 77 | </tr> | |
| 78 | <tr><td align="left" valign="top"><p> | |
| 79 | If anything in the documentation is unclear, please email me at <span class="emphasis"><em>matias | |
| 80 | {dot} capeletto {at} gmail {dot} com</em></span>, telling me which of the | |
| 81 | three types of programmer above you are and which section needs improvement. | |
| 82 | Please use the following notation for the subject: <span class="emphasis"><em>[boost][bimap] | |
| 83 | Your problem</em></span> as this will help me to identify it more easily. | |
| 84 | If appropriate, I will act on your advice to improve the documentation. Thanks | |
| 85 | and enjoy! | |
| 86 | </p></td></tr> | |
| 87 | </table></div> | |
| 88 | <div class="important"><table border="0" summary="Important"> | |
| 89 | <tr> | |
| 90 | <td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../doc/src/images/important.png"></td> | |
| 91 | <th align="left">Important</th> | |
| 92 | </tr> | |
| 93 | <tr><td align="left" valign="top"><p> | |
| 94 | If you should find a bug or would like to see an additional feature in the | |
| 95 | library, please use the standard Boost methods of dealing with this kind | |
| 96 | of issue rather than emailing me directly. Boost has a very good system to | |
| 97 | <a href="http://www.boost.org/more/bugs.htm" target="_top">track bugs</a> and <a href="http://www.boost.org/more/requesting_new_features.htm" target="_top">features requests</a>, | |
| 98 | and using it is the best way of dealing with them as soon as possible. | |
| 99 | </p></td></tr> | |
| 100 | </table></div> | |
| 101 | <h4> | |
| 102 | <a name="boost_bimap.introduction.h1"></a> | |
| 103 | <span class="phrase"><a name="boost_bimap.introduction.navigation"></a></span><a class="link" href="introduction.html#boost_bimap.introduction.navigation">Navigation</a> | |
| 104 | </h4> | |
| 105 | <p> | |
| 106 | Used in combination with the configured browser key (usually Alt), the following | |
| 107 | keys act as handy shortcuts for common navigation tasks. | |
| 108 | </p> | |
| 109 | <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> | |
| 110 | <li class="listitem"> | |
| 111 | <span class="bold"><strong>General</strong></span> | |
| 112 | <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "> | |
| 113 | <li class="listitem"> | |
| 114 | <code class="literal"><span class="bold"><strong>p</strong></span></code> - Previous | |
| 115 | page | |
| 116 | </li> | |
| 117 | <li class="listitem"> | |
| 118 | <code class="literal"><span class="bold"><strong>n</strong></span></code> - Next page | |
| 119 | </li> | |
| 120 | <li class="listitem"> | |
| 121 | <code class="literal"><span class="bold"><strong>h</strong></span></code> - home | |
| 122 | </li> | |
| 123 | <li class="listitem"> | |
| 124 | <code class="literal"><span class="bold"><strong>u</strong></span></code> - Up | |
| 125 | </li> | |
| 126 | </ul></div> | |
| 127 | </li> | |
| 128 | <li class="listitem"> | |
| 129 | <span class="bold"><strong>Main TOC</strong></span> | |
| 130 | <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "> | |
| 131 | <li class="listitem"> | |
| 132 | <code class="literal"><span class="bold"><strong>i</strong></span></code> - Introduction | |
| 133 | </li> | |
| 134 | <li class="listitem"> | |
| 135 | <code class="literal"><span class="bold"><strong>o</strong></span></code> - One minute | |
| 136 | tutorial | |
| 137 | </li> | |
| 138 | <li class="listitem"> | |
| 139 | <code class="literal"><span class="bold"><strong>t</strong></span></code> - The tutorial | |
| 140 | </li> | |
| 141 | <li class="listitem"> | |
| 142 | <code class="literal"><span class="bold"><strong>b</strong></span></code> - Bimap and | |
| 143 | Boost | |
| 144 | </li> | |
| 145 | <li class="listitem"> | |
| 146 | <code class="literal"><span class="bold"><strong>r</strong></span></code> - Reference | |
| 147 | </li> | |
| 148 | <li class="listitem"> | |
| 149 | <code class="literal"><span class="bold"><strong>c</strong></span></code> - Compiler | |
| 150 | specifics | |
| 151 | </li> | |
| 152 | <li class="listitem"> | |
| 153 | <code class="literal"><span class="bold"><strong>v</strong></span></code> - Performance | |
| 154 | </li> | |
| 155 | <li class="listitem"> | |
| 156 | <code class="literal"><span class="bold"><strong>e</strong></span></code> - Examples | |
| 157 | </li> | |
| 158 | <li class="listitem"> | |
| 159 | <code class="literal"><span class="bold"><strong>s</strong></span></code> - Test Suite | |
| 160 | </li> | |
| 161 | <li class="listitem"> | |
| 162 | <code class="literal"><span class="bold"><strong>f</strong></span></code> - Future work | |
| 163 | </li> | |
| 164 | <li class="listitem"> | |
| 165 | <code class="literal"><span class="bold"><strong>m</strong></span></code> - Release notes | |
| 166 | </li> | |
| 167 | <li class="listitem"> | |
| 168 | <code class="literal"><span class="bold"><strong>w</strong></span></code> - Rationale | |
| 169 | </li> | |
| 170 | <li class="listitem"> | |
| 171 | <code class="literal"><span class="bold"><strong>y</strong></span></code> - History | |
| 172 | </li> | |
| 173 | <li class="listitem"> | |
| 174 | <code class="literal"><span class="bold"><strong>a</strong></span></code> - Acknowledgements | |
| 175 | </li> | |
| 176 | </ul></div> | |
| 177 | </li> | |
| 178 | </ul></div> | |
| 179 | </div> | |
| 180 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> | |
| 181 | <td align="left"></td> | |
| 182 | <td align="right"><div class="copyright-footer">Copyright © 2006-2012 Matias Capeletto<p> | |
| 183 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
| 184 | file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) | |
| 185 | </p> | |
| 186 | </div></td> | |
| 187 | </tr></table> | |
| 188 | <hr> | |
| 189 | <div class="spirit-nav"> | |
| 190 | <a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="one_minute_tutorial.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> | |
| 191 | </div> | |
| 192 | </body> | |
| 193 | </html> |