MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_ReducedHessianSecantUpdateBFGSFull_Strategy.hpp
Go to the documentation of this file.
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 REDUCED_HESSIAN_SECANT_UPDATE_BFGS_FULL_STRATEGY_H
43 #define REDUCED_HESSIAN_SECANT_UPDATE_BFGS_FULL_STRATEGY_H
44 
49 
50 namespace MoochoPack {
51 
59 {
60 public:
61 
66 
68  const bfgs_update_ptr_t& bfgs_update = Teuchos::null
69  );
70 
74  bool perform_update(
75  VectorMutable *s_bfgs
76  ,VectorMutable *y_bfgs
77  ,bool first_update
78  ,std::ostream & out
79  ,EJournalOutputLevel olevel
80  ,NLPAlgo *algo
81  ,NLPAlgoState *s
82  ,MatrixSymOp *rHL_k
83  );
85  void print_step( std::ostream& out, const std::string& leading_str ) const;
87 
88 private:
90 
91 }; // end class ReducedHessianSecantUpdateBFGSFull_Strategy
92 
93 } // end namespace MoochoPack
94 
95 #endif // REDUCED_HESSIAN_SECANT_UPDATE_BFGS_FULL_STRATEGY_H
STANDARD_COMPOSITION_MEMBERS(BFGSUpdate_Strategy, bfgs_update)
<<std comp>="">> members for the strategy object that will perform guts secant update.
Strategy interface for performing secant updates {abstract}.
rSQP Algorithm control class.
bool perform_update(VectorMutable *s_bfgs, VectorMutable *y_bfgs, bool first_update, std::ostream &out, EJournalOutputLevel olevel, NLPAlgo *algo, NLPAlgoState *s, MatrixSymOp *rHL_k)
EJournalOutputLevel
enum for journal output.
Reduced space SQP state encapsulation interface.
std::ostream * out
Class for object that attempts to return an IterQuantityAccess<QuasiNewtonStats> from an AlgorithmSta...
Strategy interface which contains the guts for a dampened BFGS update.