IpSolveStatistics.hpp

Go to the documentation of this file.

// Copyright (C) 2005, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Common Public License.
//
// $Id: IpSolveStatistics.hpp 759 2006-07-07 03:07:08Z andreasw $
//
// Authors:  Carl Laird, Andreas Waechter          IBM    2005-08-15

#ifndef __IPSOLVESTATISTICS_HPP__
#define __IPSOLVESTATISTICS_HPP__

#include "IpReferenced.hpp"
#include "IpSmartPtr.hpp"

namespace Ipopt
{
  // forward declaration (to avoid inclusion of too many header files)
  class IpoptNLP;
  class IpoptData;
  class IpoptCalculatedQuantities;

  class SolveStatistics : public ReferencedObject
  {
  public:
    SolveStatistics(const SmartPtr<IpoptNLP>& ip_nlp,
                    const SmartPtr<IpoptData>& ip_data,
                    const SmartPtr<IpoptCalculatedQuantities>& ip_cq);

    virtual ~SolveStatistics()
    {}

    Index IterationCount() const;
    Number TotalCPUTime() const;
    void NumberOfEvaluations(Index& num_obj_evals,
                             Index& num_constr_evals,
                             Index& num_obj_grad_evals,
                             Index& num_constr_jac_evals,
                             Index& num_hess_evals) const;
    void Infeasibilities(Number& dual_inf,
                         Number& constr_viol,
                         Number& complementarity,
                         Number& kkt_error) const;
    void ScaledInfeasibilities(Number& scaled_dual_inf,
                               Number& scaled_constr_viol,
                               Number& scaled_complementarity,
                               Number& scaled_kkt_error) const;
    Number FinalObjective() const;
    Number FinalScaledObjective() const;

  private:
    SolveStatistics();

    SolveStatistics(const SolveStatistics&);

    void operator=(const SolveStatistics&);

    Index num_iters_;
    /* Total CPU time */
    Number total_cpu_time_;
    Index num_obj_evals_;
    Index num_constr_evals_;
    Index num_obj_grad_evals_;
    Index num_constr_jac_evals_;
    Index num_hess_evals_;

    Number scaled_obj_val_;
    Number obj_val_;
    Number scaled_dual_inf_;
    Number dual_inf_;
    Number scaled_constr_viol_;
    Number constr_viol_;
    Number scaled_compl_;
    Number compl_;
    Number scaled_kkt_error_;
    Number kkt_error_;
  };

} // namespace Ipopt

#endif