IpIpoptApplication.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 Common Public License.
//
// $Id: IpIpoptApplication.hpp 759 2006-07-07 03:07:08Z andreasw $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPIPOPTAPPLICATION_HPP__
#define __IPIPOPTAPPLICATION_HPP__

#include <iostream>

#include "IpJournalist.hpp"
#include "IpTNLP.hpp"
#include "IpNLP.hpp"
/* Return codes for the Optimize call for an application */
#include "IpReturnCodes.hpp"

namespace Ipopt
{
  DECLARE_STD_EXCEPTION(IPOPT_APPLICATION_ERROR);

  /* forward declarations */
  class IpoptAlgorithm;
  class IpoptNLP;
  class IpoptData;
  class IpoptCalculatedQuantities;
  class AlgorithmBuilder;
  class RegisteredOptions;
  class OptionsList;
  class SolveStatistics;

  class IpoptApplication : public ReferencedObject
  {
  public:
    IpoptApplication(bool create_console_out = true);

    virtual ~IpoptApplication();

    void Initialize(std::string params_file = "ipopt.opt");
    void Initialize(std::istream& is);

    ApplicationReturnStatus OptimizeTNLP(const SmartPtr<TNLP>& tnlp);

    ApplicationReturnStatus OptimizeNLP(const SmartPtr<NLP>& nlp, SmartPtr<AlgorithmBuilder> alg_builder=NULL);

    ApplicationReturnStatus ReOptimizeTNLP(const SmartPtr<TNLP>& tnlp);

    ApplicationReturnStatus ReOptimizeNLP(const SmartPtr<NLP>& nlp);

    bool OpenOutputFile(std::string file_name, EJournalLevel print_level);

    SmartPtr<Journalist> Jnlst()
    {
      return jnlst_;
    }

    SmartPtr<RegisteredOptions> RegOptions()
    {
      return reg_options_;
    }

    SmartPtr<OptionsList> Options()
    {
      return options_;
    }

    SmartPtr<const OptionsList> Options() const
    {
      return ConstPtr(options_);
    }

    SmartPtr<SolveStatistics> Statistics();

    static void RegisterOptions(SmartPtr<RegisteredOptions> roptions);

  private:
    // IpoptApplication();

    IpoptApplication(const IpoptApplication&);

    void operator=(const IpoptApplication&);

    void RegisterAllOptions(const SmartPtr<RegisteredOptions>& roptions);

    ApplicationReturnStatus call_optimize();

    bool read_params_dat_;

    SmartPtr<Journalist> jnlst_;

    SmartPtr<RegisteredOptions> reg_options_;

    SmartPtr<OptionsList> options_;

    SmartPtr<SolveStatistics> statistics_;

    SmartPtr<IpoptAlgorithm> alg_;

    SmartPtr<IpoptNLP> ip_nlp_;

    SmartPtr<IpoptData> ip_data_;

    SmartPtr<IpoptCalculatedQuantities> ip_cq_;

    SmartPtr<NLP> nlp_adapter_;
  };

} // namespace Ipopt

#endif