/usr/include/openturns/ARMAFactoryImplementation.hxx is in libopenturns-dev 1.9-5.
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++ -*-
/**
* @brief An interface for all implementation class of process
*
* Copyright 2005-2017 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_ARMAFACTORYIMPLEMENTATION_HXX
#define OPENTURNS_ARMAFACTORYIMPLEMENTATION_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/ARMA.hxx"
#include "openturns/TimeSeries.hxx"
#include "openturns/ProcessSample.hxx"
#include "openturns/Pointer.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class ARMAFactoryImplementation
*
* An interface for all implementation class of process
*/
class OT_API ARMAFactoryImplementation
: public PersistentObject
{
CLASSNAME;
public:
/** Some typedefs to ease reading */
typedef Pointer<ARMAFactoryImplementation> Antecedent;
typedef Antecedent Implementation;
/** Default constructor */
ARMAFactoryImplementation();
/** Parameter constructor */
ARMAFactoryImplementation(const UnsignedInteger p,
const UnsignedInteger q,
const Bool invertible = true);
/** Parameter constructor */
ARMAFactoryImplementation(const Indices & p,
const Indices & q,
const Bool invertible = true);
/** Virtual constructor */
virtual ARMAFactoryImplementation * clone() const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/** P accessor */
Indices getP() const;
UnsignedInteger getCurrentP() const;
/** Q accessor */
Indices getQ() const;
UnsignedInteger getCurrentQ() const;
/** Invertibility accessor */
Bool getInvertible() const;
void setInvertible(const Bool invertible);
/** Build method */
virtual ARMA build(const TimeSeries & timeSeries) const;
virtual ARMA build(const TimeSeries & timeSeries,
Point & informationCriteria) const;
/** Build method */
virtual ARMA build(const ProcessSample & sample) const;
virtual ARMA build(const ProcessSample & sample,
Point & informationCriteria) const;
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
protected:
/** P accessor */
void setP(const Indices & ARIndices);
void setCurrentP(const UnsignedInteger p) const;
/** Q accessor */
void setQ(const Indices & MAIndices);
void setCurrentQ(const UnsignedInteger q) const;
/** AR size */
Indices p_;
mutable UnsignedInteger currentP_;
/** MA size */
Indices q_;
mutable UnsignedInteger currentQ_;
/** Invertibility constraint */
Bool invertible_;
}; /* class ARMAFactoryImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_ARMAFACTORYIMPLEMENTATION_HXX */
|