IterationPack_AlgorithmTrackerComposite.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 // 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_COMPOSITE_H
00030 #define ALGORITHM_TRACK_COMPOSITE_H
00031 
00032 #include <list>
00033 
00034 #include "IterationPack_AlgorithmTracker.hpp"
00035 #include "Teuchos_RCP.hpp"
00036 
00037 namespace IterationPack {
00038 
00046 class AlgorithmTrackerComposite : public AlgorithmTracker {
00047 public:
00048 
00050   typedef Teuchos::RCP<AlgorithmTracker>      track_ptr_t;
00052   typedef std::list<track_ptr_t>                                    track_list_t;
00054   AlgorithmTrackerComposite(const ostream_ptr_t& journal_out);
00056   track_list_t& tracks();
00058   const track_list_t& tracks() const;
00059 
00062 
00064   void initialize();
00066   void output_iteration(const Algorithm& algo) const;
00068   void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00069 
00071 
00072 private:
00073 
00074 #ifdef DOXYGEN_COMPILE
00075   AlgorithmTracker  *tracks;
00076 #else
00077   track_list_t    tracks_;
00078 #endif
00079 
00080 };  // end class AlgorithmTrackerComposite
00081 
00082 // ///////////////////////////////////
00083 // Inline members
00084 
00085 inline
00086 AlgorithmTrackerComposite::track_list_t&
00087 AlgorithmTrackerComposite::tracks()
00088 { 
00089   return tracks_;
00090 }
00091 
00092 inline
00093 const AlgorithmTrackerComposite::track_list_t&
00094 AlgorithmTrackerComposite::tracks() const
00095 { 
00096   return tracks_;
00097 }
00098 
00099 } // end namespace IterationPack 
00100 
00101 #endif  // ALGORITHM_TRACK_COMPOSITE_H

Generated on Wed May 12 21:31:24 2010 for IterationPack: General framework for building iterative algorithms by  doxygen 1.4.7