MOOCHO  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
NLPInterfacePack_ExampleNLPFirstOrder.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 EXAMPLE_NLP_FIRST_ORDER_INFO_H
43 #define EXAMPLE_NLP_FIRST_ORDER_INFO_H
44 
45 #include "NLPInterfacePack_ExampleNLPObjGrad.hpp"
46 #include "NLPInterfacePack_NLPFirstOrder.hpp"
47 
48 namespace NLPInterfacePack {
49 
74  : virtual public NLPFirstOrder
75  , virtual public ExampleNLPObjGrad
76 {
77 public:
78 
82  const VectorSpace::space_ptr_t& vec_space
83  ,value_type xo
84  ,bool has_bounds
85  ,bool dep_bounded
86  );
87 
90 
92  void initialize(bool test_setup);
94  bool is_initialized() const;
95 
97 
100 
102  void set_Gc(MatrixOp* Gc);
106  const basis_sys_ptr_t basis_sys() const;
107 
109 
110 protected:
111 
114 
116  void imp_calc_Gc(const Vector& x, bool newx, const FirstOrderInfo& first_order_info) const;
117 
119 
120 private:
121 
122  // /////////////////////////////////////////
123  // Private data members
124 
125  bool initialized_; // flag for if initialized has been called.
126  NLPFirstOrder::mat_fcty_ptr_t factory_Gc_; // Factory for Gc
127  NLPFirstOrder::basis_sys_ptr_t basis_sys_; // The basis system
128 
129  // /////////////////////////////////////////
130  // Private member functions
131 
133  void assert_is_initialized() const;
134 
135 }; // end class ExampleNLPFirstOrder
136 
137 // ///////////////////////////////////////////////
138 // Inline member functions
139 
140 inline
141 void ExampleNLPFirstOrder::assert_is_initialized() const
142 {
143  typedef NLPInterfacePack::NLP NLP;
144  if( !is_initialized() )
145  throw NLP::UnInitialized("ExampleNLPFirstOrder::assert_is_initialized() : Error, "
146  "ExampleNLPFirstOrder::initialize() has not been called yet." );
147 }
148 
149 } // end namespace NLPInterfacePack
150 
151 #endif // EXAMPLE_NLP_FIRST_ORDER_INFO_H
ExampleNLPFirstOrder(const VectorSpace::space_ptr_t &vec_space, value_type xo, bool has_bounds, bool dep_bounded)
Constructor (see ExampleNLPDirect::ExampleNLPDirect()).
const FirstOrderInfo first_order_info() const
void imp_calc_Gc(const Vector &x, bool newx, const FirstOrderInfo &first_order_info) const
Simple example NLP subclass to illustrate how to implement the NLPObjGrad interface for a specialized...
Simple example NLP subclass to illustrate how to implement the NLPFirstOrder interface for a speciali...
void set_Gc(MatrixOp *Gc)
Overridden to check the concrete type of Gc.
const basis_sys_ptr_t basis_sys() const
Returns an ExampleBasisSystem.
const NLPFirstOrder::mat_fcty_ptr_t factory_Gc() const