ptr_map.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. ++++++++++++++++++++++++++++++++++
  2. |Boost| Pointer Container Library
  3. ++++++++++++++++++++++++++++++++++
  4. .. |Boost| image:: boost.png
  5. Class ``ptr_map``
  6. -----------------
  7. A ``ptr_map<Key,T>`` is a pointer container that uses an underlying ``std::map<Key,void*>``
  8. to store the pointers.
  9. **Hierarchy:**
  10. - `reversible_ptr_container <reversible_ptr_container.html>`_
  11. - `associative_ptr_container <associative_ptr_container.html>`_
  12. - `ptr_set_adapter <ptr_set_adapter.html>`_
  13. - `ptr_multiset_adapter <ptr_multiset_adapter.html>`_
  14. - `ptr_map_adapter <ptr_map_adapter.html>`_
  15. - `ptr_multi_map_adapter <ptr_multimap_adapter.html>`_
  16. - `ptr_set <ptr_set.html>`_
  17. - `ptr_multi_set <ptr_multiset.html>`_
  18. - ``ptr_map``
  19. - `ptr_multimap <ptr_multimap.html>`_
  20. **Navigate:**
  21. - `home <ptr_container.html>`_
  22. - `reference <reference.html>`_
  23. **Synopsis:**
  24. .. parsed-literal::
  25. namespace boost
  26. {
  27. template
  28. <
  29. class Key,
  30. class T,
  31. class Compare = std::less<Key>,
  32. class CloneAllocator = heap_clone_allocator,
  33. class Allocator = std::allocator< std::pair<const Key,void*> >
  34. >
  35. class ptr_map : public ptr_map_adapter
  36. <
  37. T,
  38. std::map<Key,void*,Compare,Allocator>,
  39. CloneAllocator
  40. >
  41. {
  42. // see references
  43. }; // class 'ptr_map'
  44. } // namespace 'boost'
  45. .. raw:: html
  46. <hr>
  47. :Copyright: Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see LICENSE_1_0.txt__).
  48. __ http://www.boost.org/LICENSE_1_0.txt