MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_ReducedHessianSerialization_Step.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 REDUCED_HESSIAN_SERIALIZATION_STEP_HPP
00030 #define REDUCED_HESSIAN_SERIALIZATION_STEP_HPP
00031 
00032 #include "MoochoPack_ReducedHessianSecantUpdate_Strategy.hpp"
00033 #include "MoochoPack_quasi_newton_stats.hpp"
00034 #include "IterationPack_AlgorithmStep.hpp"
00035 #include "Teuchos_StandardCompositionMacros.hpp"
00036 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00037 
00038 namespace MoochoPack {
00039 
00044 class ReducedHessianSerialization_Step
00045   : public IterationPack::AlgorithmStep // doxygen needs full path
00046 {
00047 public:
00048 
00050   STANDARD_MEMBER_COMPOSITION_MEMBERS( std::string, reduced_hessian_input_file_name );
00051 
00053   STANDARD_MEMBER_COMPOSITION_MEMBERS( std::string, reduced_hessian_output_file_name );
00054 
00056   ReducedHessianSerialization_Step(
00057     const std::string    &reduced_hessian_input_file_name   = "reduced_hessian.in"
00058     ,const std::string   &reduced_hessian_output_file_name  = "reduced_hessian.out"
00059     );
00060   
00064   bool do_step(
00065     Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00066     ,poss_type assoc_step_poss
00067     );
00069   void finalize_step(
00070     Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00071     ,poss_type assoc_step_poss
00072     );
00074   void print_step(
00075     const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00076     ,poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str
00077     ) const;
00079   
00080 };  // end class ReducedHessianSerialization_Step
00081 
00082 } // end namespace MoochoPack 
00083 
00084 #endif  // REDUCED_HESSIAN_SERIALIZATION_STEP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines