MOOCHO Version of the Day
NLPInterfacePack_ExampleNLPFirstOrder.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef EXAMPLE_NLP_FIRST_ORDER_INFO_H
00043 #define EXAMPLE_NLP_FIRST_ORDER_INFO_H
00044 
00045 #include "NLPInterfacePack_ExampleNLPObjGrad.hpp"
00046 #include "NLPInterfacePack_NLPFirstOrder.hpp"
00047 
00048 namespace NLPInterfacePack {
00049 
00073 class ExampleNLPFirstOrder
00074   : virtual public NLPFirstOrder
00075   , virtual public ExampleNLPObjGrad
00076 {
00077 public:
00078 
00081   ExampleNLPFirstOrder(
00082     const VectorSpace::space_ptr_t&  vec_space
00083     ,value_type                      xo
00084     ,bool                            has_bounds
00085     ,bool                            dep_bounded
00086     );
00087 
00090 
00092   void initialize(bool test_setup);
00094   bool is_initialized() const;
00095 
00097 
00100 
00102   void set_Gc(MatrixOp* Gc);
00104   const NLPFirstOrder::mat_fcty_ptr_t factory_Gc() const;
00106   const basis_sys_ptr_t basis_sys() const;
00107 
00109 
00110 protected:
00111 
00114 
00116   void imp_calc_Gc(const Vector& x, bool newx, const FirstOrderInfo& first_order_info) const;
00117 
00119 
00120 private:
00121 
00122   // /////////////////////////////////////////
00123   // Private data members
00124 
00125   bool                                initialized_;  // flag for if initialized has been called.
00126   NLPFirstOrder::mat_fcty_ptr_t       factory_Gc_;   // Factory for Gc
00127   NLPFirstOrder::basis_sys_ptr_t      basis_sys_;    // The basis system
00128 
00129   // /////////////////////////////////////////
00130   // Private member functions
00131 
00133   void assert_is_initialized() const;
00134 
00135 };  // end class ExampleNLPFirstOrder
00136 
00137 // ///////////////////////////////////////////////
00138 // Inline member functions
00139 
00140 inline
00141 void ExampleNLPFirstOrder::assert_is_initialized() const
00142 {
00143   typedef NLPInterfacePack::NLP NLP;
00144   if( !is_initialized() )
00145     throw NLP::UnInitialized("ExampleNLPFirstOrder::assert_is_initialized() : Error, "
00146       "ExampleNLPFirstOrder::initialize() has not been called yet." );
00147 }
00148 
00149 } // end namespace NLPInterfacePack
00150 
00151 #endif  // EXAMPLE_NLP_FIRST_ORDER_INFO_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends