/usr/include/openturns/WhittleFactoryState.hxx is in libopenturns-dev 1.5-7build2.
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 | // -*- C++ -*-
/**
* @file WhittleFactoryState.hxx
* @brief This class stores the current state of the fitting step in the WhittleFactory class.
*
* 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/>.
*
* @author lebrun
* @date 2012-04-05 17:05:15 +0200 (jeu. 05 avril 2012)
*/
#ifndef OPENTURNS_WHITTLEFACTORYSTATE_HXX
#define OPENTURNS_WHITTLEFACTORYSTATE_HXX
#include "PersistentObject.hxx"
#include "ARMA.hxx"
#include "ARMACoefficients.hxx"
#include "NumericalPoint.hxx"
#include "WhiteNoise.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class WhittleFactoryState
*
* The class implements the state of the WhittleFactory class that results form a particular fitting
*/
class OT_API WhittleFactoryState
: public PersistentObject
{
CLASSNAME;
public:
/** Default constructor */
WhittleFactoryState();
/** Default constructor */
WhittleFactoryState(const UnsignedInteger p,
const NumericalPoint & theta,
const NumericalScalar sigma2,
const NumericalPoint & informationCriteria,
const RegularGrid & timeGrid);
/** Virtual constructor */
virtual WhittleFactoryState * clone() const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/** P accessor */
UnsignedInteger getP() const;
/** Q accessor */
UnsignedInteger getQ() const;
/** Theta accessor */
NumericalPoint getTheta() const;
/** Sigma2 accessor */
NumericalScalar getSigma2() const;
/** AR coefficients accessor */
ARMACoefficients getARCoefficients() const;
/** MA coefficients accessor */
ARMACoefficients getMACoefficients() const;
/** White noise accessor */
WhiteNoise getWhiteNoise() const;
/** ARMA process accessor */
ARMA getARMA() const;
/** Information criteria accessor */
NumericalPoint getInformationCriteria() const;
/** Time grid accessor */
RegularGrid getTimeGrid() 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);
private :
/* The AR order of the ARMA process */
UnsignedInteger p_;
/* The flat vector of coefficients of the ARMA process */
NumericalPoint theta_;
/* The variance of the white noise */
NumericalScalar sigma2_;
/* The information criteria of the fitting */
NumericalPoint informationCriteria_;
/* The time grid associated with the estimation */
RegularGrid timeGrid_;
}; /* class WhittleFactoryState */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_WHITTLEFACTORYSTATE_HXX */
|