/usr/include/openturns/CenteredFiniteDifferenceGradient.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief Class for the creation of a numerical math gradient implementation
* form a numerical math evaluation implementation by using centered
* finite difference formula.
*
* Copyright 2005-2017 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/>.
*
*/
#ifndef OPENTURNS_CENTEREDFINITEDIFFERENCEGRADIENT_HXX
#define OPENTURNS_CENTEREDFINITEDIFFERENCEGRADIENT_HXX
#include "openturns/FiniteDifferenceGradient.hxx"
#include "openturns/EvaluationImplementation.hxx"
#include "openturns/Point.hxx"
#include "openturns/Matrix.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class CenteredFiniteDifferenceGradient
* @brief This class is for the creation of a numerical math gradient implementation
*
* This class is for the creation of a numerical math gradient implementation
* form a numerical math evaluation implementation by using centered
* finite difference formula
*/
class OT_API CenteredFiniteDifferenceGradient
: public FiniteDifferenceGradient
{
CLASSNAME;
public:
typedef Pointer<EvaluationImplementation> EvaluationPointer;
/** Default constructor */
CenteredFiniteDifferenceGradient();
/** Parameter constructor */
CenteredFiniteDifferenceGradient(const Point & epsilon,
const EvaluationPointer & p_evaluation);
/** Second parameter constructor */
CenteredFiniteDifferenceGradient(const Scalar epsilon,
const EvaluationPointer & p_evaluation);
/** Constructor from finite difference step */
CenteredFiniteDifferenceGradient(const FiniteDifferenceStep & step,
const EvaluationPointer & p_evaluation);
/* Virtual constructor */
virtual CenteredFiniteDifferenceGradient * clone() const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** This method computes the gradient at some point
* @param in The point where the gradient is computed
* @result A matrix constructed with the dF_i/dx_j values (Jacobian transposed)
*/
virtual Matrix gradient(const Point & inP) const;
protected:
private:
}; /* class CenteredFiniteDifferenceGradient */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_CENTEREDFINITEDIFFERENCEGRADIENT_HXX */
|