GenericHashTable.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.
 *  _________________________________________________________________________
 */

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


#ifndef __GenericHashTable_h
#define __GenericHashTable_h

#ifdef __GNUC__
#pragma interface
#endif

#include "AbstractHashTable.h"
 
template <class T>
class UTILIB_API GenericHashTable;



template <class T>
class GenericHashTableItem 
{
  friend class AbstractHashTable<GenericHashTableItem<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;
  GenericHashTableItem(T* Key_) : Keyptr(Key_) {}
};



template <class T>
class GenericHashTable : public AbstractHashTable<GenericHashTableItem<T>,T>
{
public:

  explicit GenericHashTable(const char* nameBuff = "Unnamed")
        : AbstractHashTable<GenericHashTableItem<T>,T>(nameBuff) {}

  explicit GenericHashTable(size_type init_size, 
                                                const char* nameBuff = "Unnamed")
        : AbstractHashTable<GenericHashTableItem<T>,T>(init_size, nameBuff) {}
};

#endif