/usr/include/openturns/BoxCoxFactory.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 | // -*- C++ -*-
/**
* @brief This class is enables to estimate parameters of the BoxCox model
*
* 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_BOXCOXFACTORY_HXX
#define OPENTURNS_BOXCOXFACTORY_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/Point.hxx"
#include "openturns/Sample.hxx"
#include "openturns/Field.hxx"
#include "openturns/BoxCoxTransform.hxx"
#include "openturns/Graph.hxx"
#include "openturns/OptimizationAlgorithm.hxx"
#include "openturns/CovarianceModel.hxx"
#include "openturns/Basis.hxx"
#include "openturns/GeneralLinearModelResult.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class BoxCoxFactory
*/
class OT_API BoxCoxFactory
: public PersistentObject
{
CLASSNAME;
public:
typedef GeneralLinearModelResult::BasisCollection BasisCollection;
/** Default constructor without parameters */
BoxCoxFactory();
/** Virtual copy constructor */
BoxCoxFactory * clone() const;
/** String converter */
String __repr__() const;
/** String converter */
String __str__(const String & offset = "") const;
/** Build the factory from data by estimating the best \lambda which maximizes the log-likelihood function */
BoxCoxTransform build(const Field & timeSeries) const;
BoxCoxTransform build(const Field & timeSeries,
const Point & shift) const;
BoxCoxTransform build(const Field & timeSeries,
const Point & shift,
Graph & graph) const;
BoxCoxTransform build(const Sample & sample) const;
BoxCoxTransform build(const Sample & sample,
const Point & shift) const;
BoxCoxTransform build(const Sample & sample,
const Point & shift,
Graph & graph) const;
/** Build the factory from data by estimating the best generalized linear model */
BoxCoxTransform build(const Sample & inputSample,
const Sample & outputSample,
const CovarianceModel & covarianceModel,
const Basis & basis,
const Point & shift,
GeneralLinearModelResult & result);
BoxCoxTransform build(const Sample & inputSample,
const Sample & outputSample,
const CovarianceModel & covarianceModel,
const BasisCollection & basis,
const Point & shift,
GeneralLinearModelResult & result);
BoxCoxTransform build(const Sample & inputSample,
const Sample & outputSample,
const CovarianceModel & covarianceModel,
const Point & shift,
GeneralLinearModelResult & result);
/** Optimization solver accessor */
OptimizationAlgorithm getOptimizationAlgorithm() const;
void setOptimizationAlgorithm(const OptimizationAlgorithm & solver);
// @deprecated
OptimizationAlgorithm getOptimizationSolver() const;
void setOptimizationSolver(const OptimizationAlgorithm & solver);
protected:
/** Optimization solver */
OptimizationAlgorithm solver_;
void checkGLMData(const Sample & inputSample,
const Sample & outputSample,
const CovarianceModel & covarianceModel,
const BasisCollection & basis);
} ; /* class BoxCoxFactory */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_BOXCOXFACTORY_HXX */
|