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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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