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.
// 
// 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_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