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

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