IpCGPenaltyCq.hpp

Go to the documentation of this file.

// Copyright (C) 2007, 2008 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpCGPenaltyCq.hpp 1861 2010-12-21 21:34:47Z andreasw $
//
// Authors:  Andreas Waechter           IBM    2007-06-04
//               derived from IpIpoptCalculatedQuantities.hpp

#ifndef __IPCGPENALTYCQ_HPP__
#define __IPCGPENALTYCQ_HPP__

#include "IpIpoptCalculatedQuantities.hpp"
#include "IpCGPenaltyData.hpp"

namespace Ipopt
{

  class CGPenaltyCq : public IpoptAdditionalCq
  {
  public:

    CGPenaltyCq(IpoptNLP* ip_nlp,
                IpoptData* ip_data,
                IpoptCalculatedQuantities* ip_cg);

    virtual ~CGPenaltyCq();

    bool Initialize(const Journalist& jnlst,
                    const OptionsList& options,
                    const std::string& prefix);


    Number curr_jac_cd_norm(Index nrm_type);
    Number curr_scaled_y_Amax();
    Number curr_added_y_nrm2();

    Number curr_penalty_function();
    Number trial_penalty_function();
    Number curr_direct_deriv_penalty_function();
    Number curr_fast_direct_deriv_penalty_function();

    Number dT_times_barH_times_d();


    Number curr_cg_pert_fact();

    Number compute_curr_cg_penalty(const Number );

    Number compute_curr_cg_penalty_scale();

    static void RegisterOptions(const SmartPtr<RegisteredOptions>& roptions);

  private:
    CGPenaltyCq();

    CGPenaltyCq(const CGPenaltyCq&);

    void operator=(const CGPenaltyCq&);

    IpoptNLP* ip_nlp_;
    IpoptData* ip_data_;
    IpoptCalculatedQuantities* ip_cq_;

    CGPenaltyData& CGPenData()
    {
      CGPenaltyData& cg_pen_data =
        static_cast<CGPenaltyData&>(ip_data_->AdditionalData());
      DBG_ASSERT(dynamic_cast<CGPenaltyData*>(&ip_data_->AdditionalData()));
      return cg_pen_data;
    }

    CachedResults<Number> curr_fast_direct_deriv_penalty_function_cache_;
    CachedResults<Number> curr_jac_cd_norm_cache_;
    CachedResults<Number> curr_scaled_y_Amax_cache_;
    CachedResults<Number> curr_added_y_nrm2_cache_;
    CachedResults<Number> curr_penalty_function_cache_;
    CachedResults<Number> trial_penalty_function_cache_;
    CachedResults<Number> curr_direct_deriv_penalty_function_cache_;
    CachedResults<Number> curr_cg_pert_fact_cache_;

    Number reference_infeasibility_;

    bool initialize_called_;
  };

} // namespace Ipopt

#endif