OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp

Go to the documentation of this file.

/*
// @HEADER
// ***********************************************************************
// 
//    OptiPack: Collection of simple Thyra-based Optimization ANAs
//                 Copyright (2009) 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 OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP
#define OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP


#include "OptiPack_Types.hpp"
#include "GlobiPack_MeritFunc1DBase.hpp"
#include "OptiPack_LineSearchPointEvaluatorBase.hpp"
#include "Thyra_OperatorVectorTypes.hpp"


namespace OptiPack {


template<typename Scalar>
class UnconstrainedOptMeritFunc1D
  : public GlobiPack::MeritFunc1DBase<typename ScalarTraits<Scalar>::magnitudeType>
{
public:

  typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;


  UnconstrainedOptMeritFunc1D();

  void setModel(
    const RCP<const Thyra::ModelEvaluator<Scalar> > &model,
    const int paramIndex,
    const int responseIndex
    );

  void setEvaluationQuantities(
    const RCP<const LineSearchPointEvaluatorBase<Scalar> > &pointEvaluator,
    const RCP<Thyra::VectorBase<Scalar> > &p,
    const RCP<Thyra::VectorBase<Scalar> > &g_vec,
    const RCP<Thyra::VectorBase<Scalar> > &g_grad_vec
    );


  
  virtual bool supportsDerivEvals() const;
  virtual void eval( const ScalarMag &alpha, const Ptr<ScalarMag> &phi,
    const Ptr<ScalarMag> &Dphi ) const;


private:

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

  RCP<const Thyra::ModelEvaluator<Scalar> > model_;
  int paramIndex_;
  int responseIndex_;

  RCP<const LineSearchPointEvaluatorBase<Scalar> > pointEvaluator_;
  RCP<Thyra::VectorBase<Scalar> > p_;
  RCP<Thyra::VectorBase<Scalar> > g_vec_;
  RCP<Thyra::VectorBase<Scalar> > g_grad_vec_;

};


template<typename Scalar>
const RCP<UnconstrainedOptMeritFunc1D<Scalar> >
unconstrainedOptMeritFunc1D(
  const RCP<const Thyra::ModelEvaluator<Scalar> > &model,
  const int paramIndex,
  const int responseIndex
  )
{
  const RCP<UnconstrainedOptMeritFunc1D<Scalar> > meritFunc = 
    Teuchos::rcp(new UnconstrainedOptMeritFunc1D<Scalar>);
  meritFunc->setModel(model, paramIndex, responseIndex);
  return meritFunc;
}


} // namespace OptiPack


#endif // OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP