TStochAttribut.h

Go to the documentation of this file.

// Copyright (C) 2013-2024 CEA/DES
//
// This program 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 any
// later version.
//
// This program 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 program. If not, see <http://www.gnu.org/licenses/>.
// $Id$
// $Author$
// $Date$
// $Revision$
// $State$

#ifndef TSTOCHASTICATTRIBUTE_H
#define TSTOCHASTICATTRIBUTE_H

#include "TString.h"
#include <iostream>

// Uranie
#include "DataServer.h"
#include "TAttribute.h"
#include "UExceptions.h"

namespace URANIE
{
namespace DataServer
{

#define THEO_DEF -999.0123456789

class TStochasticAttribute: public TAttribute
{
public:

    enum ELawType
    {
        kUniform,
        kLogUniform,
        kNormal,
        kStudent,
        kLogNormal,
        kTrapezium,
        kTriangular,
        kLogTriangular,
        kExponential,
        kBeta,
        kGamma,
        kInvGamma,
        kCauchy,
        kUniformByParts,
        kWeibull,
        kGumbel,
        kMultinomial,
        kGenPareto,
        kGeneralizedNormal,
        kGeneralizedNormalV2,
        kCompose,
        kUnknown
    };

    enum EStochasticBasis
    {
        kUnknownBasis, kHermite, kLegendre, kLaguerre, kJacobi
    };         

protected:

    ELawType _lawType;             
    Double_t _dtheoreticalMean;    
    Double_t _dtheoreticalStdDev;  
    Double_t _dtheoreticalMode;    
    Double_t _pmin;                
    Double_t _pmax;                
    EStochasticBasis _nStochasticBasis; 

public:
    // -----------------------------------------------------------------------
    //  Constructors
    // -----------------------------------------------------------------------
    TStochasticAttribute();


    TStochasticAttribute(TString str);


    TStochasticAttribute(TString str, ELawType value);


    TStochasticAttribute(TString str, ELawType value, Double_t min,
            Double_t max);


    TStochasticAttribute(TAttribute *object, ELawType value);

    virtual ~TStochasticAttribute();

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------


    virtual void computeTheoreticalInformation() = 0;


    virtual Double_t getPDF(Double_t x) = 0;
    double getPDFforTF1(double *x) { return getPDF(x[0]); }
    

    virtual Double_t getCDF(Double_t x) = 0;
    double getCDFforTF1(double *x) { return getCDF(x[0]); }
    

    virtual Double_t getInvCDF(Double_t p) = 0;
    double getInvCDFforTF1(double *x) { return getInvCDF(x[0]); }
    
    virtual Double_t getTheoreticalMean();

    virtual Double_t getTheoreticalStdDev();

    virtual Double_t getTheoreticalMode();


    //---------------------------------------------

    void setLawType(ELawType value)
    {
        _lawType = value;
    }


    void setLawType(TString name);

    //const int getLawType() const { return _lawType;}
    int getLawType()
    {
        return _lawType;
    }


    void setStochasticBasis(EStochasticBasis n)
    {
        _nStochasticBasis = n;
    }


    void setDefaultStochasticBasis();


    EStochasticBasis getStochasticBasis() const
    {
        return _nStochasticBasis;
    }

    //---------------------------------------------
    virtual Double_t getPMin()
    {
        return _pmin;
    }
    virtual Double_t getPMax()
    {
        return _pmax;
    }


    virtual void printLog();

    ClassDef(TStochasticAttribute, ID_DATASERVER)
    //Definition of a stochastic variable
};

class TInfiniteDistribution: public TStochasticAttribute
{

    // Attributes
protected:

public:
    // -----------------------------------------------------------------------
    //  Constructors
    // -----------------------------------------------------------------------
    TInfiniteDistribution();


    TInfiniteDistribution(TString str);


    TInfiniteDistribution(TString str, ELawType value);


    TInfiniteDistribution(TAttribute *object, ELawType value);

    virtual ~TInfiniteDistribution();

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------


    virtual void setLowerBound(Double_t val);


    virtual void setUpperBound(Double_t val);


    virtual void setBounds(Double_t lower, Double_t upper);

    virtual void printLog();ClassDef(TInfiniteDistribution, ID_DATASERVER)
    //Definition of an stochastic variable
};
} // Fin du namespace DataServer
} // Fin du namespace URANIE

#endif