MoochoPack_MeritFunc_PenaltyParamUpdate_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_ADDED_STEP_H
00030 #define MERIT_FUNC_PENALTY_PARAM_UPDATE_ADDED_STEP_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 #include "IterationPack_AlgorithmStep.hpp"
00034 
00035 namespace MoochoPack {
00036 
00043 class MeritFunc_PenaltyParamUpdate_AddedStep
00044   : public IterationPack::AlgorithmStep // doxygen needs full path
00045 {
00046 public:
00047 
00050 
00053   virtual void small_mu( value_type small_mu ) = 0;
00055   virtual value_type small_mu() const = 0;
00061   virtual void min_mu_ratio( value_type min_mu_ratio )
00062   {}
00064   virtual value_type min_mu_ratio() const
00065   { return 1.0; };
00071   virtual void mult_factor( value_type mult_factor ) = 0;
00073   virtual value_type mult_factor() const = 0;
00080   virtual void kkt_near_sol( value_type kkt_near_sol ) = 0;
00082   virtual value_type kkt_near_sol() const = 0;
00083 
00085 
00086 };  // end class MeritFunc_PenaltyParamUpdate_AddedStep
00087 
00088 } // end namespace MoochoPack 
00089 
00090 #endif  // MERIT_FUNC_PENALTY_PARAM_UPDATE_ADDED_STEP_H

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