MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NLPInterfacePack_NLPSecondOrder.cpp
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 
43 #include "Teuchos_Assert.hpp"
44 
45 namespace {
46  const char name_HL[] = "HL";
47 }
48 
49 namespace NLPInterfacePack {
50 
51 // constructors
52 
54  : HL_(NULL)
55 {}
56 
57 
58 void NLPSecondOrder::initialize(bool test_setup) {
59  num_HL_evals_ = 0;
60  NLPFirstOrder::initialize(test_setup);
61 }
62 
63 // <<std aggr>> members for HL
64 
65 void NLPSecondOrder::set_HL(MatrixSymOp* HL)
66 {
67  HL_ = HL;
68 }
69 
70 MatrixSymOp* NLPSecondOrder::get_HL()
71 {
73 }
74 
75 MatrixSymOp& NLPSecondOrder::HL()
76 {
78 }
79 
80 const MatrixSymOp& NLPSecondOrder::HL() const
81 {
83 }
84 
86 {
88  HL_ = NULL;
89 }
90 
91 // calculations
92 
94  const Vector& x, const Vector* lambda, bool newpoint
95  ) const
96 {
97 #ifdef TEUCHOS_DEBUG
98  TEUCHOS_TEST_FOR_EXCEPTION( lambda && this->m() == 0, std::logic_error, "" );
99 #endif
101  imp_calc_HL(x,lambda,newpoint,second_order_info());
102 }
103 
105 {
106  return num_HL_evals_;
107 }
108 
109 } // namespace NLPInterfacePack
AbstractLinAlgPack::size_type size_type
NLPSecondOrder()
Initialize to no reference set to calculation quanities.
void initialize(bool test_setup)
Initialize the NLP for its first use.
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
virtual MatrixSymOp & HL()
Returns non-const *this->get_HL().
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void initialize(bool test_setup)
Initialize the NLP for its first use.
ContainedClass * get_role_name(ContainedClass *role_name_, bool owns_role_name_, const char name[])
void unset_quantities()
Call to unset all storage quantities (both in this class and all subclasses).
virtual void set_HL(MatrixSymOp *HL)
Set a pointer to a matrix object to be updated when this->calc_HL() is called.
virtual size_type num_HL_evals() const
Number of Hessian evaluations.
virtual MatrixSymOp * get_HL()
Return pointer passed to this->set_HL().
void assert_role_name_set(const ContainedClass *role_name_, const char func_name[], const char name[])
Assert that the reference is set.
virtual void imp_calc_HL(const Vector &x, const Vector *lambda, bool newpoint, const SecondOrderInfo &second_order_info) const =0
Overridden to compute Gc(x) and perhaps Gf(x), f(x) and c(x).
ContainedClass & role_name(ContainedClass *role_name_, bool owns_role_name_, const char name[])
void unset_quantities()
Call to unset all storage quantities (both in this class and all subclasses).
virtual void calc_HL(const Vector &x, const Vector *lambda, bool newpoint=true) const
Update the matrix for HL at the point x, lambda, lambdaI and put it in the stored reference...
virtual size_type m() const
Return the number of general equality constraints.
const SecondOrderInfo second_order_info() const
Return objective gradient and zero order information.