MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_EvalNewPointStd_Step.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 EVAL_NEW_POINT_STD_STEP_H
00043 #define EVAL_NEW_POINT_STD_STEP_H
00044 
00045 #include "MoochoPack_DecompositionSystemHandler_Strategy.hpp"
00046 #include "IterationPack_AlgorithmStep.hpp"
00047 #include "ConstrainedOptPack_DecompositionSystemTester.hpp"
00048 #include "ConstrainedOptPack_VariableBoundsTester.hpp"
00049 #include "NLPInterfacePack_NLPFirstDerivTester.hpp"
00050 #include "Teuchos_StandardCompositionMacros.hpp"
00051 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00052 
00053 namespace MoochoPack {
00054 
00061 class EvalNewPointStd_Step
00062   : public IterationPack::AlgorithmStep // doxygen needs full path
00063 {
00064 public:
00065 
00068 
00070   enum EFDDerivTesting   { FD_DEFAULT,  FD_TEST,  FD_NO_TEST  };
00071 
00073 
00076 
00078   STANDARD_COMPOSITION_MEMBERS( DecompositionSystemHandler_Strategy, decomp_sys_handler );
00080   STANDARD_COMPOSITION_MEMBERS( NLPFirstDerivTester, deriv_tester );
00082   STANDARD_COMPOSITION_MEMBERS( VariableBoundsTester, bounds_tester );
00084   STANDARD_COMPOSITION_MEMBERS( DecompositionSystemTester, decomp_sys_tester );
00089   STANDARD_MEMBER_COMPOSITION_MEMBERS( EFDDerivTesting, fd_deriv_testing );
00094   STANDARD_MEMBER_COMPOSITION_MEMBERS( DecompositionSystemHandler_Strategy::EDecompSysTesting, decomp_sys_testing );
00099   STANDARD_MEMBER_COMPOSITION_MEMBERS( DecompositionSystemHandler_Strategy::EDecompSysPrintLevel, decomp_sys_testing_print_level );
00100 
00105   EvalNewPointStd_Step(
00106     const decomp_sys_handler_ptr_t                              &decomp_sys_handler
00107     ,const deriv_tester_ptr_t                                   &deriv_tester
00108     ,const bounds_tester_ptr_t                                  &bounds_tester
00109     ,const decomp_sys_tester_ptr_t                              &decomp_sys_tester
00110     ,EFDDerivTesting                                            fd_deriv_testing               = FD_DEFAULT
00111     ,DecompositionSystemHandler_Strategy::EDecompSysTesting     decomp_sys_testing             = DecompositionSystemHandler_Strategy::DST_DEFAULT
00112     ,DecompositionSystemHandler_Strategy::EDecompSysPrintLevel  decomp_sys_testing_print_level = DecompositionSystemHandler_Strategy::DSPL_USE_GLOBAL
00113     );
00114 
00116 
00120   bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00121     , poss_type assoc_step_poss);
00123   void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00124     , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00126 
00127 private:
00128 
00129   // Not defined and not to be called
00130   EvalNewPointStd_Step();
00131 
00132 };  // end class EvalNewPointStd_Step
00133 
00134 } // end namespace MoochoPack 
00135 
00136 #endif  // EVAL_NEW_POINT_STD_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines