MoochoPack_UpdateReducedSigma_Step.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 UPDATE_REDUCED_SIGMA_STEP_H
00030 #define UPDATE_REDUCED_SIGMA_STEP_H
00031 
00032 #include "IterationPack_AlgorithmStep.hpp"
00033 #include "Teuchos_StandardCompositionMacros.hpp"
00034 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00035 
00036 #include "MoochoPack_Types.hpp"
00037 #include "IterationPack_AlgorithmStep.hpp"
00038 
00039 #include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
00040 #include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"
00041 
00042 namespace MoochoPack {
00043 
00050 class UpdateReducedSigma_Step
00051   : public IterationPack::AlgorithmStep // doxygen needs full path
00052   {
00053   public:
00054 
00055     enum e_update_methods
00056       {
00057       ALWAYS_EXPLICIT,
00058       BFGS_PRIMAL,
00059       BFGS_DUAL_NO_CORRECTION,
00060       BFGS_DUAL_EXPLICIT_CORRECTION,
00061       BFGS_DUAL_SCALING_CORRECTION
00062       };
00063 
00082     STANDARD_MEMBER_COMPOSITION_MEMBERS( e_update_methods, update_method);
00083 
00087     bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00088            , poss_type assoc_step_poss);
00089     
00090     
00091     void print_step( const IterationPack::Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00092              , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00094 
00097     UpdateReducedSigma_Step(
00098 //      const e_update_methods update_method = BFGS_DUAL_EXPLICIT_CORRECTION
00099       const e_update_methods update_method = ALWAYS_EXPLICIT // For now only!
00100       );
00102 
00103   private:
00104     void FormReducedSigmaExplicitly(NLPAlgo& algo, IpState& s, EJournalOutputLevel olevel,  std::ostream& out);
00105 
00106 
00107   }; // end class EvalNewPointBarrier_Step
00108 
00109 const char UpdateReducedSigma_opt_grp_name[] = "UpdateReducedSigma";
00110 class UpdateReducedSigma_StepSetOptions
00111   : public OptionsFromStreamPack::SetOptionsFromStreamNode,
00112     public OptionsFromStreamPack::SetOptionsToTargetBase< UpdateReducedSigma_Step >
00113   {
00114   public:
00115     UpdateReducedSigma_StepSetOptions(
00116       UpdateReducedSigma_Step* target = 0,
00117       const char opt_grp_name[] = UpdateReducedSigma_opt_grp_name );
00118 
00119   protected:
00120 
00122     void setOption( int option_num, const std::string& option_value );
00123   
00124   };  // end class UpdateReducedSigma_StepSetOptions
00125 
00126 
00127 }  // end namespace MoochoPack
00128 
00129 #endif // UPDATE_REDUCED_SIGMA_STEP_H

Generated on Wed May 12 21:51:20 2010 for MoochoPack : Framework for Large-Scale Optimization Algorithms by  doxygen 1.4.7