NLPInterfacePack_NLPFirstOrder.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_FIRST_ORDER_INFO_H
#define NLP_FIRST_ORDER_INFO_H

#include "NLPInterfacePack_NLPObjGrad.hpp"
#include "Teuchos_AbstractFactory.hpp"

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

  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOp> >        mat_fcty_ptr_t;
  typedef Teuchos::RCP<BasisSystem>           basis_sys_ptr_t;


  NLPFirstOrder();



  void initialize(bool test_setup);


  
  virtual const mat_fcty_ptr_t factory_Gc() const = 0;



  virtual const basis_sys_ptr_t basis_sys() const;



  virtual void set_Gc(MatrixOp* Gc);
  virtual MatrixOp* get_Gc();
  virtual MatrixOp& Gc();
  virtual const MatrixOp& Gc() const;


  
  void unset_quantities();



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



  virtual size_type num_Gc_evals() const;


  struct FirstOrderInfo {
    FirstOrderInfo()
      : Gc(NULL), Gf(NULL), f(NULL), c(NULL)
    {}
    FirstOrderInfo( MatrixOp* Gc_in, const ObjGradInfo& obj_grad )
      : Gc(Gc_in), Gf(obj_grad.Gf), f(obj_grad.f), c(obj_grad.c)
    {}
    MatrixOp*           Gc;
    VectorMutable*      Gf;
    value_type*         f;
    VectorMutable*      c;
  }; // end struct FirstOrderInfo

protected:

  const FirstOrderInfo first_order_info() const;


  virtual void imp_calc_Gc(const Vector& x, bool newx, const FirstOrderInfo& first_order_info) const = 0;


private:

#ifdef DOXYGEN_COMPILE
  AbstractLinAlgPack::BasisSystem                            *basis_sys;
  Teuchos::AbstractFactory<AbstractLinAlgPack::MatrixOp>  *factory_Gc;
#endif
  mutable MatrixOp      *Gc_;
  mutable size_type     num_Gc_evals_;

};  // end class NLPFirstOrder

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

inline
const NLPFirstOrder::FirstOrderInfo NLPFirstOrder::first_order_info() const
{
  return FirstOrderInfo(Gc_,obj_grad_info());
}

} // end namespace NLPInterfacePack 

#endif // NLP_FIRST_ORDER_INFO_H