contrib/libstdc++/include/ext/pb_ds/priority_queue.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 priority_queue.hpp
  44  * Contains priority_queues.
  45  */
  46
  47 #ifndef PB_DS_PRIORITY_QUEUE_HPP
  48 #define PB_DS_PRIORITY_QUEUE_HPP
  49
  50 #include <ext/pb_ds/tag_and_trait.hpp>
  51 #include <ext/pb_ds/detail/priority_queue_base_dispatch.hpp>
  52 #include <ext/pb_ds/detail/standard_policies.hpp>
  53
  54 namespace pb_ds
  55 {
  56   // A priority queue.
  57   template<typename Value_Type,
  58            typename Cmp_Fn = std::less<Value_Type>,
  59            typename Tag = pairing_heap_tag,
  60            typename Allocator = std::allocator<char> >
  61   class priority_queue
  62     : public detail::priority_queue_base_dispatch<Value_Type,Cmp_Fn,Tag,Allocator>::type
  63   {
  64   private:
  65     typedef typename detail::priority_queue_base_dispatch<Value_Type,Cmp_Fn,Tag,Allocator>::type base_type;
  66
  67   public:
  68     typedef Value_Type                                  value_type;
  69     typedef Cmp_Fn                                      cmp_fn;
  70     typedef Tag                                         container_category;
  71     typedef Allocator                                   allocator;
  72     typedef typename allocator::size_type               size_type;
  73     typedef typename allocator::difference_type         difference_type;
  74
  75     typedef typename allocator::template rebind<value_type>::other value_rebind;
  76     typedef typename value_rebind::reference            reference;
  77     typedef typename value_rebind::const_reference      const_reference;
  78     typedef typename value_rebind::pointer              pointer;
  79     typedef typename value_rebind::const_pointer        const_pointer;
  80
  81     typedef typename base_type::const_point_iterator const_point_iterator;
  82     typedef typename base_type::point_iterator          point_iterator;
  83     typedef typename base_type::const_iterator          const_iterator;
  84     typedef typename base_type::iterator                iterator;
  85
  86     priority_queue() { }
  87
  88     // Constructor taking some policy objects. r_cmp_fn will be copied
  89     // by the Cmp_Fn object of the container object.
  90     priority_queue(const cmp_fn& r_cmp_fn) : base_type(r_cmp_fn) { }
  91
  92     // Constructor taking __iterators to a range of value_types. The
  93     // value_types between first_it and last_it will be inserted into
  94     // the container object.
  95     template<typename It>
  96     priority_queue(It first_it, It last_it)
  97     { base_type::copy_from_range(first_it, last_it); }
  98
  99     // Constructor taking __iterators to a range of value_types and
 100     // some policy objects The value_types between first_it and
 101     // last_it will be inserted into the container object. r_cmp_fn
 102     // will be copied by the cmp_fn object of the container object.
 103     template<typename It>
 104     priority_queue(It first_it, It last_it, const cmp_fn& r_cmp_fn)
 105     : base_type(r_cmp_fn)
 106     { base_type::copy_from_range(first_it, last_it); }
 107
 108     priority_queue(const priority_queue& other)
 109     : base_type((const base_type& )other) { }
 110
 111     virtual
 112     ~priority_queue() { }
 113
 114     priority_queue&
 115     operator=(const priority_queue& other)
 116     {
 117       if (this !=& other)
 118         {
 119           priority_queue tmp(other);
 120           swap(tmp);
 121         }
 122       return *this;
 123     }
 124
 125     void
 126     swap(priority_queue& other)
 127     { base_type::swap(other); }
 128   };
 129 } // namespace pb_ds
 130
 131 #endif