MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_LineSearchFullStepAfterKIter_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 // 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 LINE_SEARCH_FULL_STEP_AFTER_K_ITER_STEP_H
00043 #define LINE_SEARCH_FULL_STEP_AFTER_K_ITER_STEP_H
00044 
00045 #include <limits>
00046 
00047 #include "rSQPAlgo_StepBaseClasses.h"
00048 #include "ConstrainedOptPack_DirectLineSearch_Strategy.hpp"
00049 #include "Teuchos_StandardCompositionMacros.hpp"
00050 #include "MiStandardAggregationMacros.h"
00051 
00052 namespace MoochoPack {
00053 
00057 class LineSearchFullStepAfterKIter_Step : public LineSearch_Step {
00058 public:
00059 
00061   STANDARD_COMPOSITION_MEMBERS(LineSearch_Step,line_search);
00062 
00064   LineSearchFullStepAfterKIter_Step(
00065         const line_search_ptr_t&  line_search     = 0
00066       , int           full_steps_after_k
00067                       = std::numeric_limits<int>::max() )
00068     : line_search_(line_search)
00069       , full_steps_after_k_(full_steps_after_k)
00070   {}
00071 
00073   void full_steps_after_k( int full_steps_after_k )
00074   { full_steps_after_k_ = full_steps_after_k; }
00076   value_type full_steps_after_k() const
00077   { return full_steps_after_k_; }
00078 
00079   // ////////////////////
00080   // Overridden
00081 
00083   bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00084     , poss_type assoc_step_poss);
00085 
00087   void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00088     , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00089 
00090 private:
00091   int   full_steps_after_k_;
00092   
00093 };  // end class LineSearchFullStepAfterKIter_Step
00094 
00095 } // end namespace MoochoPack 
00096 
00097 #endif  // LINE_SEARCH_FULL_STEP_AFTER_K_ITER_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends