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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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