MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_MoochoTrackerSummaryStd.hpp
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_SUMMARY_STD_H
00043 #define RSQP_TRACK_SUMMARY_STD_H
00044 
00045 #include "MoochoPack_quasi_newton_stats.hpp"
00046 #include "MoochoPack_qp_solver_stats.hpp"
00047 #include "MoochoPack_act_set_stats.hpp"
00048 #include "IterationPack_AlgorithmTracker.hpp"
00049 
00050 namespace MoochoPack {
00051 
00055 class MoochoTrackerSummaryStd
00056   : public IterationPack::AlgorithmTracker
00057 {
00058 public:
00059 
00061   enum EOptError { OPT_ERROR_REDUCED_GRADIENT_LAGR, OPT_ERROR_GRADIENT_LAGR };
00062 
00064   MoochoTrackerSummaryStd(
00065     const ostream_ptr_t      &o
00066     ,const ostream_ptr_t     &journal_out
00067     ,EOptError               opt_error = OPT_ERROR_REDUCED_GRADIENT_LAGR
00068     );
00069 
00071   void set_output_stream(const ostream_ptr_t& o);
00072 
00074   const ostream_ptr_t& get_output_stream() const;
00075 
00079   int num_total_qp_iter() const
00080   { return num_total_qp_iter_;  }
00081 
00084 
00086   void output_iteration(const Algorithm& algo) const;
00088   void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00089   
00091 
00092 protected:
00093 
00095   void print_header(const NLPAlgoState &s) const;
00096 
00097   std::ostream& o() const
00098   { return *o_; }
00099 
00100 private:
00101   ostream_ptr_t                  o_;
00102   EOptError                      opt_error_;
00103   mutable int                     num_total_qp_iter_;
00104   quasi_newton_stats_iq_member    quasi_newton_stats_;
00105   qp_solver_stats_iq_member       qp_solver_stats_;
00106   act_set_stats_iq_member       act_set_stats_;
00107 
00108   // Not defined and not to be called
00109   MoochoTrackerSummaryStd();
00110 
00111 };  // end class MoochoTrackerSummaryStd
00112 
00113 } // end namespace MoochoPack 
00114 
00115 #endif  // RSQP_TRACK_SUMMARY_STD_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends