MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_MoochoTrackerSummaryStd.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_SUMMARY_STD_H
43 #define RSQP_TRACK_SUMMARY_STD_H
44 
45 #include "MoochoPack_quasi_newton_stats.hpp"
46 #include "MoochoPack_qp_solver_stats.hpp"
47 #include "MoochoPack_act_set_stats.hpp"
48 #include "IterationPack_AlgorithmTracker.hpp"
49 
50 namespace MoochoPack {
51 
57 {
58 public:
59 
61  enum EOptError { OPT_ERROR_REDUCED_GRADIENT_LAGR, OPT_ERROR_GRADIENT_LAGR };
62 
65  const ostream_ptr_t &o
67  ,EOptError opt_error = OPT_ERROR_REDUCED_GRADIENT_LAGR
68  );
69 
71  void set_output_stream(const ostream_ptr_t& o);
72 
74  const ostream_ptr_t& get_output_stream() const;
75 
79  int num_total_qp_iter() const
80  { return num_total_qp_iter_; }
81 
84 
86  void output_iteration(const Algorithm& algo) const;
88  void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
89 
91 
92 protected:
93 
95  void print_header(const NLPAlgoState &s) const;
96 
97  std::ostream& o() const
98  { return *o_; }
99 
100 private:
101  ostream_ptr_t o_;
102  EOptError opt_error_;
103  mutable int num_total_qp_iter_;
104  quasi_newton_stats_iq_member quasi_newton_stats_;
105  qp_solver_stats_iq_member qp_solver_stats_;
106  act_set_stats_iq_member act_set_stats_;
107 
108  // Not defined and not to be called
109  MoochoTrackerSummaryStd();
110 
111 }; // end class MoochoTrackerSummaryStd
112 
113 } // end namespace MoochoPack
114 
115 #endif // RSQP_TRACK_SUMMARY_STD_H
int num_total_qp_iter() const
Output the total number of qp iterations back to and the k=0 iteration.
void output_final(const Algorithm &algo, EAlgoReturn algo_return) const
void output_iteration(const Algorithm &algo) const
Teuchos::RCP< std::ostream > ostream_ptr_t
virtual std::ostream & journal_out() const
Reduced space SQP state encapsulation interface.
This class simply outputs the convergence information for each iteration.
void set_output_stream(const ostream_ptr_t &o)
Set the output stream for summary outputting.
const ostream_ptr_t & get_output_stream() const
Get the output stream for summary outputting.
void print_header(const NLPAlgoState &s) const
Print the header to the output.