BelosInnerSolveResult.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Belos_InnerSolverResult_hpp
#define __Belos_InnerSolverResult_hpp

#include <BelosTypes.hpp> // ReturnType
#include <map>
#include <string>

namespace Belos {

  class InnerSolveResult {
  public:
    InnerSolveResult (const ReturnType theResult,
          const int theNumRestartCycles,
          const int theTotalNumIters,
          const std::map<std::string, double>& theExtraData);

    InnerSolveResult (const ReturnType theResult,
          const int theNumRestartCycles,
          const int theTotalNumIters);

    ReturnType result() {
      return result_;
    }

    int totalNumIters() const { 
      return totalNumIters_;
    }

    int numRestartCycles() const { 
      return numRestartCycles_;
    }

    const std::map<std::string, double>& extraData () const {
      return extraData_;
    }

  private:
    ReturnType result_;
    int numRestartCycles_, totalNumIters_;
    std::map<std::string, double> extraData_;

    static ReturnType 
    validatedReturnType (const ReturnType ret);

    static int 
    requireNonNegInt (const int k);
  };

} // namespace Belos


#endif // __Belos_InnerSolverResult_hpp