/usr/include/openturns/CovarianceModel.hxx is in libopenturns-dev 1.7-3.
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 | // -*- C++ -*-
/**
* @brief This class enables to build a covariance model
*
* Copyright 2005-2015 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_COVARIANCEMODEL_HXX
#define OPENTURNS_COVARIANCEMODEL_HXX
#include "TypedInterfaceObject.hxx"
#include "CovarianceModelImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class CovarianceModel
*/
class OT_API CovarianceModel
: public TypedInterfaceObject<CovarianceModelImplementation>
{
CLASSNAME;
public:
typedef CovarianceModelImplementation::Implementation Implementation;
/** Default constructor without parameter */
CovarianceModel();
/** Copy constructors */
CovarianceModel(const CovarianceModelImplementation & implementation);
/** Constructor from implementation */
CovarianceModel(const Implementation & p_implementation);
#ifndef SWIG
/** Constructor from implementation pointer */
CovarianceModel(CovarianceModelImplementation * p_implementation);
#endif
/** Dimension accessor */
virtual UnsignedInteger getSpatialDimension() const;
virtual UnsignedInteger getDimension() const;
/** Compute the covariance function */
virtual CovarianceMatrix operator() (const NumericalScalar s,
const NumericalScalar t) const;
virtual CovarianceMatrix operator() (const NumericalPoint & s,
const NumericalPoint & t) const;
// compute standard representative computes the term \rho(s, t)
virtual NumericalScalar computeStandardRepresentative(const NumericalPoint & s,
const NumericalPoint & t) const;
virtual NumericalScalar computeStandardRepresentative(const NumericalScalar & s,
const NumericalScalar & t) const;
virtual NumericalScalar computeStandardRepresentative(const NumericalPoint & tau) const;
virtual NumericalScalar computeStandardRepresentative(const NumericalScalar & tau) const;
virtual NumericalScalar computeAsScalar (const NumericalPoint & s,
const NumericalPoint & t) const;
virtual CovarianceMatrix operator() (const NumericalScalar tau) const;
virtual CovarianceMatrix operator() (const NumericalPoint & tau) const;
virtual NumericalScalar computeAsScalar (const NumericalPoint & tau) const;
/** Gradient */
virtual Matrix partialGradient(const NumericalPoint & s,
const NumericalPoint & t) const;
/** Discretize the covariance function on a given TimeGrid/Mesh */
virtual CovarianceMatrix discretize(const RegularGrid & timeGrid) const;
virtual CovarianceMatrix discretize(const Mesh & mesh) const;
virtual CovarianceMatrix discretize(const NumericalSample & vertices) const;
virtual NumericalSample discretizeRow(const NumericalSample & vertices,
const UnsignedInteger p) const;
/** Discretize and factorize the covariance function on a given TimeGrid/Mesh */
virtual TriangularMatrix discretizeAndFactorize(const RegularGrid & timeGrid) const;
virtual TriangularMatrix discretizeAndFactorize(const Mesh & mesh) const;
virtual TriangularMatrix discretizeAndFactorize(const NumericalSample & vertices) const;
/** Discretize the covariance function on a given TimeGrid/Mesh using HMatrix */
virtual HMatrix discretizeHMatrix(const RegularGrid & timeGrid,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
virtual HMatrix discretizeHMatrix(const Mesh & mesh,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
virtual HMatrix discretizeHMatrix(const NumericalSample & vertices,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
/** Discretize and factorize the covariance function on a given TimeGrid/Mesh using HMatrix */
virtual HMatrix discretizeAndFactorizeHMatrix(const RegularGrid & timeGrid,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
virtual HMatrix discretizeAndFactorizeHMatrix(const Mesh & mesh,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
virtual HMatrix discretizeAndFactorizeHMatrix(const NumericalSample & vertices,
const NumericalScalar nuggetFactor,
const HMatrixParameters & parameters) const;
/** Amplitude accessors */
NumericalPoint getAmplitude() const;
void setAmplitude(const NumericalPoint & amplitude);
/** Scale accessors */
NumericalPoint getScale() const;
void setScale(const NumericalPoint & scale);
/** Spatial correlation accessors */
CorrelationMatrix getSpatialCorrelation() const;
void setSpatialCorrelation(const CorrelationMatrix & correlation);
/** Nugget factor accessor */
void setNuggetFactor(const NumericalScalar nuggetFactor);
NumericalScalar getNuggetFactor() const;
/** Parameters accessor */
void setParameter(const NumericalPoint & parameter);
NumericalPoint getParameter() const;
Description getParameterDescription() const;
/** Is it a stationary model ? */
virtual Bool isStationary() const;
/** Is it a diagonal model ? */
virtual Bool isDiagonal() const;
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
/** Marginal accessor */
CovarianceModel getMarginal(const UnsignedInteger index) const;
} ; /* class CovarianceModel */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_COVARIANCEMODEL_HXX */
|