ceph/src/boost/libs/ptr_container/doc/ptr_set.rst

   1 ++++++++++++++++++++++++++++++++++
   2  |Boost| Pointer Container Library
   3 ++++++++++++++++++++++++++++++++++
   4
   5 .. |Boost| image:: boost.png
   6
   7 Class ``ptr_set``
   8 -----------------
   9
  10 A ``ptr_set<T>`` is a pointer container that uses an underlying ``std::set<void*>``
  11 to store the pointers.
  12
  13 **Hierarchy:**
  14
  15 - `reversible_ptr_container <reversible_ptr_container.html>`_
  16
  17   - `associative_ptr_container <associative_ptr_container.html>`_
  18
  19     - `ptr_set_adapter <ptr_set_adapter.html>`_
  20     - `ptr_multiset_adapter  <ptr_multiset_adapter.html>`_
  21     - `ptr_map_adapter <ptr_map_adapter.html>`_
  22     - `ptr_multi_map_adapter <ptr_multimap_adapter.html>`_
  23
  24       - ``ptr_set``
  25       - `ptr_multi_set <ptr_multiset.html>`_
  26       - `ptr_map <ptr_map.html>`_
  27       - `ptr_multimap <ptr_multimap.html>`_
  28
  29
  30 **See also:**
  31
  32 - `void_ptr_indirect_fun <indirect_fun.html>`_
  33
  34 **Navigate:**
  35
  36 - `home <ptr_container.html>`_
  37 - `reference <reference.html>`_
  38
  39
  40 **Synopsis:**
  41
  42 .. parsed-literal::
  43
  44
  45         namespace boost
  46         {
  47
  48             template
  49             <
  50                 class Key,
  51                 class Compare        = std::less<Key>,
  52                 class CloneAllocator = heap_clone_allocator,
  53                 class Allocator      = std::allocator<void*>
  54             >
  55             class ptr_set : public  ptr_set_adapter
  56                                     <
  57                                         Key,
  58                                         std::set<void*,
  59                                         void_ptr_indirect_fun<Compare,Key>,Allocator>,
  60                                         CloneAllocator
  61                                     >
  62             {
  63                 // see references
  64
  65             }; //  class 'ptr_set'
  66
  67         } // namespace 'boost'
  68
  69 **Remarks:**
  70
  71 - Using ``nullable<T>`` as ``Key`` is meaningless and is not allowed
  72
  73 .. raw:: html
  74
  75         <hr>
  76
  77 :Copyright:     Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see LICENSE_1_0.txt__).
  78
  79 __ http://www.boost.org/LICENSE_1_0.txt
  80
  81