MOOCHO Version of the Day
NLPInterfacePack_ExampleNLPDirect.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_DIRECT_H
00043 #define EXAMPLE_NLP_FIRST_ORDER_DIRECT_H
00044 
00045 #include "NLPInterfacePack_ExampleNLPObjGrad.hpp"
00046 #include "NLPInterfacePack_NLPDirect.hpp"
00047 #include "AbstractLinAlgPack_VectorMutable.hpp"
00048 #include "AbstractLinAlgPack_VectorSpace.hpp"
00049 #include "AbstractLinAlgPack_VectorSpaceBlocked.hpp"
00050 
00051 namespace NLPInterfacePack {
00052 
00103 class ExampleNLPDirect
00104   : virtual public NLPDirect
00105   , virtual public ExampleNLPObjGrad
00106 {
00107 public:
00108 
00122   ExampleNLPDirect(
00123     const VectorSpace::space_ptr_t&  vec_space
00124     ,value_type                      xo
00125     ,bool                            has_bounds
00126     ,bool                            dep_bounded
00127     );
00128 
00131 
00133   void initialize(bool test_setup);
00135   bool is_initialized() const;
00136 
00138 
00141 
00143   Range1D var_dep() const;
00145   Range1D var_indep() const;
00147   const mat_fcty_ptr_t factory_D() const;
00149   void calc_point(
00150     const Vector     &x
00151     ,value_type      *f
00152     ,VectorMutable   *c
00153     ,bool            recalc_c
00154     ,VectorMutable   *Gf
00155     ,VectorMutable   *py
00156     ,VectorMutable   *rGf
00157     ,MatrixOp        *GcU
00158     ,MatrixOp        *D
00159     ,MatrixOp        *Uz
00160     ) const;
00162   void calc_semi_newton_step(
00163     const Vector    &x
00164     ,VectorMutable  *c
00165     ,bool           recalc_c
00166     ,VectorMutable  *py
00167     ) const;
00168 
00170 
00171 private:
00172 
00173   // /////////////////////////////////////////
00174   // Private data members
00175 
00176   mat_fcty_ptr_t   factory_D_;         // Matrix space object for D
00177 
00178   bool             initialized_;            // flag for if initialized has been called.
00179 
00180   // /////////////////////////////////////////
00181   // Private member functions
00182 
00184   void assert_is_initialized() const;
00185 
00186 };  // end class ExampleNLPDirect
00187 
00188 // ///////////////////////////////////////////////
00189 // Inline member functions
00190 
00191 inline
00192 void ExampleNLPDirect::assert_is_initialized() const
00193 {
00194   typedef NLPInterfacePack::NLP NLP;
00195   if( !is_initialized() )
00196     throw NLP::UnInitialized("ExampleNLPDirect::assert_is_initialized() : Error, "
00197       "ExampleNLPDirect::initialize() has not been called yet." );
00198 }
00199 
00200 } // end namespace NLPInterfacePack
00201 
00202 #endif  // EXAMPLE_NLP_FIRST_ORDER_DIRECT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends