MoochoPack_MoochoTrackerSummaryStd.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef RSQP_TRACK_SUMMARY_STD_H
#define RSQP_TRACK_SUMMARY_STD_H

#include "MoochoPack_quasi_newton_stats.hpp"
#include "MoochoPack_qp_solver_stats.hpp"
#include "MoochoPack_act_set_stats.hpp"
#include "IterationPack_AlgorithmTracker.hpp"

namespace MoochoPack {

class MoochoTrackerSummaryStd
  : public IterationPack::AlgorithmTracker
{
public:

  enum EOptError { OPT_ERROR_REDUCED_GRADIENT_LAGR, OPT_ERROR_GRADIENT_LAGR };

  MoochoTrackerSummaryStd(
    const ostream_ptr_t      &o
    ,const ostream_ptr_t     &journal_out
    ,EOptError               opt_error = OPT_ERROR_REDUCED_GRADIENT_LAGR
    );

  void set_output_stream(const ostream_ptr_t& o);

  const ostream_ptr_t& get_output_stream() const;

  int num_total_qp_iter() const
  { return num_total_qp_iter_;  }


  void output_iteration(const Algorithm& algo) const;
  void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
  

protected:

  void print_header(const NLPAlgoState &s) const;

  std::ostream& o() const
  { return *o_; }

private:
  ostream_ptr_t                  o_;
  EOptError                      opt_error_;
  mutable int                     num_total_qp_iter_;
  quasi_newton_stats_iq_member    quasi_newton_stats_;
  qp_solver_stats_iq_member       qp_solver_stats_;
  act_set_stats_iq_member       act_set_stats_;

  // Not defined and not to be called
  MoochoTrackerSummaryStd();

};  // end class MoochoTrackerSummaryStd

} // end namespace MoochoPack 

#endif  // RSQP_TRACK_SUMMARY_STD_H