NLPInterfacePack_NLPObjGrad.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef NLP_OBJ_GRADIENT_H
#define NLP_OBJ_GRADIENT_H

#include "NLPInterfacePack_NLP.hpp"

namespace NLPInterfacePack {
class NLPObjGrad : virtual public NLP {
public:


  NLPObjGrad();



  void initialize(bool test_setup);



  virtual bool supports_Gf() const;

  virtual bool supports_Gf_prod() const;



  virtual void set_Gf(VectorMutable* Gf);
  virtual VectorMutable* get_Gf();
  virtual VectorMutable& Gf();
  virtual const Vector& Gf() const;


  
  void unset_quantities();



  virtual void calc_Gf(const Vector& x, bool newx = true) const;

  virtual value_type calc_Gf_prod(const Vector& x, const Vector& d, bool newx = true) const;




  virtual size_type num_Gf_evals() const;
  

  
  struct ObjGradInfo {
    ObjGradInfo()
      : Gf(NULL), f(NULL), c(NULL)
    {}
    ObjGradInfo( VectorMutable* Gf_in, const ZeroOrderInfo& first_order_info_in )
      : Gf(Gf_in), f(first_order_info_in.f), c(first_order_info_in.c)
    {}
    VectorMutable*       Gf;
    value_type*          f;
    VectorMutable*       c;
  }; // end struct ObjGradInfo


protected:

  const ObjGradInfo obj_grad_info() const;


  virtual void imp_calc_Gf(const Vector& x, bool newx, const ObjGradInfo& obj_grad_info) const = 0;


private:

  mutable VectorMutable     *Gf_;
  mutable size_type         num_Gf_evals_;

};  // end class NLPObjGrad

// //////////////////
// Inline members

inline
const NLPObjGrad::ObjGradInfo NLPObjGrad::obj_grad_info() const
{
  return ObjGradInfo(Gf_,zero_order_info());
}

} // end namespace NLPInterfacePack 

#endif // NLP_OBJ_GRADIENT_H