IpConvCheck.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2009 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpConvCheck.hpp 1861 2010-12-21 21:34:47Z andreasw $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPCONVCHECK_HPP__
#define __IPCONVCHECK_HPP__

#include "IpAlgStrategy.hpp"

namespace Ipopt
{

  class ConvergenceCheck : public AlgorithmStrategyObject
  {
  public:
    ConvergenceCheck()
    {}

    virtual ~ConvergenceCheck()
    {}

    enum ConvergenceStatus {
      CONTINUE,
      CONVERGED,
      CONVERGED_TO_ACCEPTABLE_POINT,
      MAXITER_EXCEEDED,
      CPUTIME_EXCEEDED,
      DIVERGING,
      USER_STOP,
      FAILED
    };

    virtual bool InitializeImpl(const OptionsList& options,
                                const std::string& prefix) = 0;

    virtual ConvergenceStatus
    CheckConvergence(bool call_intermediate_callback = true) = 0;

    virtual bool CurrentIsAcceptable()=0;

  private:
    //    ConvergenceCheck();

    ConvergenceCheck(const ConvergenceCheck&);

    void operator=(const ConvergenceCheck&);

  };

} // namespace Ipopt

#endif