MoochoPack_MeritFunc_PenaltyParamUpdateGuts_AddedStep.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 MERIT_FUNC_PENALTY_PARAM_UPDATE_GUTS_ADDED_STEP_H
00030 #define MERIT_FUNC_PENALTY_PARAM_UPDATE_GUTS_ADDED_STEP_H
00031 
00032 #include "MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStep.hpp"
00033 
00034 namespace MoochoPack {
00035 
00044 class MeritFunc_PenaltyParamUpdateGuts_AddedStep
00045   : public MeritFunc_PenaltyParamUpdate_AddedStep
00046 {
00047 public:
00048 
00050   MeritFunc_PenaltyParamUpdateGuts_AddedStep(
00051     value_type   small_mu
00052     ,value_type  mult_factor
00053     ,value_type  kkt_near_sol
00054     );
00055 
00058 
00060   bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00061     , poss_type assoc_step_poss);
00063   void print_step( const Algorithm& algo, poss_type step_poss
00064     , IterationPack::EDoStepType type, poss_type assoc_step_poss
00065     , std::ostream& out, const std::string& leading_str ) const;
00066 
00068 
00071 
00073   void small_mu( value_type small_mu );
00075   value_type small_mu() const;
00077   void mult_factor( value_type mult_factor );
00079   value_type mult_factor() const;
00081   void kkt_near_sol( value_type kkt_near_sol );
00083   value_type kkt_near_sol() const;
00084   
00086 
00087 protected:
00088 
00091 
00103   virtual bool min_mu( NLPAlgoState& s, value_type* min_mu ) const = 0;
00104 
00107   virtual void print_min_mu_step( std::ostream& out
00108     , const std::string& leading_str ) const = 0;
00109 
00111 
00112 private:
00113   bool near_solution_;
00114   value_type small_mu_;
00115   value_type mult_factor_;
00116   value_type kkt_near_sol_;
00117   
00118 };  // end class MeritFunc_PenaltyParamUpdateGuts_AddedStep
00119 
00120 } // end namespace MoochoPack 
00121 
00122 #endif  // MERIT_FUNC_PENALTY_PARAM_UPDATE_GUTS_ADDED_STEP_H

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