ptr_set.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. ++++++++++++++++++++++++++++++++++
  2. |Boost| Pointer Container Library
  3. ++++++++++++++++++++++++++++++++++
  4. .. |Boost| image:: boost.png
  5. Class ``ptr_set``
  6. -----------------
  7. A ``ptr_set<T>`` is a pointer container that uses an underlying ``std::set<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``
  17. - `ptr_multi_set <ptr_multiset.html>`_
  18. - `ptr_map <ptr_map.html>`_
  19. - `ptr_multimap <ptr_multimap.html>`_
  20. **See also:**
  21. - `void_ptr_indirect_fun <indirect_fun.html>`_
  22. **Navigate:**
  23. - `home <ptr_container.html>`_
  24. - `reference <reference.html>`_
  25. **Synopsis:**
  26. .. parsed-literal::
  27. namespace boost
  28. {
  29. template
  30. <
  31. class Key,
  32. class Compare = std::less<Key>,
  33. class CloneAllocator = heap_clone_allocator,
  34. class Allocator = std::allocator<void*>
  35. >
  36. class ptr_set : public ptr_set_adapter
  37. <
  38. Key,
  39. std::set<void*,
  40. void_ptr_indirect_fun<Compare,Key>,Allocator>,
  41. CloneAllocator
  42. >
  43. {
  44. // see references
  45. }; // class 'ptr_set'
  46. } // namespace 'boost'
  47. **Remarks:**
  48. - Using ``nullable<T>`` as ``Key`` is meaningless and is not allowed
  49. .. raw:: html
  50. <hr>
  51. :Copyright: Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see LICENSE_1_0.txt__).
  52. __ http://www.boost.org/LICENSE_1_0.txt