# IterationPack_AlgorithmStep.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 // ***********************************************************************
00028
00029 #ifndef ALGORITHM_STEP_H
00030 #define ALGORITHM_STEP_H
00031
00032 #include <iosfwd>
00033
00034 #include "IterationPack_Types.hpp"
00035
00036 namespace IterationPack {
00037
00040 class AlgorithmStep {
00041 public:
00042
00044   typedef size_t poss_type;
00045
00048
00056   virtual bool do_step(
00057     Algorithm&             algo
00058     ,poss_type             step_poss
00059     ,EDoStepType           type
00060     ,poss_type             assoc_step_poss
00061     ) = 0;
00062
00064
00067
00069   virtual ~AlgorithmStep() {}
00070
00078   virtual void initialize_step(
00079     Algorithm&             algo
00080     ,poss_type             step_poss
00081     ,EDoStepType           type
00082     ,poss_type             assoc_step_poss
00083     )
00084     {}
00085
00094   virtual void inform_updated(
00095     Algorithm&             algo
00096     ,poss_type             step_poss
00097     ,EDoStepType           type
00098     ,poss_type             assoc_step_poss
00099     )
00100     {}
00101
00109   virtual void finalize_step(
00110     Algorithm&             algo
00111     ,poss_type             step_poss
00112     ,EDoStepType           type
00113     ,poss_type             assoc_step_poss
00114     )
00115     {}
00116
00121   virtual void print_step(
00122     const Algorithm&         algo
00123     ,poss_type               step_poss
00124     ,EDoStepType             type
00125     ,poss_type               assoc_step_poss
00126     , std::ostream&          out
00127     ,const std::string&      leading_str
00128     ) const
00129   {}
00130
00132
00133 };  // end class AlgorithmStep
00134
00135 } // end namespace IterationPack
00136
00137 #endif // ALGORITHM_STEP_H
```

Generated on Tue Oct 20 12:50:40 2009 for IterationPack: General framework for building iterative algorithms by  1.4.7