/usr/include/openturns/FunctionalChaosRandomVector.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 | // -*- C++ -*-
/**
* @brief An implementation class for functionalChaos random vectors
*
* 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_FUNCTIONALCHAOSRANDOMVECTOR_HXX
#define OPENTURNS_FUNCTIONALCHAOSRANDOMVECTOR_HXX
#include "openturns/CompositeRandomVector.hxx"
#include "openturns/FunctionalChaosResult.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class FunctionalChaosRandomVector
*
* An implementation class for functionalChaos random vectors
*/
class OT_API FunctionalChaosRandomVector
: public CompositeRandomVector
{
CLASSNAME;
public:
/** Some typedefs to ease reading */
/** Default constructor */
FunctionalChaosRandomVector(const FunctionalChaosResult & functionalChaosResult);
/** Virtual constructor */
virtual FunctionalChaosRandomVector * clone() const;
/** String converter */
String __repr__() const;
/* Here is the interface that all derived class must implement */
/** Mean accessor */
Point getMean() const;
/** Covariance accessor */
CovarianceMatrix getCovariance() const;
/** Sobol index accessor */
Scalar getSobolIndex(const Indices & variableIndices,
const UnsignedInteger marginalIndex = 0) const;
Scalar getSobolIndex(const UnsignedInteger variableIndex,
const UnsignedInteger marginalIndex = 0) const;
/** Sobol total index accessor */
Scalar getSobolTotalIndex(const Indices & variableIndices,
const UnsignedInteger marginalIndex = 0) const;
Scalar getSobolTotalIndex(const UnsignedInteger variableIndex,
const UnsignedInteger marginalIndex = 0) const;
/** Sobol grouped index accessor */
Scalar getSobolGroupedIndex(const Indices & variableIndices,
const UnsignedInteger marginalIndex = 0) const;
Scalar getSobolGroupedIndex(const UnsignedInteger variableIndex,
const UnsignedInteger marginalIndex = 0) const;
/** Functional chaos result accessor */
FunctionalChaosResult getFunctionalChaosResult() 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);
protected:
friend class Factory<FunctionalChaosRandomVector>;
/** Default constructor */
FunctionalChaosRandomVector() : CompositeRandomVector() {};
private:
/** Compute the covariance */
void computeCovariance() const;
/** Scalar value of the covariance */
mutable CovarianceMatrix covariance_;
/** Flag to tell if the covariance has already been computed */
mutable Bool isAlreadyComputedCovariance_;
/** The functional chaos result tht allows to build the random vector */
FunctionalChaosResult functionalChaosResult_;
}; /* class FunctionalChaosRandomVector */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_FUNCTIONALCHAOSRANDOMVECTOR_HXX */
|