NLPInterfacePack_ExampleNLPDirect.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 EXAMPLE_NLP_FIRST_ORDER_DIRECT_H
#define EXAMPLE_NLP_FIRST_ORDER_DIRECT_H

#include "NLPInterfacePack_ExampleNLPObjGrad.hpp"
#include "NLPInterfacePack_NLPDirect.hpp"
#include "AbstractLinAlgPack_VectorMutable.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "AbstractLinAlgPack_VectorSpaceBlocked.hpp"

namespace NLPInterfacePack {

class ExampleNLPDirect
  : virtual public NLPDirect
  , virtual public ExampleNLPObjGrad
{
public:

  ExampleNLPDirect(
    const VectorSpace::space_ptr_t&  vec_space
    ,value_type                      xo
    ,bool                            has_bounds
    ,bool                            dep_bounded
    );


  void initialize(bool test_setup);
  bool is_initialized() const;



  Range1D var_dep() const;
  Range1D var_indep() const;
  const mat_fcty_ptr_t factory_D() const;
  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;
  void calc_semi_newton_step(
    const Vector    &x
    ,VectorMutable  *c
    ,bool           recalc_c
    ,VectorMutable  *py
    ) const;


private:

  // /////////////////////////////////////////
  // Private data members

  mat_fcty_ptr_t   factory_D_;         // Matrix space object for D

  bool             initialized_;            // flag for if initialized has been called.

  // /////////////////////////////////////////
  // Private member functions

  void assert_is_initialized() const;

};  // end class ExampleNLPDirect

// ///////////////////////////////////////////////
// Inline member functions

inline
void ExampleNLPDirect::assert_is_initialized() const
{
    using NLPInterfacePack::NLP;
  if( !is_initialized() )
    throw NLP::UnInitialized("ExampleNLPDirect::assert_is_initialized() : Error, "
      "ExampleNLPDirect::initialize() has not been called yet." );
}

} // end namespace NLPInterfacePack

#endif  // EXAMPLE_NLP_FIRST_ORDER_DIRECT_H

---