IpIterativeSolverTerminationTester.hpp

Go to the documentation of this file.

// Copyright (C) 2008 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpIterativeSolverTerminationTester.hpp 1861 2010-12-21 21:34:47Z andreasw $
//
// Authors:  Andreas Waechter            IBM    2008-09-19

#ifndef __IPITERATIVESOLVERTERMINATIONTESTER_HPP__
#define __IPITERATIVESOLVERTERMINATIONTESTER_HPP__

#include "IpAlgStrategy.hpp"
#include "IpInexactCq.hpp"

namespace Ipopt
{

  class IterativeSolverTerminationTester: public AlgorithmStrategyObject
  {
  public:
    enum ETerminationTest {
      CONTINUE,
      TEST_1_SATISFIED,
      TEST_2_SATISFIED,
      TEST_3_SATISFIED,
      MODIFY_HESSIAN,
      OTHER_SATISFIED
    };

    IterativeSolverTerminationTester()
    {}

    virtual ~IterativeSolverTerminationTester()
    {}

    /* overloaded from AlgorithmStrategyObject */
    virtual bool InitializeImpl(const OptionsList& options,
                                const std::string& prefix) = 0;


    virtual bool InitializeSolve() = 0;

    virtual ETerminationTest TestTermination(Index ndim, const Number* sol,
        const Number* resid, Index iter,
        Number norm2_rhs) = 0;

    virtual void Clear() = 0;

    const Journalist& GetJnlst() const
    {
      return Jnlst();
    }

    virtual Index GetSolverIterations() const = 0;

  protected:
    void GetVectors(Index ndim, const Number* array,
                    SmartPtr<const Vector>& comp_x,
                    SmartPtr<const Vector>& comp_s,
                    SmartPtr<const Vector>& comp_c,
                    SmartPtr<const Vector>& comp_d);

    InexactData& InexData()
    {
      InexactData& inexact_data =
        static_cast<InexactData&>(IpData().AdditionalData());
      DBG_ASSERT(dynamic_cast<InexactData*>(&IpData().AdditionalData()));
      return inexact_data;
    }

    InexactCq& InexCq()
    {
      InexactCq& inexact_cq =
        static_cast<InexactCq&>(IpCq().AdditionalCq());
      DBG_ASSERT(dynamic_cast<InexactCq*>(&IpCq().AdditionalCq()));
      return inexact_cq;
    }

  private:

    IterativeSolverTerminationTester& operator=(const IterativeSolverTerminationTester&);
  };

} // namespace Ipopt

#endif