MOOCHO (Single Doxygen Collection) Version of the Day
IterationPack_AlgorithmStep.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 // 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_STEP_H
00043 #define ALGORITHM_STEP_H
00044 
00045 #include <iosfwd>
00046 
00047 #include "IterationPack_Types.hpp"
00048 
00049 namespace IterationPack {
00050 
00053 class AlgorithmStep {
00054 public:
00055 
00057   typedef size_t poss_type;
00058 
00061 
00069   virtual bool do_step(
00070     Algorithm&             algo
00071     ,poss_type             step_poss
00072     ,EDoStepType           type
00073     ,poss_type             assoc_step_poss
00074     ) = 0;
00075 
00077 
00080 
00082   virtual ~AlgorithmStep() {}
00083 
00091   virtual void initialize_step(
00092     Algorithm&             algo
00093     ,poss_type             step_poss
00094     ,EDoStepType           type
00095     ,poss_type             assoc_step_poss
00096     )
00097     {}
00098 
00107   virtual void inform_updated(
00108     Algorithm&             algo
00109     ,poss_type             step_poss
00110     ,EDoStepType           type
00111     ,poss_type             assoc_step_poss
00112     )
00113     {}
00114 
00122   virtual void finalize_step(
00123     Algorithm&             algo
00124     ,poss_type             step_poss
00125     ,EDoStepType           type
00126     ,poss_type             assoc_step_poss
00127     )
00128     {}
00129 
00134   virtual void print_step(
00135     const Algorithm&         algo
00136     ,poss_type               step_poss
00137     ,EDoStepType             type
00138     ,poss_type               assoc_step_poss
00139     , std::ostream&          out
00140     ,const std::string&      leading_str
00141     ) const
00142   {}
00143 
00145 
00146 };  // end class AlgorithmStep
00147 
00148 } // end namespace IterationPack 
00149 
00150 #endif // ALGORITHM_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines