libstdc++-v3/include/ext/pb_ds/detail/binomial_heap_/binomial_heap_.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 2, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  32
  33 // Permission to use, copy, modify, sell, and distribute this software
  34 // is hereby granted without fee, provided that the above copyright
  35 // notice appears in all copies, and that both that copyright notice
  36 // and this permission notice appear in supporting documentation. None
  37 // of the above authors, nor IBM Haifa Research Laboratories, make any
  38 // representation about the suitability of this software for any
  39 // purpose. It is provided "as is" without express or implied
  40 // warranty.
  41
  42 /**
  43  * @file binomial_heap_.hpp
  44  * Contains an implementation class for a binomial heap.
  45  */
  46
  47 /*
  48  * Binomial heap.
  49  * Vuillemin J is the mastah.
  50  * Modified from CLRS.
  51  */
  52
  53 #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
  54 #include <cassert>
  55 #endif // #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
  56 #include <ext/pb_ds/detail/cond_dealtor.hpp>
  57 #include <ext/pb_ds/detail/type_utils.hpp>
  58 #include <ext/pb_ds/detail/binomial_heap_base_/binomial_heap_base_.hpp>
  59
  60 namespace pb_ds
  61 {
  62   namespace detail
  63   {
  64
  65 #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
  66 #define PB_DS_DBG_ASSERT(X) assert(X)
  67 #define PB_DS_DBG_VERIFY(X) assert(X)
  68 #define PB_DS_DBG_ONLY(X) X
  69 #else // #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
  70 #define PB_DS_DBG_ASSERT(X)
  71 #define PB_DS_DBG_VERIFY(X) {if((X)==0);}
  72 #define PB_DS_DBG_ONLY(X) ;
  73 #endif // #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
  74
  75 #define PB_DS_CLASS_T_DEC                                               \
  76     template<typename Value_Type, class Cmp_Fn, class Allocator>
  77
  78 #define PB_DS_CLASS_C_DEC                                       \
  79     binomial_heap_<                                             \
  80                                                 Value_Type,     \
  81                                                 Cmp_Fn,         \
  82                                                 Allocator>
  83
  84 #define PB_DS_BASE_C_DEC                                                \
  85     binomial_heap_base_<                                        \
  86                                                         Value_Type,     \
  87                                                         Cmp_Fn,         \
  88                                                         Allocator>
  89
  90     /**
  91      * class description = "8y|\|0|\/|i41 h34p 74813">
  92      **/
  93     template<typename Value_Type, class Cmp_Fn, class Allocator>
  94     class binomial_heap_ : public PB_DS_BASE_C_DEC
  95     {
  96
  97     private:
  98       typedef PB_DS_BASE_C_DEC base_type;
  99
 100       typedef typename base_type::node_pointer node_pointer;
 101
 102       typedef typename base_type::const_node_pointer const_node_pointer;
 103
 104     public:
 105
 106       typedef typename Allocator::size_type size_type;
 107
 108       typedef typename Allocator::difference_type difference_type;
 109
 110       typedef Value_Type value_type;
 111
 112       typedef typename base_type::pointer pointer;
 113
 114       typedef typename base_type::const_pointer const_pointer;
 115
 116       typedef typename base_type::reference reference;
 117
 118       typedef typename base_type::const_reference const_reference;
 119
 120       typedef typename base_type::const_point_iterator const_point_iterator;
 121
 122       typedef typename base_type::point_iterator point_iterator;
 123
 124       typedef typename base_type::const_iterator const_iterator;
 125
 126       typedef typename base_type::iterator iterator;
 127
 128       typedef typename base_type::cmp_fn cmp_fn;
 129
 130       typedef typename base_type::allocator allocator;
 131
 132     public:
 133
 134       binomial_heap_();
 135
 136       binomial_heap_(const Cmp_Fn& r_cmp_fn);
 137
 138       binomial_heap_(const PB_DS_CLASS_C_DEC& other);
 139
 140       ~binomial_heap_();
 141
 142     protected:
 143 #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
 144
 145       void
 146       assert_valid() const;
 147
 148 #endif // #ifdef PB_DS_BINOMIAL_HEAP_DEBUG_
 149     };
 150
 151 #include <ext/pb_ds/detail/binomial_heap_/constructors_destructor_fn_imps.hpp>
 152 #include <ext/pb_ds/detail/binomial_heap_/debug_fn_imps.hpp>
 153
 154 #undef PB_DS_CLASS_C_DEC
 155
 156 #undef PB_DS_CLASS_T_DEC
 157
 158 #undef PB_DS_BASE_C_DEC
 159
 160 #undef PB_DS_DBG_ASSERT
 161 #undef PB_DS_DBG_VERIFY
 162 #undef PB_DS_DBG_ONLY
 163
 164   } // namespace detail
 165 } // namespace pb_ds