index.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  5. <title>Boost.Flyweight Documentation - Reference</title>
  6. <link rel="stylesheet" href="../style.css" type="text/css">
  7. <link rel="start" href="../index.html">
  8. <link rel="prev" href="../tutorial/lambda_expressions.html">
  9. <link rel="up" href="../index.html">
  10. <link rel="next" href="flyweight.html">
  11. </head>
  12. <body>
  13. <h1><img src="../../../../boost.png" alt="Boost logo" align=
  14. "middle" width="277" height="86">Boost.Flyweight Reference</h1>
  15. <div class="prev_link"><a href="../tutorial/lambda_expressions.html"><img src="../prev.gif" alt="annex: MPL lambda expressions" border="0"><br>
  16. Annex: MPL lambda expressions
  17. </a></div>
  18. <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
  19. Index
  20. </a></div>
  21. <div class="next_link"><a href="flyweight.html"><img src="../next.gif" alt="flyweight reference" border="0"><br>
  22. <code>flyweight</code> reference
  23. </a></div><br clear="all" style="clear: all;">
  24. <hr>
  25. <h2>Contents</h2>
  26. <ul>
  27. <li><a href="#headers">Header summary</a></li>
  28. <li><a href="#dependencies">Dependencies</a></li>
  29. <li><a href="#flyweight_synopsis">Header
  30. <code>"boost/flyweight.hpp"</code> synopsis</a></li>
  31. <li><a href="flyweight.html">Class template <code>flyweight</code></a></li>
  32. <li><a href="key_value.html">Key-value flyweights</a></li>
  33. <li><a href="tags.html">Tags</a></li>
  34. <li><a href="factories.html">Factories</a></li>
  35. <li><a href="holders.html">Holders</a></li>
  36. <li><a href="locking.html">Locking policies</a></li>
  37. <li><a href="tracking.html">Tracking policies</a></li>
  38. </ul>
  39. <h2><a name="headers">Header summary</a></h2>
  40. <p>
  41. Boost.Flyweight comprises the following public headers:
  42. <ul>
  43. <li><a href="#flyweight_synopsis"><code>"boost/flyweight.hpp"</code></a></li>
  44. <li>Class template <code>flyweight</code>
  45. <ul>
  46. <li><a href="flyweight.html#flyweight_fwd_synopsis"><code>"boost/flyweight/flyweight_fwd.hpp"</code></a></li>
  47. <li><a href="flyweight.html#synopsis"><code>"boost/flyweight/flyweight.hpp"</code></a></li>
  48. <li><a href="flyweight.html#serialize_synopsis"><code>"boost/flyweight/flyweight_serialize.hpp"</code></a></li>
  49. </ul>
  50. </li>
  51. <li>Key-value flyweights
  52. <ul>
  53. <li><a href="key_value.html#key_value_fwd_synopsis"><code>"boost/flyweight/key_value_fwd.hpp"</code></a></li>
  54. <li><a href="key_value.html#synopsis"><code>"boost/flyweight/key_value.hpp"</code></a></li>
  55. </ul>
  56. </li>
  57. <li>Tags
  58. <ul>
  59. <li><a href="tags.html#tag_synopsis"><code>"boost/flyweight/tag.hpp"</code></a></li>
  60. </ul>
  61. </li>
  62. <li>Factories
  63. <ul>
  64. <li><a href="factories.html#factory_tag_synopsis"><code>"boost/flyweight/factory_tag.hpp"</code></a></li>
  65. <li><a href="factories.html#hashed_factory_fwd_synopsis"><code>"boost/flyweight/hashed_factory_fwd.hpp"</code></a></li>
  66. <li><a href="factories.html#hashed_factory_synopsis"><code>"boost/flyweight/hashed_factory.hpp"</code></a></li>
  67. <li><a href="factories.html#set_factory_fwd_synopsis"><code>"boost/flyweight/set_factory_fwd.hpp"</code></a></li>
  68. <li><a href="factories.html#set_factory_synopsis"><code>"boost/flyweight/set_factory.hpp"</code></a></li>
  69. <li><a href="factories.html#assoc_container_factory_fwd_synopsis"><code>"boost/flyweight/assoc_container_factory_fwd.hpp"</code></a></li>
  70. <li><a href="factories.html#assoc_container_factory_synopsis"><code>"boost/flyweight/assoc_container_factory.hpp"</code></a></li>
  71. </ul>
  72. </li>
  73. <li>Holders
  74. <ul>
  75. <li><a href="holders.html#holder_tag_synopsis"><code>"boost/flyweight/holder_tag.hpp"</code></a></li>
  76. <li><a href="holders.html#static_holder_fwd_synopsis"><code>"boost/flyweight/static_holder_fwd.hpp"</code></a></li>
  77. <li><a href="holders.html#static_holder_synopsis"><code>"boost/flyweight/static_holder.hpp"</code></a></li>
  78. <li><a href="holders.html#intermodule_holder_fwd_synopsis"><code>"boost/flyweight/intermodule_holder_fwd.hpp"</code></a></li>
  79. <li><a href="holders.html#intermodule_holder_synopsis"><code>"boost/flyweight/intermodule_holder.hpp"</code></a></li>
  80. </ul>
  81. </li>
  82. <li>Locking policies
  83. <ul>
  84. <li><a href="locking.html#locking_tag_synopsis"><code>"boost/flyweight/locking_tag.hpp"</code></a></li>
  85. <li><a href="locking.html#simple_locking_fwd_synopsis"><code>"boost/flyweight/simple_locking_fwd.hpp"</code></a></li>
  86. <li><a href="locking.html#simple_locking_synopsis"><code>"boost/flyweight/simple_locking.hpp"</code></a></li>
  87. <li><a href="locking.html#no_locking_fwd_synopsis"><code>"boost/flyweight/no_locking_fwd.hpp"</code></a></li>
  88. <li><a href="locking.html#no_locking_synopsis"><code>"boost/flyweight/no_locking.hpp"</code></a></li>
  89. </ul>
  90. </li>
  91. <li>Tracking policies
  92. <ul>
  93. <li><a href="tracking.html#tracking_tag_synopsis"><code>"boost/flyweight/tracking_tag.hpp"</code></a></li>
  94. <li><a href="tracking.html#refcounted_fwd_synopsis"><code>"boost/flyweight/refcounted_fwd.hpp"</code></a></li>
  95. <li><a href="tracking.html#refcounted_synopsis"><code>"boost/flyweight/refcounted.hpp"</code></a></li>
  96. <li><a href="tracking.html#no_tracking_fwd_synopsis"><code>"boost/flyweight/no_tracking_fwd.hpp"</code></a></li>
  97. <li><a href="tracking.html#no_tracking_synopsis"><code>"boost/flyweight/no_tracking.hpp"</code></a></li>
  98. </ul>
  99. </li>
  100. </ul>
  101. </p>
  102. <h2><a name="dependencies">Dependencies</a></h2>
  103. <p>
  104. In order to use the serialization capabilities of Boost.Flyweight,
  105. the appropriate Boost.Serialization library module must be linked. Other
  106. than that, Boost.Flyweight is a header-only library, requiring no additional
  107. object modules. The default <a href="locking.html#simple_locking"><code>simple_locking</code></a>
  108. locking policy introduces a dependency on the Pthreads library on those POSIX-compliant
  109. environments where the <a href="../../../config/doc/html/index.html">Boost.Config</a> macro
  110. <code>BOOST_HAS_PTHREADS</code> is set.
  111. </p>
  112. <h2>
  113. <a name="flyweight_synopsis">Header
  114. <a href="../../../../boost/flyweight.hpp"><code>"boost/flyweight.hpp"</code></a>
  115. synopsis</a>
  116. </h2>
  117. <blockquote><pre>
  118. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>&gt;</span>
  119. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>hashed_factory</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>&gt;</span>
  120. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>refcounted</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>&gt;</span>
  121. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>simple_locking</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>&gt;</span>
  122. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>flyweight</span><span class=special>/</span><span class=identifier>static_holder</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>&gt;</span>
  123. </pre></blockquote>
  124. <p>
  125. This convenience header includes the main class template
  126. <a href="flyweight.html#flyweight"><code>flyweight</code></a> along with
  127. the default components used by <code>flyweight</code>.
  128. </p>
  129. <hr>
  130. <div class="prev_link"><a href="../tutorial/lambda_expressions.html"><img src="../prev.gif" alt="annex: MPL lambda expressions" border="0"><br>
  131. Annex: MPL lambda expressions
  132. </a></div>
  133. <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
  134. Index
  135. </a></div>
  136. <div class="next_link"><a href="flyweight.html"><img src="../next.gif" alt="flyweight reference" border="0"><br>
  137. <code>flyweight</code> reference
  138. </a></div><br clear="all" style="clear: all;">
  139. <br>
  140. <p>Revised September 1st 2014</p>
  141. <p>&copy; Copyright 2006-2014 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
  142. Distributed under the Boost Software
  143. License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt">
  144. LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
  145. http://www.boost.org/LICENSE_1_0.txt</a>)
  146. </p>
  147. </body>
  148. </html>