/usr/include/openturns/NumericalMathFunctionImplementation.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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | // -*- C++ -*-
/**
* @file NumericalMathFunctionImplementation.hxx
* @brief Abstract top-level class for all numerical math function implementations
*
* (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: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: NumericalMathFunctionImplementation.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_NUMERICALMATHFUNCTIONIMPLEMENTATION_HXX
#define OPENTURNS_NUMERICALMATHFUNCTIONIMPLEMENTATION_HXX
#include "PersistentObject.hxx"
#include "NumericalPoint.hxx"
#include "NumericalPointWithDescription.hxx"
#include "NumericalSample.hxx"
#include "Exception.hxx"
#include "Indices.hxx"
#include "Pointer.hxx"
#include "NumericalMathEvaluationImplementation.hxx"
#include "NumericalMathGradientImplementation.hxx"
#include "NumericalMathHessianImplementation.hxx"
#include "Description.hxx"
#include "WrapperFile.hxx"
namespace OpenTURNS {
namespace Base {
namespace Func {
/**
* @class NumericalMathFunctionImplementation
*
* 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 NumericalMathFunctionImplementation
: public Common::PersistentObject
{
CLASSNAME;
public:
/* Some typedefs for easy reading */
typedef Pointer<NumericalMathFunctionImplementation> Implementation;
typedef NumericalMathEvaluationImplementation::Implementation EvaluationImplementation;
typedef NumericalMathGradientImplementation::Implementation GradientImplementation;
typedef NumericalMathHessianImplementation::Implementation HessianImplementation;
typedef Type::NumericalPoint NumericalPoint;
typedef Type::NumericalPointWithDescription NumericalPointWithDescription;
typedef Stat::NumericalSample NumericalSample;
typedef Type::Matrix Matrix;
typedef Type::SymmetricTensor SymmetricTensor;
typedef Type::Indices Indices;
typedef Type::Description Description;
typedef Common::InvalidArgumentException InvalidArgumentException;
typedef Common::InternalException InternalException;
typedef Common::StorageManager StorageManager;
private:
/** List of muParser valid constants */
static Description ValidConstants_;
/** List of muParser valid functions */
static Description ValidFunctions_;
/** List of muParser valid operators */
static Description ValidOperators_;
/** Flag to tell if the documentation has been initialized */
static Bool IsDocumentationInitialized_;
/** Method that initialize the fields related to the documentation of the analytical functions */
static void InitializeDocumentation();
public:
/** Static methods for documentation of analytical fnctions */
static Description GetValidConstants();
static Description GetValidFunctions();
static Description GetValidOperators();
public:
/** Default constructor */
NumericalMathFunctionImplementation();
/** Constructor from a wrapper name */
NumericalMathFunctionImplementation(const String & name);
/** Constructor from a wrapper file */
NumericalMathFunctionImplementation(const WrapperFile & wrapperFile);
/** Analytical formula constructor */
NumericalMathFunctionImplementation(const Description & inputVariablesNames,
const Description & outputVariablesNames,
const Description & formulas);
/** Database constructor */
NumericalMathFunctionImplementation(const NumericalSample & inputSample,
const NumericalSample & outputSample);
/** Constructor from implementations */
NumericalMathFunctionImplementation(const EvaluationImplementation & funcImpl,
const GradientImplementation & gradImpl,
const HessianImplementation & hessImpl);
/** Single function implementation constructor */
NumericalMathFunctionImplementation(const EvaluationImplementation & evaluationImplementation);
/** Multiplication of two 1D output functions with the same input dimension */
virtual NumericalMathFunctionImplementation operator * (const NumericalMathFunctionImplementation & right) const;
/** Multiplication of two 1D output functions with the same input dimension */
virtual NumericalMathFunctionImplementation operator * (const Implementation & p_right) const;
/** Virtual constructor */
virtual NumericalMathFunctionImplementation * clone() const;
/** Comparison operator */
Bool operator ==(const NumericalMathFunctionImplementation & other) const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Enable or disable the internal cache */
void enableCache() const;
void disableCache() const;
Bool isCacheEnabled() const;
/** Function implementation accessors */
void setEvaluationImplementation(const EvaluationImplementation & evaluationImplementation);
const EvaluationImplementation & getEvaluationImplementation() const;
/** Gradient implementation accessors */
void setGradientImplementation(const GradientImplementation & gradientImplementation);
const GradientImplementation & getGradientImplementation() const;
/** Hessian implementation accessors */
void setHessianImplementation(const HessianImplementation & hessianImplementation);
const HessianImplementation & getHessianImplementation() const;
/** Initial function implementation accessors */
const EvaluationImplementation & getInitialEvaluationImplementation() const;
/** Initial gradient implementation accessors */
const GradientImplementation & getInitialGradientImplementation() const;
/** Initial hessian implementation accessors */
const HessianImplementation & getInitialHessianImplementation() const;
/** Flag for default gradient accessors */
Bool getUseDefaultGradientImplementation() const;
void setUseDefaultGradientImplementation(const Bool gradientFlag);
/** Flag for default hessian accessors */
Bool getUseDefaultHessianImplementation() const;
void setUseDefaultHessianImplementation(const Bool hessianFlag);
/** Operator () */
NumericalPoint operator() (const NumericalPoint & inP) const
/* throw(InvalidArgumentException,InternalException) */;
NumericalSample operator() (const NumericalSample & inS) const
/* throw(InvalidArgumentException, InternalException) */;
/** Method gradient() returns the Jacobian transposed matrix of the function at point */
Matrix gradient(const NumericalPoint & inP) const
/* throw(InvalidArgumentException,InternalException) */;
/** Method hessian() returns the symmetric tensor of the function at point */
SymmetricTensor hessian(const NumericalPoint & inP) const
/* throw(InvalidArgumentException,InternalException) */;
/** Gradient according to the marginal parameters */
virtual Matrix parametersGradient(const NumericalPoint & inP) const;
/** Parameters value and description accessor */
virtual NumericalPointWithDescription getParameters() const;
virtual void setParameters(const NumericalPointWithDescription & parameters);
/** Accessor for input point dimension */
UnsignedLong getInputNumericalPointDimension() const
/* throw(InternalException) */;
/** Accessor for output point dimension */
UnsignedLong getOutputNumericalPointDimension() const
/* throw(InternalException) */;
/** Accessor for input point dimension */
UnsignedLong getInputDimension() const
/* throw(InternalException) */;
/** Accessor for output point dimension */
UnsignedLong getOutputDimension() const
/* throw(InternalException) */;
/** Description Accessor, i.e. the names of the input and output parameters */
void setDescription(const Description & description);
Description getDescription() const;
/** Input description Accessor, i.e. the names of the input parameters */
Description getInputDescription() const;
/** Output description Accessor, i.e. the names of the Output parameters */
Description getOutputDescription() const;
/** Get the i-th marginal function */
virtual Implementation getMarginal(const UnsignedLong i) const /* throw(InvalidArgumentException) */;
/** Get the function corresponding to indices components */
virtual Implementation getMarginal(const Indices & indices) const /* throw(InvalidArgumentException) */;
/** Number of calls to the evaluation */
UnsignedLong getEvaluationCallsNumber() const;
/** Number of calls to the gradient */
UnsignedLong getGradientCallsNumber() const;
/** Number of calls to the hessian */
UnsignedLong getHessianCallsNumber() const;
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(StorageManager::Advocate & adv);
protected:
/** Initial function implementation accessors */
void setInitialEvaluationImplementation(const EvaluationImplementation & p_initialEvaluationImplementation);
/** Initial gradient implementation accessors */
void setInitialGradientImplementation(const GradientImplementation & p_initialGradientImplementation);
/** Initial hessian implementation accessors */
void setInitialHessianImplementation(const HessianImplementation & p_initialHessianImplementation);
/** This method set the implementations with the values listed in the wrapper file */
void initImplementations(const WrapperFile & wrapperFile);
private:
/** A pointer on the actual numerical math function implementation */
EvaluationImplementation p_evaluationImplementation_;
/** A pointer on the actual numerical math gradient implementation */
GradientImplementation p_gradientImplementation_;
/** A pointer on the actual numerical math hessian implementation */
HessianImplementation p_hessianImplementation_;
/** A pointer on the initial actual numerical math function implementation */
EvaluationImplementation p_initialEvaluationImplementation_;
/** A pointer on the initial actual numerical math gradient implementation */
GradientImplementation p_initialGradientImplementation_;
/** A pointer on the initial actual numerical math hessian implementation */
HessianImplementation p_initialHessianImplementation_;
protected:
/** Flag to tell if the current gradient is a default implementation */
mutable Bool useDefaultGradientImplementation_;
/** Flag to tell if the curren hessian is a default implementation */
mutable Bool useDefaultHessianImplementation_;
}; /* class NumericalMathFunctionImplementation */
} /* namespace Func */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_NUMERICALMATHFUNCTIONIMPLEMENTATION_HXX */
|