/usr/include/openturns/ConstantNumericalMathGradientImplementation.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 | // -*- C++ -*-
/**
* @file ConstantNumericalMathGradientImplementation.hxx
* @brief Class for a linear numerical math gradient impelmentation
*
* (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: ConstantNumericalMathGradientImplementation.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_CONSTANTNUMERICALMATHGRADIENTIMPLEMENTATION_HXX
#define OPENTURNS_CONSTANTNUMERICALMATHGRADIENTIMPLEMENTATION_HXX
#include "NumericalMathGradientImplementation.hxx"
#include "Exception.hxx"
#include "Matrix.hxx"
namespace OpenTURNS {
namespace Base {
namespace Func {
/**
* @class ConstantNumericalMathGradientImplementation
*
* 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 NumericalPoint) through the gradient. The
* gradient may be loaded in an external way through a wrapper.
*/
class ConstantNumericalMathGradientImplementation
: public NumericalMathGradientImplementation
{
CLASSNAME;
public:
typedef NumericalMathGradientImplementation::NumericalPoint NumericalPoint;
typedef NumericalMathGradientImplementation::Matrix Matrix;
typedef NumericalMathGradientImplementation::InvalidArgumentException InvalidArgumentException;
typedef NumericalMathGradientImplementation::InternalException InternalException;
typedef NumericalMathGradientImplementation::StorageManager StorageManager;
typedef Common::InvalidDimensionException InvalidDimensionException;
/** Default constructor */
ConstantNumericalMathGradientImplementation();
/** Parameter constructor */
ConstantNumericalMathGradientImplementation(const Matrix & constant)
/* throw(InvalidDimensionException) */;
/** Virtual constructor */
virtual ConstantNumericalMathGradientImplementation * clone() const;
/** Comparison operator */
Bool operator ==(const ConstantNumericalMathGradientImplementation & other) const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** Gradient method */
virtual Matrix gradient(const NumericalPoint & inP) const
/* throw(InvalidArgumentException, InternalException) */;
/** Accessor for input point dimension */
virtual UnsignedLong getInputDimension() const
/* throw(InternalException) */;
/** Accessor for output point dimension */
virtual UnsignedLong getOutputDimension() const
/* throw(InternalException) */;
/** Accessor for the constant term */
Matrix getConstant() 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:
private:
Matrix constant_;
}; /* class ConstantNumericalMathGradientImplementation */
} /* namespace Func */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_CONSTANTNUMERICALMATHGRADIENTIMPLEMENTATION_HXX */
|