/usr/include/openturns/DistributionImplementationFactory.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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | // -*- C++ -*-
/**
* @file DistributionImplementationFactory.hxx
* @brief Top-level class for all distribution factories
*
* (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-07-28 18:31:43 +0200 (Thu, 28 Jul 2011) $
* Id: $Id: DistributionImplementationFactory.hxx 2046 2011-07-28 16:31:43Z schueller $
*/
#ifndef OPENTURNS_DISTRIBUTIONIMPLEMENTATIONFACTORY_HXX
#define OPENTURNS_DISTRIBUTIONIMPLEMENTATIONFACTORY_HXX
#include "DistributionImplementation.hxx"
#include "NumericalPoint.hxx"
#include "NumericalSample.hxx"
#include "CovarianceMatrix.hxx"
#include "Exception.hxx"
#include "PersistentObject.hxx"
namespace OpenTURNS {
namespace Uncertainty {
namespace Model {
/**
* @class DistributionImplementationFactory
*/
class DistributionImplementationFactory
: public Base::Common::PersistentObject
{
CLASSNAME;
public:
static const UnsignedLong DefaultBootstrapSize; /* = 100 */
typedef Base::Type::NumericalPoint NumericalPoint;
typedef Base::Stat::NumericalSample NumericalSample;
typedef Base::Stat::CovarianceMatrix CovarianceMatrix;
typedef Base::Common::InternalException InternalException;
typedef Base::Common::InvalidArgumentException InvalidArgumentException;
typedef Model::DistributionImplementation::NumericalPointCollection NumericalPointCollection;
typedef Model::DistributionImplementation::NumericalPointWithDescriptionCollection NumericalPointWithDescriptionCollection;
/** Default constructor */
DistributionImplementationFactory(const UnsignedLong bootstrapSize = DefaultBootstrapSize,
const String & name = OT::DefaultName);
/** Virtual constructor */
virtual DistributionImplementationFactory * clone() const;
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** Build a distribution based on a sample
* @deprecated
* This method is deprecated. Use build() instead. */
virtual DistributionImplementation * buildImplementation(const NumericalSample & sample) const DEPRECATED /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution based on a sample */
virtual DistributionImplementation * build(const NumericalSample & sample) const /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution based on a sample and gives the covariance matrix of the estimate
* @deprecated
* This method is deprecated. Use build() instead. */
virtual DistributionImplementation * buildImplementation(const NumericalSample & sample,
CovarianceMatrix & covariance) const DEPRECATED;
/** Build a distribution based on a sample and gives the covariance matrix of the estimate */
virtual DistributionImplementation * build(const NumericalSample & sample,
CovarianceMatrix & covariance) const /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution based on a set of parameters
* @deprecated
* This method is deprecated. Use build() instead. */
virtual DistributionImplementation * buildImplementation(const NumericalPointCollection & parameters) const DEPRECATED /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution based on a set of parameters */
virtual DistributionImplementation * build(const NumericalPointCollection & parameters) const /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution based on a set of parameters */
virtual DistributionImplementation * build(const NumericalPointWithDescriptionCollection & parameters) const /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution using its default constructor
* @deprecated
* This method is deprecated. Use build() instead. */
virtual DistributionImplementation * buildImplementation() const DEPRECATED /* throw(InvalidArgumentException, InternalException) */;
/** Build a distribution using its default constructor */
virtual DistributionImplementation * build() const /* throw(InvalidArgumentException, InternalException) */;
/** Bootstrap size accessor */
UnsignedLong getBootstrapSize() const;
void setBootstrapSize(const UnsignedLong bootstrapSize);
protected:
/* Execute a R script */
virtual NumericalPoint runRFactory(const NumericalSample & sample,
const DistributionImplementation & distribution) const
/* throw(InvalidArgumentException, InternalException) */;
/* Number of bootstrap resampling for ovariance estimation */
UnsignedLong bootstrapSize_;
private:
/* Convert a parameters collection into a NumericalPoint */
static NumericalPoint ParametersAsNumericalPoint(const NumericalPointWithDescriptionCollection & parametersCollection);
}; /* class DistributionImplementationFactory */
} /* namespace Model */
} /* namespace Uncertainty */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_DISTRIBUTIONIMPLEMENTATIONFACTORY_HXX */
|