NLPInterfacePack_NLPDirect.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_DIRECT_H
#define NLP_FIRST_ORDER_DIRECT_H

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

namespace NLPInterfacePack {

class NLPDirect : virtual public NLPObjGrad
{
public:

  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOp> >               mat_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixSymOp> >            mat_sym_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixSymOpNonsing> > mat_sym_nonsing_fcty_ptr_t;

  void set_factories(
    const mat_sym_fcty_ptr_t             &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    );


  virtual size_type r() const;



  virtual Range1D var_dep() const;
  virtual Range1D var_indep() const;
  virtual Range1D con_decomp() const;
  virtual Range1D con_undecomp() const;


  
  virtual const mat_fcty_ptr_t factory_GcU() const;
  virtual const mat_fcty_ptr_t factory_D() const = 0;
  virtual const mat_fcty_ptr_t factory_Uz() const;
  virtual const mat_fcty_ptr_t factory_GcUD() const;

  virtual const mat_sym_fcty_ptr_t factory_transDtD() const;
  
  virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const;



  virtual void calc_point(
    const Vector     &x
    ,value_type      *f
    ,VectorMutable   *c
    ,bool            recalc_c
    ,VectorMutable   *Gf
    ,VectorMutable   *py
    ,VectorMutable   *rGf
    ,MatrixOp        *GcU
    ,MatrixOp        *D
    ,MatrixOp        *Uz
    ) const = 0;

  virtual void calc_semi_newton_step(
    const Vector    &x
    ,VectorMutable  *c
    ,bool           recalc_c
    ,VectorMutable  *py
    ) const = 0;



  void initialize(bool test_setup);


private:
  mat_sym_fcty_ptr_t             factory_transDtD_;
  mat_sym_nonsing_fcty_ptr_t     factory_S_;

};  // end class NLPDirect

} // end namespace NLPInterfacePack

#endif   // NLP_FIRST_ORDER_DIRECT_H