Tpetra_HashTable_decl.hpp

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_HASHTABLE_DECL_HPP
#define TPETRA_HASHTABLE_DECL_HPP

#include <Teuchos_Describable.hpp>
#include "Tpetra_ConfigDefs.hpp"

namespace Tpetra {
namespace Details {

template <typename KeyType, typename ValueType>
class HashTable : public Teuchos::Describable {
  struct Node {
    KeyType Key;      
    ValueType Value;  
    Node* Ptr;        

    Node(const KeyType key = 0, const ValueType value = 0, Node* ptr = NULL)
      : Key(key)
      , Value(value)
      , Ptr(ptr) {}

   private:
    Node(const Node& src)
      : Key(src.Key)
      , Value(src.Value)
      , Ptr(src.Ptr) {}

    Node& operator=(const Node& src) {
      // We may safely omit the usual check for this == &src.
      Key   = src.Key;
      Value = src.Value;
      Ptr   = src.Ptr;
      return *this;
    }
  };

  Node** Container_;  
  KeyType Size_;
  unsigned int Seed_;  
#ifdef HAVE_TPETRA_DEBUG
  int maxc_;  // Max size of the list among all entries w/ collisions. debug only.
  int nc_;    // Number of entries with collisions; use only in debug mode.
#endif        // HAVE_TPETRA_DEBUG

  int hashFunc(const KeyType key);

  int getRecommendedSize(const int size);

 public:
  HashTable(const int size, const unsigned int seed = (2654435761U));

  HashTable(const HashTable& obj);
  ~HashTable();

  void add(const KeyType key, const ValueType value);

  ValueType get(const KeyType key);


  std::string description() const;

  void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;

 private:
  HashTable<KeyType, ValueType>&
  operator=(const HashTable<KeyType, ValueType>& source);
};

}  // namespace Details

}  // namespace Tpetra

#endif