heap.h
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:6k
源码类别:

通讯编程

开发平台:

Visual C++

  1. /* -*- Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */
  2. /*
  3.  * Copyright (C) 1997 by the University of Southern California
  4.  * $Id: heap.h,v 1.9 2005/08/25 18:58:02 johnh Exp $
  5.  *
  6.  * This program is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public License,
  8.  * version 2, as published by the Free Software Foundation.
  9.  *
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU General Public License along
  16.  * with this program; if not, write to the Free Software Foundation, Inc.,
  17.  * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  18.  *
  19.  *
  20.  * The copyright of this module includes the following
  21.  * linking-with-specific-other-licenses addition:
  22.  *
  23.  * In addition, as a special exception, the copyright holders of
  24.  * this module give you permission to combine (via static or
  25.  * dynamic linking) this module with free software programs or
  26.  * libraries that are released under the GNU LGPL and with code
  27.  * included in the standard release of ns-2 under the Apache 2.0
  28.  * license or under otherwise-compatible licenses with advertising
  29.  * requirements (or modified versions of such code, with unchanged
  30.  * license).  You may copy and distribute such a system following the
  31.  * terms of the GNU GPL for this module and the licenses of the
  32.  * other code concerned, provided that you include the source code of
  33.  * that other code when and as the GNU GPL requires distribution of
  34.  * source code.
  35.  *
  36.  * Note that people who make modified versions of this module
  37.  * are not obligated to grant this special exception for their
  38.  * modified versions; it is their choice whether to do so.  The GNU
  39.  * General Public License gives permission to release a modified
  40.  * version without this exception; this exception also makes it
  41.  * possible to release a modified version which carries forward this
  42.  * exception.
  43.  *
  44.  */
  45. /* 
  46.  * @(#) $Header: /cvsroot/nsnam/ns-2/common/heap.h,v 1.9 2005/08/25 18:58:02 johnh Exp $ (USC/ISI)
  47.  */
  48. #ifndef ns_heap_h
  49. #define ns_heap_h
  50. #define HEAP_DEFAULT_SIZE 32
  51. // This code has a long and rich history.  It was stolen from the MaRS-2.0
  52. // distribution, that had in its turn acquired it from the NetSim
  53. // distribution (or so I have been told).  It has been customised for
  54. // event queue handling.  I, Kannan, added prolific comments to it in order
  55. // to better understand the data structure for myself, and turned into
  56. // a standalone C++ class that you see in this version now.
  57. typedef double heap_key_t;
  58. typedef unsigned long heap_secondary_key_t;
  59. // This code has (atleast?) one flaw:  It does not check for memory allocated,
  60. // especially in the constructor, and in heap_insert() when trying
  61. // to resize the h_elems[] array.
  62. class Heap 
  63. {
  64. struct Heap_elem {
  65. heap_key_t he_key;
  66. heap_secondary_key_t he_s_key;
  67. void* he_elem;
  68. } *h_elems;
  69. unsigned int    h_s_key;
  70. unsigned int h_size;
  71. unsigned int h_maxsize;
  72. unsigned int h_iter;
  73. unsigned int parent(unsigned int i) { return ((i - 1) / 2); }
  74. unsigned int left(unsigned int i) { return ((i * 2) + 1); }
  75. unsigned int right(unsigned int i) { return ((i + 1) * 2); }
  76. void swap(unsigned int i, unsigned int j) {
  77. // swap elems[i] with elems[j] in this
  78. Heap_elem __he = h_elems[i];
  79. h_elems[i] = h_elems[j];
  80. h_elems[j] = __he;
  81. return;
  82. };
  83. unsigned int KEY_LESS_THAN(heap_key_t k1, heap_secondary_key_t ks1,
  84.       heap_key_t k2, heap_secondary_key_t ks2) {
  85. return (k1 < k2) || ((k1==k2)&&(ks1<ks2));
  86. };
  87. unsigned int KEY_LESS_OR_EQUAL_THAN(heap_key_t k1, heap_key_t k2) {
  88. return (k1 <= k2);
  89. };
  90. public:
  91. Heap(int size=HEAP_DEFAULT_SIZE);
  92. ~Heap();
  93. /*
  94.  * int heap_member(Heap *h, void *elem): O(n) algorithm.
  95.  */
  96. int heap_member(void* elem);
  97. /*
  98.  * int heap_delete(Heap *h, void *elem): O(n) algorithm
  99.  *
  100.  * Returns 1 for success, 0 otherwise.
  101.  */
  102. int heap_delete(void* elem);
  103. /*
  104.  * Couple of functions to support iterating through all things on the
  105.  * heap without having to know what a heap looks like.  To be used as
  106.  * follows:
  107.  *
  108.  * for (elem = heap_iter_init(h); elem; elem = heap_iter(h))
  109.  * Do whatever to the elem.
  110.  *
  111.  * You cannot use heap_iter to do anything but inspect the heap.  If
  112.  * heap_insert(), heap_extract_min(), or heap_delete() are called
  113.  * while iterating through the heap, all bets are off.
  114.  *
  115.  * Tue Nov 14 20:17:59 PST 1995 -- kva
  116.  * Actually now, heap_create() initialises h_iter correctly,
  117.  * and heap_iter() correctly resets h_iter
  118.  * when the heap is traversed, So, we do not really need
  119.  * heap_iter_init() anymore, except to break off a current
  120.  * iteration and restart.
  121.  */
  122. void* heap_iter_init() {
  123. h_iter = 1;
  124. return heap_min();
  125. };
  126. void* heap_iter() {
  127. if (h_iter >= h_size) {
  128. h_iter = 0;
  129. return 0;
  130. } else {
  131. return h_elems[h_iter++].he_elem;
  132. }
  133. };
  134. /*
  135.  * void heap_insert(Heap *h, heap_key_t *key, void *elem)
  136.  *
  137.  * Insert <key, elem> into heap h.
  138.  * Adjust heap_size if we hit the limit.
  139.  */
  140. void heap_insert(heap_key_t key, void* elem);
  141. /*
  142.  * void *heap_min(Heap *h)
  143.  *
  144.  * Returns the smallest element in the heap, if it exists,
  145.  * NULL otherwise.   The element is still in the heap.
  146.  */
  147. void* heap_min() {
  148. return (h_size > 0 ? h_elems[0].he_elem : 0);
  149. };
  150. /*
  151.  * void *heap_extract_min(Heap *h)
  152.  *
  153.  * Returns the smallest element in the heap, if it exists.
  154.  * NULL otherwise.
  155.  */
  156. void* heap_extract_min();
  157. };
  158. #endif /* ns_heap_h */