/usr/include/trilinos/OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | /*
// @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 {
/** \brief Concreate subclass for unconstrained optimization objective
* function.
*
* This subclass turns a response-only ModelEvaluator for an unconstrained
* optimization problem <tt>g(p)</tt> into a 1D merit function.
*
* ToDo: Finish Documentation!
*/
template<typename Scalar>
class UnconstrainedOptMeritFunc1D
: public GlobiPack::MeritFunc1DBase<typename ScalarTraits<Scalar>::magnitudeType>
{
public:
/** \brief . */
typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
/** \name Constructor/Initializers/Accessors */
//@{
/** \brief Construct with default parameters. */
UnconstrainedOptMeritFunc1D();
/** \brief Set the model. */
void setModel(
const RCP<const Thyra::ModelEvaluator<Scalar> > &model,
const int paramIndex,
const int responseIndex
);
/** \brief Set the evaluation qualities.
*
* \param pointEvaluator [persisting non-modified] Evaluates p = p(alpha).
*
* \param p [persisting modified] Point that is updated with every call to
* <tt>eval(...)</tt>.
*
* \param g_vec [persisting modified] The 1D vector used to store the
* objective value computed by <tt>model</tt>.
*
* \param g_grad_vec [persisting modified] If <tt>!is_null(g_grad_vec)</tt>,
* then this will be updated when <tt>eval(...)</tt> is called.
*
* \param baseDeriv [in] If <tt>!is_null(baseDeriv)</tt>, then gives the
* value to be returned in <tt>this->baseDeriv()</tt>.
*
* <b>Postconditions:</b><ul>
*
* <li> [<tt>!is_null(g_grad_vec)</tt>]
* <tt>this->supportsDerivEvals()==true</tt>
*
* <li> [<tt>!is_null(baseDeriv)</tt>]
* <tt>this->supportsBaseDeriv()==true</tt>
*
* </ul>
*/
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
);
//@}
/** \name Overridden from MeritFunc1DBase. */
//@{
/** \brief . */
virtual bool supportsDerivEvals() const;
/** \brief . */
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_;
};
/** \brief Nonmember constructor.
*
* \relates UnconstrainedOptMeritFunc1D
*/
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
|