/usr/include/trilinos/GlobiPack_MeritFunc1DBase.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 | /*
// @HEADER
// ***********************************************************************
//
// GlobiPack: Collection of Scalar 1D globalizaton utilities
// 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 GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
#define GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
#include "GlobiPack_Types.hpp"
#include "Teuchos_Describable.hpp"
namespace GlobiPack {
/** \brief Base class for 1D merit fucntions used in globalization methods.
*
* NOTE: The Scalar type must be a real type since comparions are performed
*
* ToDo: Finish Documentation!
*/
template<typename Scalar>
class MeritFunc1DBase : virtual public Teuchos::Describable
{
public:
/** \brief Determine if derivative evaluations are supported or not. */
virtual bool supportsDerivEvals() const = 0;
/** \brief Evaluate the merit function at <tt>alpha</tt>.
*
* \param alpha [in] The value of the independent variable determining the
* step length. Typically <tt>alpha > 0</tt>.
*
* \param phi [out] The value of the merit function evaluated at
* <tt>alpha</tt>.
*
* \param Dphi [out] The value of the derivative of the merit function
* evaluated at <tt>alpha</tt>.
*
* <b>Preconditions:</b><ul>
*
* <li> If <tt>!is_null(Dphi)</tt> then <tt>supportsDerivEvals()</tt> must
* be <tt>true</tt>.
*
* </ul>
*/
virtual void eval( const Scalar &alpha, const Ptr<Scalar> &phi,
const Ptr<Scalar> &Dphi ) const = 0;
};
/** \brief Compute the value of the merit function <tt>phi(alpha)</tt>.
*
* \relates MeritFunc1DBase
*/
template<typename Scalar>
typename ScalarTraits<Scalar>::magnitudeType
computeValue(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha)
{
Scalar phi_val = ScalarTraits<Scalar>::zero();
phi.eval(alpha, Teuchos::outArg(phi_val), Teuchos::null);
return phi_val;
}
/** \brief Compute a point as an object.
*
* \relates MeritFunc1DBase
*/
template<typename Scalar>
PointEval1D<Scalar>
computePoint(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha,
const bool compute_phi = true, const bool compute_Dphi = false)
{
using Teuchos::null;
using Teuchos::outArg;
PointEval1D<Scalar> p;
p.alpha = alpha;
phi.eval( alpha, compute_phi ? outArg(p.phi) : null ,
compute_Dphi ? outArg(p.Dphi) : null );
return p;
}
} // namespace GlobiPack
#endif // GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
|