/home/brandes/workspace/LAMA/src/lama/solver/criteria/ResidualStagnation.hpp

Go to the documentation of this file.

#ifndef LAMA_RESIDUALSTAGNATION_HPP_
#define LAMA_RESIDUALSTAGNATION_HPP_

// for dll_import
#include <lama/config.hpp>

// base classes
#include <lama/solver/criteria/Criterion.hpp>

// others
#include <lama/LAMATypes.hpp>

#include <lama/norm/Norm.hpp>

namespace lama
{

class IterativeSolver;

class LAMA_DLL_IMPORTEXPORT ResidualStagnation : public Criterion
{

public:

    ResidualStagnation( NormPtr norm );

    ResidualStagnation(
        NormPtr norm,
        IndexType lookback,
        Scalar precision );

    ResidualStagnation( const ResidualStagnation &other );

    virtual ~ResidualStagnation();

    virtual Criterion* copy() const;

    virtual bool isSatisfied( const IterativeSolver& solver );

    IndexType getLookback() const;

    const NormPtr getNorm() const;

    const Scalar getPrecision() const;

    void setLookback( const IndexType lookback );

    void setPrecision( const Scalar precision );

    virtual void writeAt(std::ostream& stream) const;
private:

    const NormPtr mNorm;

    IndexType mLookback;

    std::vector<Scalar> mLastResidualNorms;

    IndexType mNextEntry;

    bool mEntriesReady;

    Scalar mPrecision;
};

}// namespace lama

#endif // LAMA_RESIDUALSTAGNATION_HPP_