IpBacktrackingLSAcceptor.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2007 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13
//           Andreas Waechter                 IBM    2005-10-13
//               derived file from IpFilterLineSearch.hpp
 
#ifndef __IPBACKTRACKINGLSACCEPTOR_HPP__
#define __IPBACKTRACKINGLSACCEPTOR_HPP__
 
#include "IpAlgStrategy.hpp"
 
namespace Ipopt
{
 
class BacktrackingLSAcceptor: public AlgorithmStrategyObject
{
public:
 
   BacktrackingLSAcceptor()
   { }
 
   virtual ~BacktrackingLSAcceptor()
   { }
 
   virtual bool InitializeImpl(
      const OptionsList& options,
      const std::string& prefix
   ) = 0;
 
   virtual void Reset() = 0;
 
   virtual void InitThisLineSearch(
      bool in_watchdog
   ) = 0;
 
   virtual void PrepareRestoPhaseStart() = 0;
 
   virtual Number CalculateAlphaMin() = 0;
 
   virtual bool CheckAcceptabilityOfTrialPoint(
      Number alpha_primal
   ) = 0;
 
   virtual bool TrySecondOrderCorrection(
      Number                    alpha_primal_test,
      Number&                   alpha_primal,
      SmartPtr<IteratesVector>& actual_delta
   ) = 0;
 
   virtual bool TryCorrector(
      Number                    alpha_primal_test,
      Number&                   alpha_primal,
      SmartPtr<IteratesVector>& actual_delta
   ) = 0;
 
   virtual char UpdateForNextIteration(
      Number alpha_primal_test
   ) = 0;
 
   virtual void StartWatchDog() = 0;
 
   virtual void StopWatchDog() = 0;
 
   virtual bool RestoredIterate()
   {
      return false;
   }
 
   virtual bool NeverRestorationPhase()
   {
      return false;
   }
 
   virtual bool DoFallback()
   {
      return false;
   }
 
   virtual Number ComputeAlphaForY(
      Number                    /*alpha_primal*/,
      Number                    /*alpha_dual*/,
      SmartPtr<IteratesVector>& /*delta*/
   )
   {
      THROW_EXCEPTION(OPTION_INVALID, "Value \"acceptor\" for option \"alpha_for_y\" not valid for this line search.");
      return -1.;
   }
 
   virtual bool HasComputeAlphaForY() const
   {
      return false;
   }
 
   static void RegisterOptions(
      SmartPtr<RegisteredOptions> roptions
   );
 
private:
 
   BacktrackingLSAcceptor(
      const BacktrackingLSAcceptor&
   );
 
   void operator=(
      const BacktrackingLSAcceptor&
   );
};
 
} // namespace Ipopt
 
#endif