Tpetra_Directory_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_DIRECTORY_DECL_HPP
#define TPETRA_DIRECTORY_DECL_HPP
 
#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Map_decl.hpp"
#include "Tpetra_DirectoryImpl_decl.hpp"
#include "Tpetra_TieBreak.hpp"
#include <Teuchos_Describable.hpp>
 
namespace Tpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class Directory : public Teuchos::Describable {
 public:
  typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;



  Directory();

  ~Directory();

  void initialize(const map_type& map);

  void
  initialize(const map_type& map,
             const Tpetra::Details::TieBreak<LocalOrdinal, GlobalOrdinal>& tieBreak);

  bool initialized() const;




  std::string description() const;



  LookupStatus
  getDirectoryEntries(const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
                      const Teuchos::ArrayView<int>& nodeIDs) const;

  LookupStatus
  getDirectoryEntries(const map_type& map,
                      const Teuchos::ArrayView<const GlobalOrdinal>& globalIDs,
                      const Teuchos::ArrayView<int>& nodeIDs,
                      const Teuchos::ArrayView<LocalOrdinal>& localIDs) const;

  bool isOneToOne(const map_type& map) const;

 private:
  typedef ::Tpetra::Details::Directory<LocalOrdinal, GlobalOrdinal, Node> base_type;

  const base_type* impl_;

  Directory(const Directory<LocalOrdinal, GlobalOrdinal, Node>& directory);
 
  template <class LO, class GO, class N>
  friend class Directory;

  Directory<LocalOrdinal, GlobalOrdinal, Node>&
  operator=(const Directory<LocalOrdinal, GlobalOrdinal, Node>& source);
};  // class Directory
 
}  // namespace Tpetra
 
#endif  // TPETRA_DIRECTORY_DECL_HPP