/usr/include/openturns/FiniteDifferenceGradient.hxx is in libopenturns-dev 0.15-2.
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 | // -*- C++ -*-
/**
* @file FiniteDifferenceGradient.hxx
* @brief Class for the creation of a numerical math gradient implementation
* form a numerical math evaluation implementation by using centered
* finite difference formula.
*
* (C) Copyright 2005-2011 EDF-EADS-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 2.1 of the License.
*
* 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
*
* @author: $LastChangedBy: slama $
* @date: $LastChangedDate: 2008-11-19 16:10:42 +0100 (mer, 19 nov 2008) $
* Id: $Id: FiniteDifferenceGradient.hxx 1023 2008-11-19 15:10:42Z slama $
*/
#ifndef OPENTURNS_FINITEDIFFERENCEGRADIENT_HXX
#define OPENTURNS_FINITEDIFFERENCEGRADIENT_HXX
#include "NumericalMathGradientImplementation.hxx"
#include "NumericalMathEvaluationImplementation.hxx"
#include "Pointer.hxx"
#include "FiniteDifferenceStep.hxx"
namespace OpenTURNS {
namespace Base {
namespace Diff {
/**
* @class FiniteDifferenceGradient
*
* 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 FiniteDifferenceGradient
: public Base::Func::NumericalMathGradientImplementation
{
CLASSNAME;
public:
typedef Func::NumericalMathGradientImplementation::Description Description;
typedef Func::NumericalMathGradientImplementation::NumericalPoint NumericalPoint;
typedef Func::NumericalMathGradientImplementation::Matrix Matrix;
typedef Func::NumericalMathGradientImplementation::Tensor Tensor;
typedef Func::NumericalMathGradientImplementation::InvalidArgumentException InvalidArgumentException;
typedef Func::NumericalMathGradientImplementation::InternalException InternalException;
typedef Func::NumericalMathGradientImplementation::StorageManager StorageManager;
typedef Common::InvalidDimensionException InvalidDimensionException;
typedef Pointer<Func::NumericalMathEvaluationImplementation> EvaluationImplementation;
typedef Base::Diff::FiniteDifferenceStep FiniteDifferenceStep;
/** Default constructor */
FiniteDifferenceGradient();
/** First Parameter constructor */
FiniteDifferenceGradient(const NumericalPoint & epsilon,
const EvaluationImplementation & p_evaluation);
/** SecondParameter constructor */
FiniteDifferenceGradient(const NumericalScalar epsilon,
const EvaluationImplementation & p_evaluation);
/** Constructor with FiniteDifferenceStep */
FiniteDifferenceGradient(const FiniteDifferenceStep & finiteDifferenceStep,
const EvaluationImplementation & p_evaluation);
/** Comparison operator */
virtual Bool operator ==(const FiniteDifferenceGradient & other) const;
/** String converter */
virtual String __repr__() const;
/** Accessor for input point dimension
* @return The size of the point passed to the gradient method
*/
virtual UnsignedLong getInputDimension() const;
/** Accessor for output point dimension
* @return The size of the point returned by the function whose gradient is computed
*/
virtual UnsignedLong getOutputDimension() const;
/** Accessor for the epsilon */
virtual NumericalPoint getEpsilon() const;
/** Accessor for the evaluation */
virtual EvaluationImplementation getEvaluation() const;
/** Accessor for the finite difference step */
virtual void setFiniteDifferenceStep(const FiniteDifferenceStep & finiteDifferenceStep);
virtual FiniteDifferenceStep getFiniteDifferenceStep() const;
/* Method save() stores the object through the StorageManager */
virtual void save(StorageManager::Advocate & adv) const;
/* Method load() reloads the object from the StorageManager */
virtual void load(StorageManager::Advocate & adv);
/* Here is the interface that all derived class must implement */
/** Virtual Constructor */
virtual FiniteDifferenceGradient * clone() const = 0;
/** 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 NumericalPoint & inP) const = 0;
protected:
EvaluationImplementation p_evaluation_;
FiniteDifferenceStep finiteDifferenceStep_;
}; /* class FiniteDifferenceGradient */
} /* namespace Func */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_FINITEDIFFERENCEGRADIENT_HXX */
|