/usr/include/openturns/ComputedNumericalMathHessianImplementation.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 120 | // -*- C++ -*-
/**
* @file ComputedNumericalMathHessianImplementation.hxx
* @brief Abstract top-level class for all ComputedNumerical math hessians
*
* 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 2012-02-17 19:35:43 +0100 (Fri, 17 Feb 2012)
*/
#ifndef OPENTURNS_COMPUTEDNUMERICALMATHHESSIANIMPLEMENTATION_HXX
#define OPENTURNS_COMPUTEDNUMERICALMATHHESSIANIMPLEMENTATION_HXX
#include "NumericalMathHessianImplementation.hxx"
#include "Pointer.hxx"
#include "NumericalPoint.hxx"
#include "SymmetricTensor.hxx"
#include "WrapperFile.hxx"
BEGIN_NAMESPACE_OPENTURNS
/* Forward declaration */
class WrapperObject;
/**
* @class ComputedNumericalMathHessianImplementation
*
* This class acts like an real numerical mathematical hessian
* into the platform. It realizes the computation of the image tensor
* of a vector (aka NumericalPoint) through the hessian. The
* hessian may be loaded in an external way through a wrapper.
*/
class ComputedNumericalMathHessianImplementation
: public NumericalMathHessianImplementation
{
CLASSNAME;
public:
/* Some typedefs to ease reading */
typedef Pointer<WrapperObject> InternalHessian;
/** Default constructor */
ComputedNumericalMathHessianImplementation(const String & name, const WrapperFile & file, void * p_state = 0);
/** Copy constructor */
ComputedNumericalMathHessianImplementation(const ComputedNumericalMathHessianImplementation & other);
/** Virtual constructor */
virtual ComputedNumericalMathHessianImplementation * clone() const;
/** Destructor */
virtual ~ComputedNumericalMathHessianImplementation();
/** Comparison operator */
Bool operator ==(const ComputedNumericalMathHessianImplementation & other) const;
/** String converter */
String __repr__() const;
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** Hessian method */
virtual SymmetricTensor hessian(const NumericalPoint & inP) const;
/** Accessor for input point dimension */
virtual UnsignedLong getInputDimension() const;
/** Accessor for output point dimension */
virtual UnsignedLong getOutputDimension() 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:
/** The function object that is linked to the external code */
InternalHessian p_hessian_;
/** State management */
void * getState() const;
private:
ComputedNumericalMathHessianImplementation() {};
friend class Factory<ComputedNumericalMathHessianImplementation>;
/** A pointer to an internal structure that saves the state of the function into the wrapper */
void * p_state_;
/** A flag that is true when the gradient shares its internal state with its related function */
Bool commonState_;
}; /* class ComputedNumericalMathHessianImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_COMPUTEDNUMERICALMATHHESSIANIMPLEMENTATION_HXX */
|