1[/license 2 3Boost.Bimap 4 5Copyright (c) 2006-2007 Matias Capeletto 6 7Distributed under the Boost Software License, Version 1.0. 8(See accompanying file LICENSE_1_0.txt or copy at 9http://www.boost.org/LICENSE_1_0.txt) 10 11] 12 13 14[/ QuickBook Document version 1.4 ] 15 16[section Introduction] 17 18[heading How to use this document] 19 20This documentation contains a large amount of information. Whereas it 21may be worth reading it all, this documentation is intended for 22programmers with various motives: 23 24[variablelist 25[[I have to finished this today, I just want a bidirectional map!][ 26If your boss will kill you if the project is not finished by the end of 27the day, just read the [link boost_bimap.one_minute_tutorial One-minute tutorial]. 28If you have a background in STL, you can be testing a bimap within ten minutes. 29]] 30[[I am a serious programmer and want to learn Boost.Bimap][ 31Boost.Bimap has a lot to offer if you are prepared to spend some time 32reading this documentation. You will need to read [link boost_bimap.the_tutorial The tutorial] 33and skim through some of the [link boost_bimap.examples Examples]. 34The best way to read this documentation is in the order given here. 35Just click on the arrow at the right bottom corner as you finish each page. 36You may skip the reference section, and return to it later to look up a function 37signature or to find a specific metafunction. 38]] 39[[I just love C++, I want to see the inner workings of Boost.Bimap.][ 40If you are a library developer, this documentation is the best place to 41learn how Boost.Bimap is implemented. It is strongly recommended that 42you first learn to use the library as if you were the second type of 43programmer above. This library was developed in the Google SoC 2006, and 44the mentor and student generated a great deal of documentation in the 45building process. The rationale section is very large and contains a lot 46of information. There is a history section for those who might find it 47useful. Finally, in the reference section, each entity of the library is 48documented and its source code is presented. 49]] 50] 51 52[note 53If anything in the documentation is unclear, please email me at ['matias 54{dot} capeletto {at} gmail {dot} com], telling me which of the three 55types of programmer above you are and which section needs improvement. 56Please use the following notation for the subject: ['\[boost\]\[bimap\] Your 57problem] as this will help me to identify it more easily. If appropriate, 58I will act on your advice to improve the documentation. Thanks and enjoy! 59] 60 61[important 62If you should find a bug or would like to see an additional feature in 63the library, please use the standard Boost methods of dealing with this 64kind of issue rather than emailing me directly. Boost has a very good 65system to [@http://www.boost.org/more/bugs.htm track bugs] and 66[@http://www.boost.org/more/requesting_new_features.htm features requests], 67and using it is the best way of dealing with them as soon as possible. 68] 69 70[heading Navigation] 71 72Used in combination with the configured browser key (usually Alt), the 73following keys act as handy shortcuts for common navigation tasks. 74 75* [*General] 76 77 * [^[*p]] - Previous page 78 * [^[*n]] - Next page 79 * [^[*h]] - home 80 * [^[*u]] - Up 81 82* [*Main TOC] 83 84 * [^[*i]] - Introduction 85 * [^[*o]] - One minute tutorial 86 * [^[*t]] - The tutorial 87 * [^[*b]] - Bimap and Boost 88 * [^[*r]] - Reference 89 * [^[*c]] - Compiler specifics 90 * [^[*v]] - Performance 91 * [^[*e]] - Examples 92 * [^[*s]] - Test Suite 93 * [^[*f]] - Future work 94 * [^[*m]] - Release notes 95 * [^[*w]] - Rationale 96 * [^[*y]] - History 97 * [^[*a]] - Acknowledgements 98 99[endsect]