NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs Version of the Day
NLPInterfacePack_NLPObjGrad.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 NLP_OBJ_GRADIENT_H
00043 #define NLP_OBJ_GRADIENT_H
00044 
00045 #include "NLPInterfacePack_NLP.hpp"
00046 
00047 namespace NLPInterfacePack {
00079 class NLPObjGrad : virtual public NLP {
00080 public:
00081 
00084 
00086   NLPObjGrad();
00087 
00089 
00092 
00104   void initialize(bool test_setup);
00105 
00107 
00110 
00115   virtual bool supports_Gf() const;
00116 
00121   virtual bool supports_Gf_prod() const;
00122 
00124 
00127 
00143   virtual void set_Gf(VectorMutable* Gf);
00151   virtual VectorMutable* get_Gf();
00160   virtual VectorMutable& Gf();
00169   virtual const Vector& Gf() const;
00170 
00172 
00175   
00189   void unset_quantities();
00190 
00192 
00195 
00219   virtual void calc_Gf(const Vector& x, bool newx = true) const;
00220 
00244   virtual value_type calc_Gf_prod(const Vector& x, const Vector& d, bool newx = true) const;
00245 
00247 
00249 
00252 
00258   virtual size_type num_Gf_evals() const;
00259   
00261 
00264   
00267   struct ObjGradInfo {
00269     ObjGradInfo()
00270       : Gf(NULL), f(NULL), c(NULL)
00271     {}
00273     ObjGradInfo( VectorMutable* Gf_in, const ZeroOrderInfo& first_order_info_in )
00274       : Gf(Gf_in), f(first_order_info_in.f), c(first_order_info_in.c)
00275     {}
00277     VectorMutable*       Gf;
00279     value_type*          f;
00281     VectorMutable*       c;
00282   }; // end struct ObjGradInfo
00283 
00285 
00286 protected:
00287 
00289   const ObjGradInfo obj_grad_info() const;
00290 
00293 
00317   virtual void imp_calc_Gf(const Vector& x, bool newx, const ObjGradInfo& obj_grad_info) const = 0;
00318 
00320 
00321 private:
00322 
00323   mutable VectorMutable     *Gf_;
00324   mutable size_type         num_Gf_evals_;
00325 
00326 };  // end class NLPObjGrad
00327 
00328 // //////////////////
00329 // Inline members
00330 
00331 inline
00332 const NLPObjGrad::ObjGradInfo NLPObjGrad::obj_grad_info() const
00333 {
00334   return ObjGradInfo(Gf_,zero_order_info());
00335 }
00336 
00337 } // end namespace NLPInterfacePack 
00338 
00339 #endif // NLP_OBJ_GRADIENT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends