GenericHeap.h

/*  _________________________________________________________________________
 *
 *  UTILIB: A utility library for developing portable C++ codes.
 *  Copyright (c) 2001, Sandia National Laboratories.
 *  This software is distributed under the GNU Lesser General Public License.
 *  For more information, see the README file in the top UTILIB directory.
 *  _________________________________________________________________________
 */

// 
// GenericHeap.H
//
/* 
 * \class GenericHeap
 *
 * A heap class that uses a general set of classes for keys.
 * The \c GenericHeap class is derived from \c AbstractHeap,
 * which defines the basic operations of the heap. The keys
 * are assumed to be classes for which the following operations are
 * defined:
 *      int compare(KEY& key) const
 *      int write(ostream& os) const
 *      int read(istream& is)
 *
 * \sa SimpleHeap
 */


#ifndef __GenericHeap_h
#define __GenericHeap_h

#ifdef __GNUC__
#pragma interface
#endif

#include "_generic.h"
#include "AbstractHeap.h"
 
template <class T>
class UTILIB_API GenericHeap;

template <class T>
class GenericHeapItem 
{
  friend class AbstractHeap<GenericHeapItem<T>,T>;

public:

  void write(ostream& os) {Keyptr->write(os);}
  T& key() {return *Keyptr;}
  int compare(T& key)
                {return Keyptr->compare(key);}

private:

  T* Keyptr;
  int element;
  GenericHeapItem(T* Key_) : Keyptr(Key_), element(0) {}
};



template <class T>
class GenericHeap : public AbstractHeap<GenericHeapItem<T>,T>
{
public:

  explicit GenericHeap(const char* nameBuff = "Unnamed", 
                int initSize=defaultSize, int quantumChoice = defaultQuantum)
        : AbstractHeap<GenericHeapItem<T>,T>(nameBuff,initSize,quantumChoice) {}

};

#endif