/usr/include/openturns/GradientImplementation.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 108 109 110 111 112 113 114 115 116 117 118 119 | // -*- C++ -*-
/**
* @brief Abstract top-level class for all numerical math gradient implementations
*
* 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_GRADIENTIMPLEMENTATION_HXX
#define OPENTURNS_GRADIENTIMPLEMENTATION_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/Point.hxx"
#include "openturns/PointWithDescription.hxx"
#include "openturns/Description.hxx"
#include "openturns/Indices.hxx"
#include "openturns/Matrix.hxx"
#include "openturns/Tensor.hxx"
#include "openturns/Pointer.hxx"
#include "openturns/StorageManager.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class GradientImplementation
*
* This class offers an abstract interface for the implementation
* of an real numerical mathematical Gradient into the platform.
*/
class OT_API GradientImplementation
: public PersistentObject
{
CLASSNAME;
public:
typedef Pointer<GradientImplementation> Implementation;
/** Default constructor */
GradientImplementation();
/** The Gradient that actually realizes assignment between objects */
/** Virtual constructor */
virtual GradientImplementation * clone() const;
/** Comparison operator */
Bool operator ==(const GradientImplementation & other) const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Get the i-th marginal evaluation */
virtual Implementation getMarginal(const UnsignedInteger i) const;
/** Get the evaluation corresponding to indices components */
virtual Implementation getMarginal(const Indices & indices) const;
/** Test for actual implementation */
virtual Bool isActualImplementation() const;
/* Here is the interface that all derived class must implement */
/** Gradient method */
virtual Matrix gradient(const Point & inP) const;
virtual Matrix gradient(const Point & inP,
const Point & parameters);
/** Accessor for input point dimension */
virtual UnsignedInteger getInputDimension() const;
/** Accessor for output point dimension */
virtual UnsignedInteger getOutputDimension() const;
/** Parameters value accessor */
virtual Point getParameter() const;
virtual void setParameter(const Point & parameter);
/** Get the number of calls to operator() */
UnsignedInteger getCallsNumber() 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:
/** Number of calls since the construction */
mutable UnsignedInteger callsNumber_;
private:
/** The value of the parameters */
Point parameter_;
}; /* class GradientImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_GRADIENTIMPLEMENTATION_HXX */
|