BelosInnerSolveResult.hpp

Go to the documentation of this file.

//@HEADER
// ************************************************************************
//
//                 Belos: Block Linear Solvers Package
//                  Copyright 2004 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 __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