/usr/include/openturns/LinearGradient.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 95 96 97 98 99 100 101 102 103 104 105 106 107 | // -*- C++ -*-
/**
* @brief Class for a quadratic numerical math gradient implementation
*
* 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_LINEARGRADIENT_HXX
#define OPENTURNS_LINEARGRADIENT_HXX
#include "openturns/GradientImplementation.hxx"
#include "openturns/Matrix.hxx"
#include "openturns/SymmetricTensor.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class LinearGradient
*
* This class offers an interface for an real numerical mathematical gradient
* implementations into the platform. It realizes the computation of the image matrix
* of a vector (aka Point) through the gradient. The
* gradient may be loaded in an external way through a wrapper.
*/
class OT_API LinearGradient
: public GradientImplementation
{
CLASSNAME;
public:
/** Default constructor */
LinearGradient();
/** Parameter constructor */
LinearGradient(const Point & center,
const Matrix & constant,
const SymmetricTensor & linear);
/** Virtual constructor */
virtual LinearGradient * clone() const;
/** Comparison operator */
Bool operator ==(const LinearGradient & other) const;
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** Gradient method */
virtual Matrix gradient(const Point & inP) const;
/** Accessor for input point dimension */
virtual UnsignedInteger getInputDimension() const;
/** Accessor for output point dimension */
virtual UnsignedInteger getOutputDimension() const;
/** Accessor for the center */
Point getCenter() const;
/** Accessor for the constant term */
Matrix getConstant() const;
/** Accessor for the linear term */
SymmetricTensor getLinear() 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:
private:
Point center_;
Matrix constant_;
SymmetricTensor linear_;
}; /* class LinearGradient */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_LINEARGRADIENT_HXX */
|