MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_MoochoTrackerXMLSummary.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 MOOCHO_TRACKER_XML_SUMMARY_HPP
43 #define MOOCHO_TRACKER_XML_SUMMARY_HPP
44 
45 #include "IterationPack_Algorithm.hpp"
46 #include "IterationPack_AlgorithmTracker.hpp"
47 #include "MoochoPack_Types.hpp"
48 
49 namespace MoochoPack {
50 
51 
53 using IterationPack::EAlgoReturn;
54 
60 {
61 public:
62 
66  ,const std::string xml_filename
67  ,const std::string problem_name
68  ,const std::string algorithm_description
69  );
70 
72  //void set_output_stream(const ostream_ptr_t& o);
73 
75  //const ostream_ptr_t& get_output_stream() const;
76 
78  // that will be overwritten if there is no
79  // exception
80  void output_pre_file() const;
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 open_problem_element( std::ostream& out, const Algorithm& algo) const;
96  void close_problem_element( std::ostream& out) const;
97 
98 private:
99 
100  mutable value_type obj_value_;
101  mutable value_type c_norm_value_;
102 
103  std::string xml_filename_;
104  std::string problem_name_;
105  std::string algorithm_description_;
106 
107  // Not defined and not to be called
109 
110 }; // end class MoochoTrackerXMLSummary
111 
112 } // end namespace MoochoPack
113 
114 #endif // RSQP_TRACK_SUMMARY_STD_H
void open_problem_element(std::ostream &out, const Algorithm &algo) const
Print the header to the output.
void output_final(const Algorithm &algo, EAlgoReturn algo_return) const
void output_iteration(const Algorithm &algo) const
virtual std::ostream & journal_out() const
This class outputs an XML summary file of the algorithm results and performance.
void output_pre_file() const
Set the output stream for summary outputting.