Tpetra Matrix/Vector Services Version of the Day
Tpetra_HashTable_decl.hpp
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //          Tpetra: Templated Linear Algebra Services Package
00006 //                 Copyright (2008) Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 // @HEADER
00042 */
00043 
00044 #ifndef TPETRA_HASHTABLE_DECL_HPP
00045 #define TPETRA_HASHTABLE_DECL_HPP
00046 
00047 #include <Teuchos_Describable.hpp>
00048 #include "Tpetra_ConfigDefs.hpp"
00049 
00050 namespace Tpetra {
00051 namespace Details {
00052 
00065 template<typename KeyType, typename ValueType>
00066 class HashTable : public Teuchos::Describable {
00068   struct Node {
00069     KeyType Key; 
00070     ValueType Value; 
00071     Node * Ptr; 
00072 
00073     Node (const KeyType key = 0, const ValueType value = 0, Node * ptr = NULL)
00074       : Key(key), Value(value), Ptr(ptr) {}
00075 
00076   private:
00077     Node (const Node& src) : Key(src.Key), Value(src.Value), Ptr(src.Ptr) {}
00078 
00079     Node& operator= (const Node& src) {
00080       // We may safely omit the usual check for this == &src.
00081       Key = src.Key;
00082       Value = src.Value;
00083       Ptr = src.Ptr;
00084       return *this;
00085     }
00086   };
00087 
00088   Node ** Container_; 
00089   KeyType Size_; 
00090   unsigned int Seed_; 
00091 #ifdef HAVE_TEUCHOS_DEBUG
00092   int maxc_; // Max size of the list among all entries w/ collisions. debug only.
00093   int nc_;   // Number of entries with collisions; use only in debug mode.
00094 #endif // HAVE_TEUCHOS_DEBUG
00095 
00098   int hashFunc( const KeyType key );
00099 
00100   int getRecommendedSize( const int size );
00101 
00102 public:
00109   HashTable (const int size, const unsigned int seed = (2654435761U));
00110 
00111   HashTable (const HashTable& obj);
00112   ~HashTable();
00113 
00115   void add (const KeyType key, const ValueType value);
00116 
00118   ValueType get (const KeyType key);
00119 
00121 
00122 
00123   std::string description() const;
00124 
00126   void
00127   describe (Teuchos::FancyOStream &out,
00128             const Teuchos::EVerbosityLevel verbLevel=
00129             Teuchos::Describable::verbLevel_default) const;
00131 
00132 private:
00134   HashTable<KeyType,ValueType>&
00135   operator= (const HashTable<KeyType,ValueType>& source);
00136 };
00137 
00138 } // Details namespace
00139 
00140 } // Tpetra namespace
00141 
00142 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines