NLPInterfacePack_NLPSecondOrder.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_SECOND_ORDER_INFO_H
#define NLP_SECOND_ORDER_INFO_H

#include "NLPInterfacePack_NLPFirstOrder.hpp"

namespace NLPInterfacePack {

class NLPSecondOrder : virtual public NLPFirstOrder {
public:

  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixSymOp> >    mat_sym_fcty_ptr_t;


  NLPSecondOrder();


  
  void initialize(bool test_setup);



  virtual const mat_sym_fcty_ptr_t factory_HL() const = 0;



  virtual void set_HL(MatrixSymOp* HL);
  virtual MatrixSymOp* get_HL();
  virtual MatrixSymOp& HL();
  virtual const MatrixSymOp& HL() const;


  
  void unset_quantities();



  virtual void calc_HL(
    const Vector& x, const Vector* lambda, bool newpoint = true) const;



  virtual size_type num_HL_evals() const;


protected:

  struct SecondOrderInfo {
    SecondOrderInfo()
      : HL(NULL), Gc(NULL), Gf(NULL), f(NULL), c(NULL)
      {}
    SecondOrderInfo( MatrixSymOp* HL_in, const FirstOrderInfo& first_order_info )
      :HL(HL_in), Gc(first_order_info.Gc), Gf(first_order_info.Gf)
      ,f(first_order_info.f), c(first_order_info.c)
      {}
    MatrixSymOp*        HL;
    MatrixOp*           Gc;
    VectorMutable*      Gf;
    value_type*         f;
    VectorMutable*      c;
  }; // end struct SecondOrderInfo

  const SecondOrderInfo second_order_info() const;


  virtual void imp_calc_HL(
    const Vector& x, const Vector* lambda, bool newpoint
    ,const SecondOrderInfo& second_order_info
    ) const = 0;


private:

#ifdef DOXYGEN_COMPILE
  Teuchos::AbstractFactory<AbstractLinAlgPack::MatrixSymOp>  *factory_HL;
#endif
  mutable MatrixSymOp   *HL_;
  mutable bool          num_HL_evals_;

};  // end class NLPSecondOrder

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

inline
const NLPSecondOrder::SecondOrderInfo NLPSecondOrder::second_order_info() const
{
  return SecondOrderInfo(HL_,first_order_info());
}

} // end namespace NLPInterfacePack 

#endif // NLP_SECOND_ORDER_INFO_H