Tpetra_Details_FixedHashTable_decl.hpp

/*
// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER
*/

#ifndef TPETRA_DETAILS_FIXEDHASHTABLE_DECL_HPP
#define TPETRA_DETAILS_FIXEDHASHTABLE_DECL_HPP

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

namespace Tpetra {
namespace Details {

template<typename KeyType, typename ValueType>
class FixedHashTable : public Teuchos::Describable {
public:
  FixedHashTable (const ArrayView<const KeyType>& keys);

  FixedHashTable (const ArrayView<const KeyType>& keys,
                  const ValueType startingValue);

  FixedHashTable (const ArrayView<const KeyType>& keys,
                  const ArrayView<const ValueType>& vals);

  FixedHashTable (const FixedHashTable& obj);

  ValueType get (const KeyType key) const;

  bool hasDuplicateKeys () const {
    return hasDuplicateKeys_;
  }



  std::string description() const;

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

private:
  typedef Array<int>::size_type size_type;

  KeyType size_;
  ArrayRCP<const size_type> ptr_;
  ArrayRCP<const std::pair<KeyType, ValueType> > val_;
  const size_type* rawPtr_;
  const std::pair<KeyType, ValueType>* rawVal_;

  bool hasDuplicateKeys_;

  void
  init (const ArrayView<const KeyType>& keys,
        const ValueType startingValue);

  void
  init (const ArrayView<const KeyType>& keys,
        const ArrayView<const ValueType>& vals);

  int hashFunc (const KeyType key) const;

  int getRecommendedSize (const int size);
};

} // Details namespace

} // Tpetra namespace

#endif // TPETRA_DETAILS_FIXEDHASHTABLE_DECL_HPP