IterationPack: General framework for building iterative algorithms Version of the Day
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 // 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 ALGORITHM_TRACK_COMPOSITE_H
00043 #define ALGORITHM_TRACK_COMPOSITE_H
00044 
00045 #include <list>
00046 
00047 #include "IterationPack_AlgorithmTracker.hpp"
00048 #include "Teuchos_RCP.hpp"
00049 
00050 namespace IterationPack {
00051 
00059 class AlgorithmTrackerComposite : public AlgorithmTracker {
00060 public:
00061 
00063   typedef Teuchos::RCP<AlgorithmTracker>      track_ptr_t;
00065   typedef std::list<track_ptr_t>                                    track_list_t;
00067   AlgorithmTrackerComposite(const ostream_ptr_t& journal_out);
00069   track_list_t& tracks();
00071   const track_list_t& tracks() const;
00072 
00075 
00077   void initialize();
00079   void output_iteration(const Algorithm& algo) const;
00081   void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00082 
00084 
00085 private:
00086 
00087 #ifdef DOXYGEN_COMPILE
00088   AlgorithmTracker  *tracks;
00089 #else
00090   track_list_t    tracks_;
00091 #endif
00092 
00093 };  // end class AlgorithmTrackerComposite
00094 
00095 // ///////////////////////////////////
00096 // Inline members
00097 
00098 inline
00099 AlgorithmTrackerComposite::track_list_t&
00100 AlgorithmTrackerComposite::tracks()
00101 { 
00102   return tracks_;
00103 }
00104 
00105 inline
00106 const AlgorithmTrackerComposite::track_list_t&
00107 AlgorithmTrackerComposite::tracks() const
00108 { 
00109   return tracks_;
00110 }
00111 
00112 } // end namespace IterationPack 
00113 
00114 #endif  // ALGORITHM_TRACK_COMPOSITE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends