MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_EvalNewPointTailoredApproach_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_TAILORED_APPROACH_STEP_H
43 #define EVAL_NEW_POINT_TAILORED_APPROACH_STEP_H
44 
45 #include "MoochoPack_Types.hpp"
46 #include "IterationPack_AlgorithmStep.hpp"
47 #include "ConstrainedOptPack_VariableBoundsTester.hpp"
48 #include "NLPInterfacePack_NLPDirectTester.hpp"
51 
52 namespace MoochoPack {
53 
61  : public IterationPack::AlgorithmStep // doxygen needs full path
62 {
63 public:
64 
68  enum EFDDerivTesting { FD_DEFAULT, FD_TEST, FD_NO_TEST };
70 
73 
77  STANDARD_COMPOSITION_MEMBERS( NLPDirectTester, deriv_tester );
79  STANDARD_COMPOSITION_MEMBERS( VariableBoundsTester, bounds_tester );
85 
88  const deriv_tester_ptr_t& deriv_tester
89  , const bounds_tester_ptr_t& bounds_tester
90  , EFDDerivTesting fd_deriv_testing = FD_DEFAULT
91  );
92 
94 
98  bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
99  , poss_type assoc_step_poss);
101  void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
102  , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
104 
107 
112  virtual void uninitialize_Y_Uy(
113  MatrixOp *Y
114  ,MatrixOp *Uy
115  ) = 0;
116 
130  virtual void calc_py_Y_Uy(
131  const NLPDirect &nlp
132  ,const D_ptr_t &D
133  ,VectorMutable *py
134  ,MatrixOp *Y
135  ,MatrixOp *Uy
136  ,EJournalOutputLevel olevel
137  ,std::ostream &out
138  ) = 0;
139 
146  virtual void recalc_py(
147  const MatrixOp &D
148  ,VectorMutable *py
149  ,EJournalOutputLevel olevel
150  ,std::ostream &out
151  ) = 0;
152 
155  virtual void print_calc_py_Y_Uy(
156  std::ostream& out, const std::string& leading_str
157  ) const = 0;
158 
160 
161 private:
162 
163  // Not defined and not to be called
165 
166 }; // end class EvalNewPointTailoredApproach_Step
167 
168 } // end namespace MoochoPack
169 
170 #endif // EVAL_NEW_POINT_TAILORED_APPROACH_STEP_H
virtual void print_calc_py_Y_Uy(std::ostream &out, const std::string &leading_str) const =0
Overridden by subclass to print how py and Y are computed.
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
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.
virtual void uninitialize_Y_Uy(MatrixOp *Y, MatrixOp *Uy)=0
Call to uninitialize the matrices.
Base class for evaluating a new point for the "Tailored Approach".
STANDARD_COMPOSITION_MEMBERS(NLPDirectTester, deriv_tester)
<<std comp>="">> members for testing object for NLPDirect
virtual void recalc_py(const MatrixOp &D, VectorMutable *py, EJournalOutputLevel olevel, std::ostream &out)=0
Overridden by subclass to recompute py and Ypy.
virtual void calc_py_Y_Uy(const NLPDirect &nlp, const D_ptr_t &D, VectorMutable *py, MatrixOp *Y, MatrixOp *Uy, EJournalOutputLevel olevel, std::ostream &out)=0
Overridden by subclass to compute py, Y and Uy.