MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_MeritFunc_PenaltyParamUpdateMultFree_AddedStep.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 MERIT_FUNC_PENALTY_PARAM_UPDATE_MULT_FREE_ADDED_STEP_H
00043 #define MERIT_FUNC_PENALTY_PARAM_UPDATE_MULT_FREE_ADDED_STEP_H
00044 
00045 #include "MoochoPack_MeritFunc_PenaltyParamUpdateGuts_AddedStep.hpp"
00046 
00047 namespace MoochoPack {
00048 
00052 class MeritFunc_PenaltyParamUpdateMultFree_AddedStep
00053   : public MeritFunc_PenaltyParamUpdateGuts_AddedStep
00054 {
00055 public:
00056 
00058   MeritFunc_PenaltyParamUpdateMultFree_AddedStep(
00059     value_type   small_mu = 1e-6
00060     ,value_type  mult_factor = 1e-4
00061     ,value_type  kkt_near_sol = 1.0
00062     );
00063 
00064 protected:
00065 
00068 
00070   bool min_mu( NLPAlgoState& s, value_type* min_mu ) const;
00072   void print_min_mu_step( std::ostream& out
00073     , const std::string& leading_str ) const;
00074 
00076   
00077 };  // end class MeritFunc_PenaltyParamUpdateMultFree_AddedStep
00078 
00079 } // end namespace MoochoPack 
00080 
00081 #endif  // MERIT_FUNC_PENALTY_PARAM_UPDATE_MULT_FREE_ADDED_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines