MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_EvalNewPointStd_Step.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef EVAL_NEW_POINT_STD_STEP_H
43 #define EVAL_NEW_POINT_STD_STEP_H
44 
45 #include "MoochoPack_DecompositionSystemHandler_Strategy.hpp"
46 #include "IterationPack_AlgorithmStep.hpp"
47 #include "ConstrainedOptPack_DecompositionSystemTester.hpp"
48 #include "ConstrainedOptPack_VariableBoundsTester.hpp"
49 #include "NLPInterfacePack_NLPFirstDerivTester.hpp"
52 
53 namespace MoochoPack {
54 
62  : public IterationPack::AlgorithmStep // doxygen needs full path
63 {
64 public:
65 
68 
70  enum EFDDerivTesting { FD_DEFAULT, FD_TEST, FD_NO_TEST };
71 
73 
76 
80  STANDARD_COMPOSITION_MEMBERS( NLPFirstDerivTester, deriv_tester );
82  STANDARD_COMPOSITION_MEMBERS( VariableBoundsTester, bounds_tester );
84  STANDARD_COMPOSITION_MEMBERS( DecompositionSystemTester, decomp_sys_tester );
100 
106  const decomp_sys_handler_ptr_t &decomp_sys_handler
107  ,const deriv_tester_ptr_t &deriv_tester
108  ,const bounds_tester_ptr_t &bounds_tester
109  ,const decomp_sys_tester_ptr_t &decomp_sys_tester
110  ,EFDDerivTesting fd_deriv_testing = FD_DEFAULT
111  ,DecompositionSystemHandler_Strategy::EDecompSysTesting decomp_sys_testing = DecompositionSystemHandler_Strategy::DST_DEFAULT
112  ,DecompositionSystemHandler_Strategy::EDecompSysPrintLevel decomp_sys_testing_print_level = DecompositionSystemHandler_Strategy::DSPL_USE_GLOBAL
113  );
114 
116 
120  bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
121  , poss_type assoc_step_poss);
123  void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
124  , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
126 
127 private:
128 
129  // Not defined and not to be called
131 
132 }; // end class EvalNewPointStd_Step
133 
134 } // end namespace MoochoPack
135 
136 #endif // EVAL_NEW_POINT_STD_STEP_H
void print_step(const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
STANDARD_MEMBER_COMPOSITION_MEMBERS(EFDDerivTesting, fd_deriv_testing)
Set how and if finite derivatives are tested.
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
Standard new point evaluation step class.
STANDARD_COMPOSITION_MEMBERS(DecompositionSystemHandler_Strategy, decomp_sys_handler)
«std comp» members for range/null decomposition handler