MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_MoochoTrackerStatsStd.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_STATS_STD_H
43 #define RSQP_TRACK_STATS_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 
81  {
82 public:
83 
86 
88  /* Set the output stream for statistics outputting.
89  */
90  void set_output_stream(const ostream_ptr_t& o);
91 
93  const ostream_ptr_t& get_output_stream() const;
94 
97 
99  void initialize();
101  void output_iteration(const Algorithm& algo) const;
103  void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
104 
106 
107 protected:
108 
109  std::ostream& o() const
110  { return *o_; }
111 
112 private:
113  ostream_ptr_t o_;
114  mutable int num_QN_updates_;
115  quasi_newton_stats_iq_member quasi_newton_stats_;
116  mutable StopWatchPack::stopwatch timer_;
117 
118  // Not defined and not to be called
120 
121 }; // end class MoochoTrackerStatsStd
122 
123 } // end namespace MoochoPack
124 
125 #endif // RSQP_TRACK_STATS_STD_H
const ostream_ptr_t & get_output_stream() const
Get the output stream for statistics outputting.
Teuchos::RCP< std::ostream > ostream_ptr_t
void output_final(const Algorithm &algo, EAlgoReturn algo_return) const
virtual std::ostream & journal_out() const
Class for object that attempts to return an IterQuantityAccess<QuasiNewtonStats> from an AlgorithmSta...
void output_iteration(const Algorithm &algo) const
This is a simple track class for getting statistics about a solved (or not solved) NLP...