MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_MoochoTrackerConsoleStd.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef RSQP_TRACK_CONSOLE_STD_H
00043 #define RSQP_TRACK_CONSOLE_STD_H
00044 
00045 #include "MoochoPack_quasi_newton_stats.hpp"
00046 #include "IterationPack_AlgorithmTracker.hpp"
00047 #include "StopWatchPack_stopwatch.hpp"
00048 
00049 namespace MoochoPack {
00050 
00109 class MoochoTrackerConsoleStd
00110   : public IterationPack::AlgorithmTracker
00111 {
00112 public:
00113 
00115   MoochoTrackerConsoleStd(const ostream_ptr_t& o, const ostream_ptr_t& journal_out);
00116 
00118   void set_output_stream(const ostream_ptr_t& o);
00119 
00121   const ostream_ptr_t& get_output_stream() const;
00122 
00125 
00127   void initialize();
00129   void output_iteration(const Algorithm& algo) const;
00131   void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00132 
00134 
00135 protected:
00136 
00138   void print_top_header(const NLPAlgoState &s, const NLPAlgo& algo) const;
00139 
00141   void print_header(const NLPAlgoState &s, const NLPAlgo& algo) const;
00142 
00143   std::ostream& o() const
00144   { return *o_; }
00145 
00146 private:
00147 
00148   // ///////////////////////////////////////////
00149   // Private types
00150 
00151   enum { NUM_PRINT_LINES = 10 };
00152   
00153   // ///////////////////////////////////////////
00154   // Private data members
00155 
00156   ostream_ptr_t                       o_;
00157   mutable StopWatchPack::stopwatch    timer_;
00158   mutable int                         printed_lines_;
00159   quasi_newton_stats_iq_member        quasi_newton_stats_;
00160 
00161   // Static formating info.
00162   static int    w_i2_;
00163   static char   ul_i2_[];
00164   static int    w_i4_;
00165   static char   ul_i4_[];
00166   static int    p2_;
00167   static int    w_p2_;
00168   static char   ul_p2_[];
00169   static int    p3_;
00170   static int    w_p3_;
00171   static char   ul_p3_[];
00172 
00173   // ///////////////////////////////////////////
00174   // Private member funcitons
00175 
00176   // Not defined and not to be called
00177   MoochoTrackerConsoleStd();
00178 };  // end class MoochoTrackerConsoleStd
00179 
00180 } // end namespace MoochoPack 
00181 
00182 #endif  // RSQP_TRACK_CONSOLE_STD_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines