/usr/include/openturns/RandomVector.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 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 168 | // -*- C++ -*-
/**
* @file RandomVector.hxx
* @brief The class that implements all random vectors
*
* (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-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: RandomVector.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_RANDOMVECTOR_HXX
#define OPENTURNS_RANDOMVECTOR_HXX
#include "TypedInterfaceObject.hxx"
#include "Pointer.hxx"
#include "RandomVectorImplementation.hxx"
namespace OpenTURNS {
namespace Uncertainty {
namespace Model {
/**
* @class RandomVector
*
* The class that implements all random vectors
*/
class RandomVector
: public Base::Common::TypedInterfaceObject<RandomVectorImplementation>
{
CLASSNAME;
public:
/* Some typedefs for easy reading */
typedef RandomVectorImplementation::Implementation Implementation;
typedef RandomVectorImplementation::Indices Indices;
typedef RandomVectorImplementation::Antecedent Antecedent;
typedef RandomVectorImplementation::NumericalMathFunction NumericalMathFunction;
typedef RandomVectorImplementation::NumericalPoint NumericalPoint;
typedef RandomVectorImplementation::NumericalSample NumericalSample;
typedef RandomVectorImplementation::CovarianceMatrix CovarianceMatrix;
typedef RandomVectorImplementation::ComparisonOperator ComparisonOperator;
typedef RandomVectorImplementation::FunctionalChaosResult FunctionalChaosResult;
typedef RandomVectorImplementation::InvalidArgumentException InvalidArgumentException;
typedef RandomVectorImplementation::Description Description;
/** Default constructor */
explicit RandomVector();
/** Default constructor */
RandomVector(const RandomVectorImplementation & implementation,
const String & name = OT::DefaultName);
/** Constructor from implementation */
RandomVector(const Implementation & p_implementation,
const String & name = OT::DefaultName);
#ifndef SWIG
/** Constructor from implementation pointer */
RandomVector(RandomVectorImplementation * p_implementation,
const String & name = OT::DefaultName);
#endif
/** Constructor for constant vector */
explicit RandomVector(const NumericalPoint & point,
const String & name = OT::DefaultName);
/** Constructor for distribution-based vector */
explicit RandomVector(const Distribution & distribution,
const String & name = OT::DefaultName);
/** Constructor for distribution-based conditional vector */
explicit RandomVector(const Distribution & distribution,
const RandomVector & randomParameters,
const String & name = OT::DefaultName);
/** Constructor for composite vector */
RandomVector(const NumericalMathFunction & function,
const RandomVector & antecedent,
const String & name = OT::DefaultName);
/** Constructor for functional chaos vector */
RandomVector(const FunctionalChaosResult & functionalChaosResult);
/** String converter */
String __repr__() const;
/** String converter */
String __str__(const String & offset = "") const;
/** Description Accessor */
void setDescription(const Description & description);
Description getDescription() const;
/** Is the underlying random vector composite ? */
Bool isComposite() const;
/** Dimension accessor */
UnsignedLong getDimension() const;
/** Realization accessor */
NumericalPoint getRealization() const;
/** Numerical sample accessor */
NumericalSample getNumericalSample(const UnsignedLong size) const;
/** Get the random vector corresponding to the i-th marginal component */
RandomVector getMarginal(const UnsignedLong i) const /* throw(InvalidArgumentException) */;
/** Get the marginal random vector corresponding to indices components */
RandomVector getMarginal(const Indices & indices) const /* throw(InvalidArgumentException) */;
/** Mean accessor */
NumericalPoint getMean() const;
/** Covariance accessor */
CovarianceMatrix getCovariance() const;
/** This method allows to access the antecedent RandomVector in case of a composite RandomVector */
Antecedent getAntecedent() const;
/** This method allows to access the NumericalMathFunction in case of a composite RandomVector */
NumericalMathFunction getFunction() const;
/** This method allows to access the Distribution in case of a usual RandomVector */
Distribution getDistribution() const;
/** Operator accessor */
ComparisonOperator getOperator() const;
/** Threshold accessor */
NumericalScalar getThreshold() const;
protected:
/** Constructor for event vector */
explicit RandomVector(const RandomVector & antecedent,
const ComparisonOperator & op,
const NumericalScalar threshold,
const String & name = OT::DefaultName) /* throw(InvalidArgumentException) */;
}; /* class RandomVector */
} /* namespace Model */
} /* namespace Uncertainty */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_RANDOMVECTOR_HXX */
|