Tpetra Matrix/Vector Services Version of the Day
Tpetra_Details_FixedHashTable_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_DETAILS_FIXEDHASHTABLE_DECL_HPP
00045 #define TPETRA_DETAILS_FIXEDHASHTABLE_DECL_HPP
00046 
00047 #include <Teuchos_Describable.hpp>
00048 #include <Tpetra_ConfigDefs.hpp>
00049 #include <Teuchos_ArrayRCP.hpp>
00050 
00051 namespace Tpetra {
00052 namespace Details {
00053 
00078 template<typename KeyType, typename ValueType>
00079 class FixedHashTable : public Teuchos::Describable {
00080 public:
00086   FixedHashTable (const ArrayView<const KeyType>& keys);
00087 
00095   FixedHashTable (const ArrayView<const KeyType>& keys,
00096                   const ValueType startingValue);
00097 
00103   FixedHashTable (const ArrayView<const KeyType>& keys,
00104                   const ArrayView<const ValueType>& vals);
00105 
00107   FixedHashTable (const FixedHashTable& obj);
00108 
00110   ValueType get (const KeyType key) const;
00111 
00113   bool hasDuplicateKeys () const {
00114     return hasDuplicateKeys_;
00115   }
00116 
00118 
00119 
00120   std::string description() const;
00121 
00123   void
00124   describe (Teuchos::FancyOStream &out,
00125             const Teuchos::EVerbosityLevel verbLevel=
00126             Teuchos::Describable::verbLevel_default) const;
00128 
00129 private:
00130   typedef Array<int>::size_type size_type;
00131 
00136   KeyType size_;
00138   ArrayRCP<const size_type> ptr_;
00140   ArrayRCP<const std::pair<KeyType, ValueType> > val_;
00144   const size_type* rawPtr_;
00148   const std::pair<KeyType, ValueType>* rawVal_;
00149 
00151   bool hasDuplicateKeys_;
00152 
00157   void
00158   init (const ArrayView<const KeyType>& keys,
00159         const ValueType startingValue);
00160 
00166   void
00167   init (const ArrayView<const KeyType>& keys,
00168         const ArrayView<const ValueType>& vals);
00169 
00171   int hashFunc (const KeyType key) const;
00172 
00173   int getRecommendedSize (const int size);
00174 };
00175 
00176 } // Details namespace
00177 
00178 } // Tpetra namespace
00179 
00180 #endif // TPETRA_DETAILS_FIXEDHASHTABLE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines