MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_CheckConvergenceStd_Strategy.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 
00043 #if !defined CHECK_CONVERGENCE_STD_STRATEGY_H
00044 #define CHECK_CONVERGENCE_STD_STRATEGY_H
00045 
00046 #include "MoochoPack_CheckConvergence_Strategy.hpp"
00047 
00048 namespace MoochoPack {
00049 
00058 class CheckConvergenceStd_Strategy :
00059     public CheckConvergence_Strategy
00060   {
00061   public:
00062     CheckConvergenceStd_Strategy(
00063       EOptErrorCheck opt_error_check = OPT_ERROR_REDUCED_GRADIENT_LAGR,
00064       EScaleKKTErrorBy scale_opt_error_by = SCALE_BY_ONE,
00065       EScaleKKTErrorBy scale_feas_error_by = SCALE_BY_ONE,
00066       EScaleKKTErrorBy scale_comp_error_by = SCALE_BY_ONE,
00067       bool scale_opt_error_by_Gf = true
00068       );
00069     
00073     virtual bool Converged( Algorithm& _algo);
00074 
00076     virtual void print_step( const Algorithm& _algo, std::ostream& out, const std::string& L ) const;
00077 
00079 
00080   protected:
00081 
00082     value_type CalculateScalingFactor( NLPAlgoState& state, EScaleKKTErrorBy scale_by ) const;
00083 
00084   }; // end class CheckConvergenceStd_Strategy
00085 
00086 } // end namespace MoochoPack
00087 
00088 #endif // CHECK_CONVERGENCE_STD_STRATEGY_H
00089 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines