/usr/include/openturns/DynamicalFunctionImplementation.hxx is in libopenturns-dev 1.2-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 | // -*- C++ -*-
/**
* @file DynamicalFunctionImplementation.hxx
* @brief Abstract top-level class for all numerical math function implementations
*
* Copyright (C) 2005-2013 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 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 2011-04-11 12:32:27 +0200 (lun. 11 avril 2011)
*/
#ifndef OPENTURNS_DYNAMICALFUNCTIONIMPLEMENTATION_HXX
#define OPENTURNS_DYNAMICALFUNCTIONIMPLEMENTATION_HXX
#include "PersistentObject.hxx"
#include "Description.hxx"
#include "TimeSeries.hxx"
#include "ProcessSample.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class DynamicalFunctionImplementation
*
* The class that simulates a numerical math function,
* its gradient and its hessian. This class is just an interface
* to actual implementation objects that can be hot-replaced
* during computation. Each implementation object refers to
* the evaluation, the gradient or the hessian.
*/
class DynamicalFunctionImplementation
: public PersistentObject
{
CLASSNAME;
public:
/* Some typedefs for easy reading */
typedef Pointer<DynamicalFunctionImplementation> Implementation;
/** Default constructor */
DynamicalFunctionImplementation();
/** Virtual constructor */
virtual DynamicalFunctionImplementation * clone() const;
/** Comparison operator */
Bool operator ==(const DynamicalFunctionImplementation & other) const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Operator () */
virtual NumericalPoint operator() (const NumericalScalar timeStamp,
const NumericalPoint & inP) const;
virtual TimeSeries operator() (const TimeSeries & inTS) const;
virtual ProcessSample operator() (const ProcessSample & inPS) const;
/** Accessor for input point dimension */
virtual UnsignedLong getInputDimension() const;
/** Accessor for output point dimension */
virtual UnsignedLong getOutputDimension() const;
/** Input description Accessor, i.e. the names of the input parameters */
virtual void setInputDescription(const Description & inputDescription);
virtual Description getInputDescription() const;
/** Output description Accessor, i.e. the names of the Output parameters */
virtual void setOutputDescription(const Description & outputDescription);
virtual Description getOutputDescription() const;
/** Get the i-th marginal function */
virtual Implementation getMarginal(const UnsignedLong i) const;
/** Get the function corresponding to indices components */
virtual Implementation getMarginal(const Indices & indices) const;
/** Number of calls to the dynamical function */
virtual UnsignedLong getCallsNumber() const;
/** Compute the output time grid based on a given input time grid */
virtual RegularGrid computeOutputTimeGrid(const RegularGrid & inputTimeGrid) const;
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
protected:
/** Description of the input variables */
Description inputDescription_;
/** Description of the output variables */
Description outputDescription_;
/** Counter for the number of calls */
mutable UnsignedLong callsNumber_;
}; /* class DynamicalFunctionImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_DYNAMICALFUNCTIONIMPLEMENTATION_HXX */
|