/usr/include/openturns/ComposedNumericalMathGradientImplementation.hxx is in libopenturns-dev 1.5-7build2.
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 | // -*- C++ -*-
/**
* @file ComposedNumericalMathGradientImplementation.hxx
* @brief The class that implements the composition between numerical math functions
*
* Copyright 2005-2015 Airbus-EDF-IMACS-Phimeca
*
* 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 3 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
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* @author schueller
* @date 2012-02-17 19:35:43 +0100 (Fri, 17 Feb 2012)
*/
#ifndef OPENTURNS_COMPOSEDNUMERICALMATHGRADIENTIMPLEMENTATION_HXX
#define OPENTURNS_COMPOSEDNUMERICALMATHGRADIENTIMPLEMENTATION_HXX
#include "NumericalMathGradientImplementation.hxx"
#include "NumericalMathEvaluationImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class ComposedNumericalMathGradientImplementation
*
* The class that implement the composition of two numerical math functions,
* its gradient and its hessian. This class has no implementation class
*/
class OT_API ComposedNumericalMathGradientImplementation
: public NumericalMathGradientImplementation
{
CLASSNAME;
public:
/* Some typedefs for easy reading */
typedef Pointer<NumericalMathEvaluationImplementation> EvaluationImplementation;
typedef Pointer<NumericalMathGradientImplementation> GradientImplementation;
/** Default constructor */
ComposedNumericalMathGradientImplementation(const GradientImplementation & p_leftGradient,
const EvaluationImplementation & p_rightFunction,
const GradientImplementation & p_rightGradient);
/** Virtual constructor */
virtual ComposedNumericalMathGradientImplementation * clone() const;
/** Comparison operator */
Bool operator ==(const ComposedNumericalMathGradientImplementation & other) const;
/** String converter */
virtual String __repr__() const;
/** Method gradient() returns the Jacobian transposed matrix of the function at point */
Matrix gradient(const NumericalPoint & inP) const;
/** Accessor for input point dimension */
UnsignedInteger getInputDimension() const;
/** Accessor for output point dimension */
UnsignedInteger getOutputDimension() const;
/** Method save() stores the object through the StorageManager */
void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(Advocate & adv);
protected:
ComposedNumericalMathGradientImplementation() {};
friend class Factory<ComposedNumericalMathGradientImplementation>;
private:
/** The gradient of f in h = f o g */
GradientImplementation p_leftGradient_;
/** The function g in h = f o g */
EvaluationImplementation p_rightFunction_;
/** The gradient of g in h = f o g */
GradientImplementation p_rightGradient_;
}; /* class ComposedNumericalMathGradientImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_COMPOSEDNUMERICALMATHGRADIENTIMPLEMENTATION_HXX */
|