reference.qbk 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. [/license
  2. Boost.Bimap
  3. Copyright (c) 2006-2007 Matias Capeletto
  4. Distributed under the Boost Software License, Version 1.0.
  5. (See accompanying file LICENSE_1_0.txt or copy at
  6. http://www.boost.org/LICENSE_1_0.txt)
  7. ]
  8. [/ QuickBook Document version 1.4 ]
  9. [section Reference]
  10. [section Headers]
  11. The following are the interface headers of Boost.Bimap:
  12. [*Convenience]
  13. * "boost/bimap.hpp" ['(includes "boost/bimap/bimap.hpp" and imports the bimap class to boost namespace)]
  14. [*Container]
  15. * "boost/bimap/bimap.hpp" ['(includes "boost/bimap/set_of.hpp" and "boost/bimap/unconstrained_set_of.hpp")]
  16. [*Set Types]
  17. * "boost/bimap/set_of.hpp"
  18. * "boost/bimap/multiset_of.hpp"
  19. * "boost/bimap/unordered_set_of.hpp"
  20. * "boost/bimap/unordered_multiset_of.hpp"
  21. * "boost/bimap/list_of.hpp"
  22. * "boost/bimap/vector_of.hpp"
  23. * "boost/bimap/unconstrained_set_of.hpp"
  24. [*Boost Integration]
  25. * "boost/bimap/support/lambda.hpp"
  26. * "boost/bimap/property_map/set_support.hpp"
  27. * "boost/bimap/property_map/unordered_set_support.hpp"
  28. A program using Boost.Bimap must therefore include
  29. "boost/bimap/bimap.hpp" and the headers defining the collection types to be used.
  30. Additional headers allow the integration of Boost.Bimap with other boost libraries,
  31. like Boost.Lambda and Boost.Property_map.
  32. In order to use the serialization capabilities of Boost.Bimap, the appropriate
  33. Boost.Serialization library module must be linked. Other than that, Boost.Bimap
  34. is a header-only library, requiring no additional object modules.
  35. [endsect]
  36. [include reference/bimap.qbk]
  37. [include reference/set_of.qbk]
  38. [include reference/unordered_set_of.qbk]
  39. [include reference/list_of.qbk]
  40. [include reference/vector_of.qbk]
  41. [include reference/unconstrained_set_of.qbk]
  42. [endsect]