IterationPack_AlgorithmTracker.hpp

Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef ALGORITHM_TRACK_H
00030 #define ALGORITHM_TRACK_H
00031 
00032 #include <iosfwd>
00033 
00034 #include "IterationPack_Types.hpp"
00035 #include "Teuchos_RefCountPtr.hpp"
00036 
00037 namespace IterationPack {
00038 
00046 class AlgorithmTracker {
00047 public:
00048 
00050   virtual ~AlgorithmTracker() {}
00051 
00054 
00056   typedef Teuchos::RefCountPtr<std::ostream>    ostream_ptr_t;
00057 
00059 
00062 
00069   AlgorithmTracker(const ostream_ptr_t& journal_out);
00070   
00072   
00075   
00080   virtual void initialize();
00081 
00086   virtual void output_iteration(const Algorithm& algo) const;
00087 
00092   virtual void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00093 
00095 
00098 
00101   virtual void set_journal_out(const ostream_ptr_t& journal_out);
00102 
00105   const ostream_ptr_t& get_journal_out() const;
00106 
00110   virtual std::ostream& journal_out() const;
00111 
00113 
00114 private:
00115 
00116 #ifndef DOXYGEN_COMPILE
00117   ostream_ptr_t   journal_out_;
00118 #endif
00119 
00120   // not defined and not to be called
00121   AlgorithmTracker();
00122   
00123 };  // end class AlgorithmTracker
00124 
00125 } // end namespace IterationPack 
00126 
00127 #endif // ALGORITHM_TRACK_H

Generated on Thu Sep 18 12:35:16 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1