/usr/include/trilinos/GlobiPack_MeritFunc1DBase.hpp is in libtrilinos-globipack-dev 12.10.1-3.
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 | /*
// @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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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
|