IpAlgStrategy.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2006 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
 
#ifndef __IPALGSTRATEGY_HPP__
#define __IPALGSTRATEGY_HPP__
 
#include "IpOptionsList.hpp"
#include "IpJournalist.hpp"
#include "IpIpoptCalculatedQuantities.hpp"
#include "IpIpoptNLP.hpp"
#include "IpIpoptData.hpp"
 
namespace Ipopt
{
 
class IPOPTLIB_EXPORT AlgorithmStrategyObject: public ReferencedObject
{
public:
 
   AlgorithmStrategyObject()
      : initialize_called_(false)
   { }
 
   virtual ~AlgorithmStrategyObject()
   { }
 
   bool Initialize(
      const Journalist&          jnlst,
      IpoptNLP&                  ip_nlp,
      IpoptData&                 ip_data,
      IpoptCalculatedQuantities& ip_cq,
      const OptionsList&         options,
      const std::string&         prefix
   )
   {
      initialize_called_ = true;
      // Copy the pointers for the problem defining objects
      jnlst_ = &jnlst;
      ip_nlp_ = &ip_nlp;
      ip_data_ = &ip_data;
      ip_cq_ = &ip_cq;
 
      bool retval = InitializeImpl(options, prefix);
      if( !retval )
      {
         initialize_called_ = false;
      }
 
      return retval;
   }
 
   bool ReducedInitialize(
      const Journalist&  jnlst,
      const OptionsList& options,
      const std::string& prefix
   )
   {
      initialize_called_ = true;
      // Copy the pointers for the problem defining objects
      jnlst_ = &jnlst;
      ip_nlp_ = NULL;
      ip_data_ = NULL;
      ip_cq_ = NULL;
 
      bool retval = InitializeImpl(options, prefix);
      if( !retval )
      {
         initialize_called_ = false;
      }
 
      return retval;
   }
 
protected:
   virtual bool InitializeImpl(
      const OptionsList& options,
      const std::string& prefix
   ) = 0;
 
   const Journalist& Jnlst() const
   {
      DBG_ASSERT(initialize_called_);
      return *jnlst_;
   }
   IpoptNLP& IpNLP() const
   {
      DBG_ASSERT(initialize_called_);
      DBG_ASSERT(IsValid(ip_nlp_));
      return *ip_nlp_;
   }
   IpoptData& IpData() const
   {
      DBG_ASSERT(initialize_called_);
      DBG_ASSERT(IsValid(ip_data_));
      return *ip_data_;
   }
   IpoptCalculatedQuantities& IpCq() const
   {
      DBG_ASSERT(initialize_called_);
      DBG_ASSERT(IsValid(ip_cq_));
      return *ip_cq_;
   }
   bool HaveIpData() const
   {
      return IsValid(ip_data_);
   }
 
private:
 
   //AlgorithmStrategyObject();
 
   AlgorithmStrategyObject(
      const AlgorithmStrategyObject&
   );
 
   void operator=(
      const AlgorithmStrategyObject&
   );
 
   SmartPtr<const Journalist> jnlst_;
   SmartPtr<IpoptNLP> ip_nlp_;
   SmartPtr<IpoptData> ip_data_;
   SmartPtr<IpoptCalculatedQuantities> ip_cq_;
 
   bool initialize_called_;
};
 
} // namespace Ipopt
 
#endif