Tpetra_TieBreak.hpp

Go to the documentation of this file.

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

#ifndef TPETRA_DETAILS_TIEBREAK_HPP
#define TPETRA_DETAILS_TIEBREAK_HPP


#include "Tpetra_TieBreak_fwd.hpp"
#include "Teuchos_RCP.hpp"
#include <utility>
#include <vector>

namespace Tpetra {
namespace Details {

  template <typename LocalOrdinal, typename GlobalOrdinal>
  class TieBreak {
  public:
    struct Triplet {
      LocalOrdinal LID;
      GlobalOrdinal GID;
      int PID;
    };

    virtual bool mayHaveSideEffects () const {
      return true;
    }

    virtual ~TieBreak () = default;

    virtual std::size_t
    selectedIndex (GlobalOrdinal GID,
                   const std::vector<std::pair<int, LocalOrdinal> >& pid_and_lid) const = 0;
  };

} // namespace Details
} // namespace Tpetra

#endif // TPETRA_DETAILS_TIEBREAK_HPP