MoochoPack_MoochoTrackerConsoleStd.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_CONSOLE_STD_H
#define RSQP_TRACK_CONSOLE_STD_H

#include "MoochoPack_quasi_newton_stats.hpp"
#include "IterationPack_AlgorithmTracker.hpp"
#include "StopWatchPack_stopwatch.hpp"

namespace MoochoPack {

class MoochoTrackerConsoleStd
  : public IterationPack::AlgorithmTracker
{
public:

  MoochoTrackerConsoleStd(const ostream_ptr_t& o, const ostream_ptr_t& journal_out);

  void set_output_stream(const ostream_ptr_t& o);

  const ostream_ptr_t& get_output_stream() const;


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


protected:

  void print_top_header(const NLPAlgoState &s, const NLPAlgo& algo) const;

  void print_header(const NLPAlgoState &s, const NLPAlgo& algo) const;

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

private:

  // ///////////////////////////////////////////
  // Private types

  enum { NUM_PRINT_LINES = 10 };
  
  // ///////////////////////////////////////////
  // Private data members

  ostream_ptr_t                       o_;
  mutable StopWatchPack::stopwatch    timer_;
  mutable int                         printed_lines_;
  quasi_newton_stats_iq_member        quasi_newton_stats_;

  // Static formating info.
  static int    w_i2_;
  static char   ul_i2_[];
  static int    w_i4_;
  static char   ul_i4_[];
  static int    p2_;
  static int    w_p2_;
  static char   ul_p2_[];
  static int    p3_;
  static int    w_p3_;
  static char   ul_p3_[];

  // ///////////////////////////////////////////
  // Private member funcitons

  // Not defined and not to be called
  MoochoTrackerConsoleStd();
};  // end class MoochoTrackerConsoleStd

} // end namespace MoochoPack 

#endif  // RSQP_TRACK_CONSOLE_STD_H