MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_MoochoTrackerConsoleStd.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef RSQP_TRACK_CONSOLE_STD_H
43 #define RSQP_TRACK_CONSOLE_STD_H
44 
45 #include "MoochoPack_quasi_newton_stats.hpp"
46 #include "IterationPack_AlgorithmTracker.hpp"
47 #include "StopWatchPack_stopwatch.hpp"
48 
49 namespace MoochoPack {
50 
111 {
112 public:
113 
116 
118  void set_output_stream(const ostream_ptr_t& o);
119 
121  const ostream_ptr_t& get_output_stream() const;
122 
125 
127  void initialize();
129  void output_iteration(const Algorithm& algo) const;
131  void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
132 
134 
135 protected:
136 
138  void print_top_header(const NLPAlgoState &s, const NLPAlgo& algo) const;
139 
141  void print_header(const NLPAlgoState &s, const NLPAlgo& algo) const;
142 
143  std::ostream& o() const
144  { return *o_; }
145 
146 private:
147 
148  // ///////////////////////////////////////////
149  // Private types
150 
151  enum { NUM_PRINT_LINES = 10 };
152 
153  // ///////////////////////////////////////////
154  // Private data members
155 
156  ostream_ptr_t o_;
157  mutable StopWatchPack::stopwatch timer_;
158  mutable int printed_lines_;
159  quasi_newton_stats_iq_member quasi_newton_stats_;
160 
161  // Static formating info.
162  static int w_i2_;
163  static char ul_i2_[];
164  static int w_i4_;
165  static char ul_i4_[];
166  static int p2_;
167  static int w_p2_;
168  static char ul_p2_[];
169  static int p3_;
170  static int w_p3_;
171  static char ul_p3_[];
172 
173  // ///////////////////////////////////////////
174  // Private member funcitons
175 
176  // Not defined and not to be called
178 }; // end class MoochoTrackerConsoleStd
179 
180 } // end namespace MoochoPack
181 
182 #endif // RSQP_TRACK_CONSOLE_STD_H
void output_iteration(const Algorithm &algo) const
void print_top_header(const NLPAlgoState &s, const NLPAlgo &algo) const
Print the top header to the output.
const ostream_ptr_t & get_output_stream() const
Get the output stream for console outputting.
rSQP Algorithm control class.
Teuchos::RCP< std::ostream > ostream_ptr_t
void print_header(const NLPAlgoState &s, const NLPAlgo &algo) const
Print the header to the output.
virtual std::ostream & journal_out() const
This rSQP iteration class provides a tablular output suitable for an 80 char wide console...
Reduced space SQP state encapsulation interface.
Class for object that attempts to return an IterQuantityAccess<QuasiNewtonStats> from an AlgorithmSta...
void set_output_stream(const ostream_ptr_t &o)
Set the output stream for console outputting.
void output_final(const Algorithm &algo, EAlgoReturn algo_return) const