Changeset 982

Show
Ignore:
Timestamp:
10/22/08 09:37:02 (3 months ago)
Author:
dutfoy
Message:

Changed the description of the NonCentralStudent distribution in the UseCases guide and the UserManual. This fixed the ticket #152.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/dutfoy/devel/doc/src/UseCasesGuide/OpenTURNS_UseCasesGuide.tex

    r977 r982  
    415415We explicitate here the probability density function of the Non Central Student :  
    416416$$ 
    417 p_T(x) = \frac{\exp(-\delta^2 / 2)}{\sqrt{\nu\pi} \Gamma(\nu / 2)}\left(\frac{\nu}{\nu + (x+\gamma)^2}\right) ^ {(\nu + 1) / 2} \sum_{j=0}^{\infty} \frac{\Gamma\left(\frac{\nu + j + 1}{2}\right)}{\Gamma(j + 1)}\left((x+\gamma)\delta\sqrt{\frac{2}{\nu + x^2}}\right) ^ j 
     417p_T(x) = \frac{\exp(-\delta^2 / 2)}{\sqrt{\nu\pi} \Gamma(\nu / 2)}\left(\frac{\nu}{\nu + (x-\gamma)^2}\right) ^ {(\nu + 1) / 2} \sum_{j=0}^{\infty} \frac{\Gamma\left(\frac{\nu + j + 1}{2}\right)}{\Gamma(j + 1)}\left(\delta(x-\gamma)\sqrt{\frac{2}{\nu + (x-\gamma)^2}}\right) ^ j 
    418418$$ 
    419419 

  • branches/dutfoy/devel/doc/src/UserManual/Distribution_UserManual.tex

    r977 r982  
    1 %Copyright (c)  2007  EDF-EADS-PHIMECA. 
    2 % Permission is granted to copy, distribute and/or modify this document 
    3 % under the terms of the GNU Free Documentation License, Version 1.2 
    4 % or any later version published by the Free Software Foundation; 
    5 % with no Invariant Sections, no Front-Cover Texts, and no Back-Cover 
    6 % Texts.  A copy of the license is included in the section entitled "GNU 
    7 % Free Documentation License". 
     1% Copyright (c)  2007  EDF-EADS-PHIMECA. 
     2% Permission is granted to copy, distribute and/or modify this document 
     3% under the terms of the GNU Free Documentation License, Version 1.2 
     4% or any later version published by the Free Software Foundation; 
     5% with no Invariant Sections, no Front-Cover Texts, and no Back-Cover 
     6% Texts.  A copy of the license is included in the section entitled "GNU 
     7% Free Documentation License". 
    88 
    99\newpage\section{Distributions} 
    …… 
    1212Be aware of the fact that for some uses in the TUI, it is necessary to explicitely cast a given distribution into the general Distribution class. 
    1313 
    14  \subsection{Distribution} 
    15  
    16 \begin{description} 
    17  
    18        \item[Usage :] $Distribution(dist, name)$ 
    19          
    20        \item[Arguments :]  \strut 
    21        \begin{description} 
    22                \item $dist$ : a DistributionImplementation which is Beta, Exponential, Gamma, Geometric, Gumbel, Histogram, Logistic, LogNormal, 
    23                MultiNomial,  Normal, Non Central Student, Poisson, Student, Triangular, TruncatedNormal, Weibull, UserDefined,   
    24                \item $name$ : a string to name the distribution  
    25        \end{description} 
    26          
    27        \item[Value :] a Distribution 
    28  
    29        \item[Some methods :]  \strut 
    30          
    31        \begin{description} 
    32          
    33                \item $computeCDF$ 
    34                                        \begin{description} 
    35                                                \item[Usage :]  \strut 
    36        \begin{description} 
    37                \item $computeCDF(value)$ 
    38                \item $computeCDF(x)$ 
    39                \item $computeCDF(sample)$  
    40        \end{description} 
    41                                                \item[Arguments :] \strut 
    42        \begin{description} 
    43                \item $x$ : a NumericalScalar 
    44                \item $x$ : a NumericalPoint 
    45                \item $sample$ : a NumericalSample 
    46        \end{description} 
    47                                                \item[Value :] \strut 
    48        \begin{description} 
    49                \item while using the first usage, a NumericalScalar, the CDF (Cumulative Distribution Function) of dimension 1 value of the considered distribution at $value$ 
    50                \item while using the second usage, a NumericalPoint, the CDF (Cumulative Distribution Function) value of the considered distribution at the vector $x$ 
    51                \item while using the third usage, a NumericalSample, the CDF (Cumulative Distribution Function) values of the considered distribution at $sample$ 
    52        \end{description} 
    53                                        \end{description} 
    54                \bigskip 
    55                  
    56                \item $computeCDFGradient$ 
    57                                        \begin{description} 
    58                                                \item[Usage :] $computeCDFGradient(x)$  
    59                                                \item[Arguments :] $x$ : a NumericalPoint  
    60                                                \item[Value :] a NumericalPoint object, the gradient of the distribution CDF, with respect to the parameters of the distribution, evaluated at point $x$ 
    61                                        \end{description} 
    62                \bigskip 
    63  
    64                \item $computeDDF$ 
    65                                        \begin{description} 
    66                                                \item[Usage :]  \strut 
    67        \begin{description} 
    68                \item $computeDDF(x)$ 
    69                \item $computeDDF(sample)$  
    70        \end{description} 
    71                                                \item[Arguments :] \strut 
    72        \begin{description} 
    73                \item $x$ : a NumericalPoint 
    74                \item $sample$ : a NumericalSample 
    75        \end{description} 
    76                                                \item[Value :] \strut 
    77        \begin{description} 
    78                \item while using the first usage,  a NumericalPoint value, the gradient of the PDF (Probability Distribution Function) of the considered distribution at $x$ (DDF = Derivative Density Function) 
    79                \item while using the second usage,  a NumericalSample, the gradient of the PDF (Probability Distribution Function) of the considered distribution at $x$ (DDF = Derivative Density Function) 
    80        \end{description} 
    81                                        \end{description} 
    82                \bigskip 
    83          
    84                \item $computePDF$ 
    85                                        \begin{description} 
    86                                                \item[Usage :]  \strut 
    87        \begin{description} 
    88                \item $computePDF(value)$ 
    89                \item $computePDF(x)$ 
    90                \item $computePDF(sample)$  
    91        \end{description} 
    92                                                \item[Arguments :] \strut 
    93        \begin{description} 
    94                \item $x$ : a NumericalPoint 
    95                \item $sample$ : a NumericalSample 
    96        \end{description} 
    97                                                \item[Value :] \strut 
    98        \begin{description} 
    99                \item while using the first usage, a NumericalScalar, the PDF (Cumulative Distribution Function) of dimension 1 value of the considered distribution at $value$ 
    100                \item while using the second usage, a NumericalPoint, the PDF (Cumulative Distribution Function) value of the considered distribution at the vector $x$ 
    101                \item while using the third usage, a NumericalSample, the PDF (Cumulative Distribution Function) values of the considered distribution at $sample$ 
    102        \end{description} 
    103                                        \end{description} 
    104                \bigskip 
    105  
    106                \item $computePDFGradient$ 
    107                                        \begin{description} 
    108                                                \item[Usage :] $computePDFGradient(x)$  
    109                                                \item[Arguments :] $x$ : a NumericalPoint  
    110                                                \item[Value :] a NumericalPoint object, the gradient of the distribution PDF, with respect to the parameters of the distribution, evaluated at point $x$ 
    111                                        \end{description} 
    112                \bigskip 
    113                  
    114                \item $computeQuantile$ 
    115                                        \begin{description} 
    116                                                \item[Usage :] $computeQuantile(x)$ 
    117                                                \item[Arguments :] $x$ : a real scalar $0\leq x \leq 1$ 
    118                                                \item[Value :] a NumericalPoint, the value of the $x-$ quantile 
    119                                        \end{description} 
    120                \bigskip 
    121                                  
    122                \item $drawCDF$ 
    123                                \begin{description} 
    124                                                \item[Usage :] \strut 
    125                                        \begin{description}  
    126                                                        \item $drawCDF()$ 
    127                                                        \item $drawCDF(min,max)$ 
    128                                                        \item $drawCDF(min,max,pointNumber)$  
    129                                                        \item $drawCDF(vectMin,vectMax)$ 
    130                                                        \item $drawCDF(vectMin,vectMax,vectPointNumber)$ 
    131                                        \end{description} 
    132  
    133                                                \item[Arguments :] \strut 
    134        \begin{description} 
    135                \item $min$ and $max$ : real values with $min < max$, the range for the CDF curve of a distribution of dimension 1 
    136                \item $pointNumber$ : an integer, the number of points to draw the CDF iso-curves of a distribution of dimension 1 
    137                \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension 2, respectively the left-bottom and ritgh-up corners of the square for the CDF iso-curves of a distribution of dimension 2 
    138                \item $vectPointNumber$ : a NumericalPoint of dimension 2, the the number of points to draw the iso-curves of a distribution of dimension 2 on each direction 
    139        \end{description} 
    140                                                \item[Value :] a Graph, containing the elements of the curve or iso-curves of the CDF, depending on the dimension of the distribution (1 or 2) 
    141                                \end{description} 
    142  
    143                \bigskip 
    144                  
    145                \item $drawPDF$ 
    146                                \begin{description} 
    147                                                \item[Usage :] \strut 
    148                                        \begin{description}  
    149                                                        \item $drawPDF()$ 
    150                                                        \item $drawPDF(min,max)$ 
    151                                                        \item $drawPDF(min,max,pointNumber)$  
    152                                                        \item $drawPDF(vectMin,vectMax)$ 
    153                                                        \item $drawPDF(vectMin,vectMax,vectPointNumber)$ 
    154                                        \end{description} 
    155  
    156                                                \item[Arguments :] \strut 
    157        \begin{description} 
    158                \item $min$ and $max$ : real values with $min < max$, the range for the PDF curve of a distribution of dimension 1 
    159                \item $pointNumber$ : an integer, the number of points to draw the PDF iso-curves of a distribution of dimension 1 
    160                \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension 2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension 2 
    161                \item $vectPointNumber$ : a NumericalPoint of dimension 2, the number of points to draw the iso-curves of a distribution of dimension 2 on each direction 
    162        \end{description} 
    163                                                \item[Value :] a Graph, containing the elements of the curve or iso-curves of the PDF, depending on the dimension of the distribution (1 or 2) 
    164                                \end{description} 
    165  
    166  
    167                \bigskip 
    168                                  
    169                \item $drawMarginal1DCDF$ 
    170                                \begin{description} 
    171                                                \item[Usage :] \strut 
    172                                        \begin{description}  
    173                                                \item $drawMarginal1DCDF(i, min,max,pointNumber)$  
    174                                        \end{description} 
    175  
    176                                                \item[Arguments :] \strut 
    177        \begin{description} 
    178                \item $i$ : an integer, the marginal we want to draw (Care : numerotation begins at 0) 
    179                \item $min$ and $max$ : real values with $min < max$, the range for the CDF curve of a distribution of dimension >1 
    180                \item $pointNumber$ : an integer, the number of points to draw the CDF iso-curves of a distribution of dimension >1 
    181        \end{description} 
    182                                                \item[Value :] a Graph, containing the elements of the curve of the CDF of the marginal i of the distribution of dimension >1 
    183                                \end{description} 
    184  
    185                \bigskip 
    186                                  
    187                \item $drawMarginal1DPDF$ 
    188                                \begin{description} 
    189                                                \item[Usage :] \strut 
    190                                        \begin{description}  
    191                                                \item $drawMarginal1DPDF(i, min, max, pointNumber)$  
    192                                        \end{description} 
    193  
    194                                                \item[Arguments :] \strut 
    195        \begin{description} 
    196                \item $i$ : an integer, the marginal we want to draw (Care : numerotation begins at 0) 
    197                \item $min$ and $max$ : real values with $min < max$, the range for the PDF curve of a distribution of dimension >1 
    198                \item $pointNumber$ : an integer, the number of points to draw the PDF iso-curves of a distribution of dimension >1 
    199        \end{description} 
    200                                                \item[Value :] a Graph, containing the elements of the curve of the PDF of the marginal i of the distribution of dimension >1 
    201                                \end{description} 
    202  
    203                \bigskip 
    204                                  
    205                \item $drawMarginal2DCDF$ 
    206                                \begin{description} 
    207                                                \item[Usage :] \strut 
    208                                        \begin{description} 
    209                                                \item $drawMarginal2DCDF(i, j, vectMin,vectMax,vectPointNumber)$  
    210                                        \end{description} 
    211  
    212                                                \item[Arguments :] \strut 
    213        \begin{description} 
    214                \item $i$ and $j$ : two integer, the marginal we want to draw (Care : numerotation begins at 0) 
    215                \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension n>2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension n 
    216                \item $vectPointNumber$ : a NumericalPoint of dimension n>2, the number of points to draw the iso-curves of a distribution of dimension n on each direction 
    217        \end{description} 
    218                                                \item[Value :] a Graph, containing the elements of the iso-curve of the CDF of the marginals (i,j) of distribution of dimension n>2 
    219                                \end{description} 
    220  
    221                \bigskip 
    222                                  
    223                \item $drawMarginal2DPDF$ 
    224                                \begin{description} 
    225                                                \item[Usage :] \strut 
    226                                        \begin{description}  
    227                                                \item $drawMarginal2DPDF(i, j, vectMin,vectMax,vectPointNumber)$  
    228                                        \end{description} 
    229  
    230                                                \item[Arguments :] \strut 
    231        \begin{description} 
    232                \item $i$ and $j$ : two integer, the marginal we want to draw (Care : numerotation begins at 0) 
    233                \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension n>2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension n 
    234                \item $vectPointNumber$ : a NumericalPoint of dimension n>2, the number of points to draw the iso-curves of a distribution of dimension n on each direction 
    235        \end{description} 
    236                                                \item[Value :] a Graph, containing the elements of the iso-curve of the PDF of the marginals (i,j) of distribution of dimension n>2 
    237                                \end{description} 
    238  
    239                \bigskip 
    240                  
    241                \item $getCopula$ 
    242                                        \begin{description} 
    243                                                \item[Usage :] $getCopula()$ 
    244                                                \item[Arguments :] no argument 
    245                                                \item[Value :] a Copula, the copula of the considered distribution which must be of type ComposedDistribution 
    246                                        \end{description} 
    247                \bigskip 
    248                  
    249                \item $getCovariance$ 
    250                                        \begin{description} 
    251                                                \item[Usage :] $getCovariance()$ 
    252                                                \item[Arguments :] no argument 
    253                                                \item[Value :] a CovarianceMatrix of the considered distribution (if the distribution is unidimensional, it is the variance) 
    254                                        \end{description} 
    255                \bigskip 
    256                  
    257                \item $getMarginal$ 
    258                                        \begin{description} 
    259                                                \item[Usage :] \strut 
    260        \begin{description} 
    261                \item $getMarginal(i)$ 
    262                \item $getMarginal(indices)$ 
    263        \end{description} 
    264  
    265  
    266                                                \item[Arguments :]  \strut 
    267        \begin{description} 
    268                \item $i$ : an integer (i is lower or equal to the dimension of the considered distribution), with $0 \leq i$ 
    269                \item $indices$ : a Indices, which regroup all the indices considered 
    270        \end{description} 
    271  
    272                                                \item[Value :] a Distribution, the distribution of an extracted vector of the initial distribution 
    273                                        \end{description} 
    274                \bigskip 
    275  
    276                \item $getKurtosis$ 
    277                                        \begin{description} 
    278                                                \item[Usage :] $getKurtosis()$ 
    279                                                \item[Arguments :] no argument 
    280                                                \item[Value :] a NumericalPoint, the value the kurtosis of each 1D marginal of the distribution 
    281                                        \end{description} 
    282                \bigskip 
    283                  
    284                \item $getMean$ 
    285                                        \begin{description} 
    286                                                \item[Usage :] $getMean()$ 
    287                                                \item[Arguments :] no argument 
    288                                                \item[Value :] a NumericalPoint, the value of the considered distribution mean 
    289                                        \end{description} 
    290                \bigskip 
    291                  
    292                \item $getNumericalSample$ 
    293                                        \begin{description} 
    294                                                \item[Usage :] $getNumericalSample(n)$ 
    295                                                \item[Arguments :] $n$ : integer, the size of the sample 
    296                                                \item[Value :] a NumericalSample representing $n$ realizations of the random variable with the considered distribution  
    297                                        \end{description} 
    298                \bigskip 
    299                  
    300                \item $getParametersCollection$ 
    301                                        \begin{description} 
    302                                                \item[Usage :] $getParametersCollection()$ 
    303                                                \item[Arguments :] one 
    304                                                \item[Value :] a NumericalPointCollection, the list of the parameters of the distribution 
    305  
    306                                        \end{description} 
    307                \bigskip 
    308          
    309  
    310                \item $getRealization$ 
    311                                        \begin{description} 
    312                                                \item[Usage :] $getRealization()$ 
    313                                                \item[Arguments :] no argument 
    314                                                \item[Value :] a NumericalPoint, one realization of random variable with the considered distribution 
    315                                        \end{description} 
    316                \bigskip  
    317                  
    318                \item $getRoughness$ 
    319                                        \begin{description} 
    320                                                \item[Usage :] $getRoughness()$ 
    321                                                \item[Arguments :] no argument 
    322                                                \item[Value :] a NumericalScalar, the value $roughness(\vect{X}) = ||p||_{\mathcal{L}^2} = \sqrt{\int_\vect{x} p^2(\vect{x})d\vect{x}}$ 
    323                                        \end{description} 
    324                \bigskip 
    325  
    326                \item $getSkewness$ 
    327                                        \begin{description} 
    328                                                \item[Usage :] $getSkewness()$ 
    329                                                \item[Arguments :] no argument 
    330                                                \item[Value :] a NumericalPoint, the value the standard deviation of each 1D marginal of the distribution 
    331                                        \end{description} 
    332                \bigskip 
    333  
    334                \item $getStandardDeviation$ 
    335                                        \begin{description} 
    336                                                \item[Usage :] $getStandardDeviation()$ 
    337                                                \item[Arguments :] no argument 
    338                                                \item[Value :] a NumericalPoint, the value the standard deviation of each 1D marginal of the distribution 
    339                                        \end{description} 
    340                \bigskip 
    341                  
    342                \item $getWeight$ 
    343                                        \begin{description} 
    344                                                \item[Usage :] $getWeight()$ 
    345                                                \item[Arguments :] no argument 
    346                                                \item[Value :] a NumericalScalar between 0 and 1, the weight of the considered distribution if used in a Mixture 
    347                                        \end{description} 
    348                \bigskip 
    349                                  
    350                        \item $hasEllipticalCopula$ 
    351                                        \begin{description} 
    352                                                \item[Usage :] $hasEllipticalCopula()$ 
    353                                                \item[Arguments :] no argument 
    354                                                \item[Value :] a boolean, it says if the considered distribution is elliptical  
    355                                        \end{description} 
    356                        \bigskip 
    357                          
    358                        \item $hasIndependentCopula$ 
    359                                        \begin{description} 
    360                                                \item[Usage :] $hasIndependentCopula()$ 
    361                                                \item[Arguments :] no argument 
    362                                                \item[Value :] a boolean which indicates wether the considered distribution is independent  
    363                                        \end{description} 
    364                        \bigskip 
    365                        \item $isElliptical$ 
    366                                        \begin{description} 
    367                                                \item[Usage :] $isElliptical()$  
    368                                                \item[Arguments :] no argument 
    369                                                \item[Value :] a boolean which indicates wether the considered distribution has an elliptical distribution  
    370                                        \end{description} 
    371                        \bigskip 
    372                  
    373        \item $str$ 
    374                                        \begin{description} 
    375                                                \item[Usage :] $str()$ 
    376                                                \item[Arguments :] no argument 
    377                                                \item[Value :] a string describing the object 
    378                                        \end{description} 
    379                \bigskip 
    380                  
    381        \end{description} 
    382  
     14\subsection{Distribution} 
     15 
     16\begin{description} 
     17   
     18\item[Usage :] $Distribution(dist, name)$ 
     19   
     20\item[Arguments :]  \strut 
     21  \begin{description} 
     22  \item $dist$ : a DistributionImplementation which is Beta, Exponential, Gamma, Geometric, Gumbel, Histogram, Logistic, LogNormal, 
     23    MultiNomial,  Normal, Non Central Student, Poisson, Student, Triangular, TruncatedNormal, Weibull, UserDefined,   
     24  \item $name$ : a string to name the distribution  
     25  \end{description} 
     26   
     27\item[Value :] a Distribution 
     28   
     29\item[Some methods :]  \strut 
     30   
     31  \begin{description} 
     32     
     33  \item $computeCDF$ 
     34    \begin{description} 
     35    \item[Usage :]  \strut 
     36      \begin{description} 
     37      \item $computeCDF(value)$ 
     38      \item $computeCDF(x)$ 
     39      \item $computeCDF(sample)$  
     40      \end{description} 
     41    \item[Arguments :] \strut 
     42      \begin{description} 
     43      \item $x$ : a NumericalScalar 
     44      \item $x$ : a NumericalPoint 
     45      \item $sample$ : a NumericalSample 
     46      \end{description} 
     47    \item[Value :] \strut 
     48      \begin{description} 
     49      \item while using the first usage, a NumericalScalar, the CDF (Cumulative Distribution Function) of dimension 1 value of the considered distribution at $value$ 
     50      \item while using the second usage, a NumericalPoint, the CDF (Cumulative Distribution Function) value of the considered distribution at the vector $x$ 
     51      \item while using the third usage, a NumericalSample, the CDF (Cumulative Distribution Function) values of the considered distribution at $sample$ 
     52      \end{description} 
     53    \end{description} 
     54    \bigskip 
     55     
     56  \item $computeCDFGradient$ 
     57    \begin{description} 
     58    \item[Usage :] $computeCDFGradient(x)$  
     59    \item[Arguments :] $x$ : a NumericalPoint  
     60    \item[Value :] a NumericalPoint object, the gradient of the distribution CDF, with respect to the parameters of the distribution, evaluated at point $x$ 
     61    \end{description} 
     62    \bigskip 
     63     
     64  \item $computeDDF$ 
     65    \begin{description} 
     66    \item[Usage :]  \strut 
     67      \begin{description} 
     68      \item $computeDDF(x)$ 
     69      \item $computeDDF(sample)$  
     70      \end{description} 
     71    \item[Arguments :] \strut 
     72      \begin{description} 
     73      \item $x$ : a NumericalPoint 
     74      \item $sample$ : a NumericalSample 
     75      \end{description} 
     76    \item[Value :] \strut 
     77      \begin{description} 
     78      \item while using the first usage,  a NumericalPoint value, the gradient of the PDF (Probability Distribution Function) of the considered distribution at $x$ (DDF = Derivative Density Function) 
     79      \item while using the second usage,  a NumericalSample, the gradient of the PDF (Probability Distribution Function) of the considered distribution at $x$ (DDF = Derivative Density Function) 
     80      \end{description} 
     81    \end{description} 
     82    \bigskip 
     83     
     84  \item $computePDF$ 
     85    \begin{description} 
     86    \item[Usage :]  \strut 
     87      \begin{description} 
     88      \item $computePDF(value)$ 
     89      \item $computePDF(x)$ 
     90      \item $computePDF(sample)$  
     91      \end{description} 
     92    \item[Arguments :] \strut 
     93      \begin{description} 
     94      \item $x$ : a NumericalPoint 
     95      \item $sample$ : a NumericalSample 
     96      \end{description} 
     97    \item[Value :] \strut 
     98      \begin{description} 
     99      \item while using the first usage, a NumericalScalar, the PDF (Cumulative Distribution Function) of dimension 1 value of the considered distribution at $value$ 
     100      \item while using the second usage, a NumericalPoint, the PDF (Cumulative Distribution Function) value of the considered distribution at the vector $x$ 
     101      \item while using the third usage, a NumericalSample, the PDF (Cumulative Distribution Function) values of the considered distribution at $sample$ 
     102      \end{description} 
     103    \end{description} 
     104    \bigskip 
     105     
     106  \item $computePDFGradient$ 
     107    \begin{description} 
     108    \item[Usage :] $computePDFGradient(x)$  
     109    \item[Arguments :] $x$ : a NumericalPoint  
     110    \item[Value :] a NumericalPoint object, the gradient of the distribution PDF, with respect to the parameters of the distribution, evaluated at point $x$ 
     111    \end{description} 
     112    \bigskip 
     113     
     114  \item $computeQuantile$ 
     115    \begin{description} 
     116    \item[Usage :] $computeQuantile(x)$ 
     117    \item[Arguments :] $x$ : a real scalar $0\leq x \leq 1$ 
     118    \item[Value :] a NumericalPoint, the value of the $x-$ quantile 
     119    \end{description} 
     120    \bigskip 
     121     
     122  \item $drawCDF$ 
     123    \begin{description} 
     124    \item[Usage :] \strut 
     125      \begin{description}  
     126      \item $drawCDF()$ 
     127      \item $drawCDF(min,max)$ 
     128      \item $drawCDF(min,max,pointNumber)$  
     129      \item $drawCDF(vectMin,vectMax)$ 
     130      \item $drawCDF(vectMin,vectMax,vectPointNumber)$ 
     131      \end{description} 
     132       
     133    \item[Arguments :] \strut 
     134      \begin{description} 
     135      \item $min$ and $max$ : real values with $min < max$, the range for the CDF curve of a distribution of dimension 1 
     136      \item $pointNumber$ : an integer, the number of points to draw the CDF iso-curves of a distribution of dimension 1 
     137      \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension 2, respectively the left-bottom and ritgh-up corners of the square for the CDF iso-curves of a distribution of dimension 2 
     138      \item $vectPointNumber$ : a NumericalPoint of dimension 2, the the number of points to draw the iso-curves of a distribution of dimension 2 on each direction 
     139      \end{description} 
     140    \item[Value :] a Graph, containing the elements of the curve or iso-curves of the CDF, depending on the dimension of the distribution (1 or 2) 
     141    \end{description} 
     142     
     143    \bigskip 
     144     
     145  \item $drawPDF$ 
     146    \begin{description} 
     147    \item[Usage :] \strut 
     148      \begin{description}  
     149      \item $drawPDF()$ 
     150      \item $drawPDF(min,max)$ 
     151      \item $drawPDF(min,max,pointNumber)$  
     152      \item $drawPDF(vectMin,vectMax)$ 
     153      \item $drawPDF(vectMin,vectMax,vectPointNumber)$ 
     154      \end{description} 
     155       
     156    \item[Arguments :] \strut 
     157      \begin{description} 
     158      \item $min$ and $max$ : real values with $min < max$, the range for the PDF curve of a distribution of dimension 1 
     159      \item $pointNumber$ : an integer, the number of points to draw the PDF iso-curves of a distribution of dimension 1 
     160      \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension 2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension 2 
     161      \item $vectPointNumber$ : a NumericalPoint of dimension 2, the number of points to draw the iso-curves of a distribution of dimension 2 on each direction 
     162      \end{description} 
     163    \item[Value :] a Graph, containing the elements of the curve or iso-curves of the PDF, depending on the dimension of the distribution (1 or 2) 
     164    \end{description} 
     165     
     166     
     167    \bigskip 
     168     
     169  \item $drawMarginal1DCDF$ 
     170    \begin{description} 
     171    \item[Usage :] \strut 
     172      \begin{description}  
     173      \item $drawMarginal1DCDF(i, min,max,pointNumber)$  
     174      \end{description} 
     175       
     176    \item[Arguments :] \strut 
     177      \begin{description} 
     178      \item $i$ : an integer, the marginal we want to draw (Care : numerotation begins at 0) 
     179      \item $min$ and $max$ : real values with $min < max$, the range for the CDF curve of a distribution of dimension >1 
     180      \item $pointNumber$ : an integer, the number of points to draw the CDF iso-curves of a distribution of dimension >1 
     181      \end{description} 
     182    \item[Value :] a Graph, containing the elements of the curve of the CDF of the marginal i of the distribution of dimension >1 
     183    \end{description} 
     184     
     185    \bigskip 
     186     
     187  \item $drawMarginal1DPDF$ 
     188    \begin{description} 
     189    \item[Usage :] \strut 
     190      \begin{description}  
     191      \item $drawMarginal1DPDF(i, min, max, pointNumber)$  
     192      \end{description} 
     193       
     194    \item[Arguments :] \strut 
     195      \begin{description} 
     196      \item $i$ : an integer, the marginal we want to draw (Care : numerotation begins at 0) 
     197      \item $min$ and $max$ : real values with $min < max$, the range for the PDF curve of a distribution of dimension >1 
     198      \item $pointNumber$ : an integer, the number of points to draw the PDF iso-curves of a distribution of dimension >1 
     199      \end{description} 
     200    \item[Value :] a Graph, containing the elements of the curve of the PDF of the marginal i of the distribution of dimension >1 
     201    \end{description} 
     202     
     203    \bigskip 
     204     
     205  \item $drawMarginal2DCDF$ 
     206    \begin{description} 
     207    \item[Usage :] \strut 
     208      \begin{description} 
     209      \item $drawMarginal2DCDF(i, j, vectMin,vectMax,vectPointNumber)$  
     210      \end{description} 
     211       
     212    \item[Arguments :] \strut 
     213      \begin{description} 
     214      \item $i$ and $j$ : two integer, the marginal we want to draw (Care : numerotation begins at 0) 
     215      \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension n>2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension n 
     216      \item $vectPointNumber$ : a NumericalPoint of dimension n>2, the number of points to draw the iso-curves of a distribution of dimension n on each direction 
     217      \end{description} 
     218    \item[Value :] a Graph, containing the elements of the iso-curve of the CDF of the marginals (i,j) of distribution of dimension n>2 
     219    \end{description} 
     220     
     221    \bigskip 
     222     
     223  \item $drawMarginal2DPDF$ 
     224    \begin{description} 
     225    \item[Usage :] \strut 
     226      \begin{description}  
     227      \item $drawMarginal2DPDF(i, j, vectMin,vectMax,vectPointNumber)$  
     228      \end{description} 
     229       
     230    \item[Arguments :] \strut 
     231      \begin{description} 
     232      \item $i$ and $j$ : two integer, the marginal we want to draw (Care : numerotation begins at 0) 
     233      \item $vectMin$ and $vectMax$ : two NumericalPoint of dimension n>2, respectively the left-bottom and ritgh-up corners of the square for the PDF iso-curves of a distribution of dimension n 
     234      \item $vectPointNumber$ : a NumericalPoint of dimension n>2, the number of points to draw the iso-curves of a distribution of dimension n on each direction 
     235      \end{description} 
     236    \item[Value :] a Graph, containing the elements of the iso-curve of the PDF of the marginals (i,j) of distribution of dimension n>2 
     237    \end{description} 
     238     
     239    \bigskip 
     240     
     241  \item $getCopula$ 
     242    \begin{description} 
     243    \item[Usage :] $getCopula()$ 
     244    \item[Arguments :] no argument 
     245    \item[Value :] a Copula, the copula of the considered distribution which must be of type ComposedDistribution 
     246    \end{description} 
     247    \bigskip 
     248     
     249  \item $getCovariance$ 
     250    \begin{description} 
     251    \item[Usage :] $getCovariance()$ 
     252    \item[Arguments :] no argument 
     253    \item[Value :] a CovarianceMatrix of the considered distribution (if the distribution is unidimensional, it is the variance) 
     254    \end{description} 
     255    \bigskip 
     256     
     257  \item $getMarginal$ 
     258    \begin{description} 
     259    \item[Usage :] \strut 
     260      \begin{description} 
     261      \item $getMarginal(i)$ 
     262      \item $getMarginal(indices)$ 
     263      \end{description} 
     264       
     265       
     266    \item[Arguments :]  \strut 
     267      \begin{description} 
     268      \item $i$ : an integer (i is lower or equal to the dimension of the considered distribution), with $0 \leq i$ 
     269      \item $indices$ : a Indices, which regroup all the indices considered 
     270      \end{description} 
     271       
     272    \item[Value :] a Distribution, the distribution of an extracted vector of the initial distribution 
     273    \end{description} 
     274    \bigskip 
     275     
     276  \item $getKurtosis$ 
     277    \begin{description} 
     278    \item[Usage :] $getKurtosis()$ 
     279    \item[Arguments :] no argument 
     280    \item[Value :] a NumericalPoint, the value the kurtosis of each 1D marginal of the distribution 
     281    \end{description} 
     282    \bigskip 
     283     
     284  \item $getMean$ 
     285    \begin{description} 
     286    \item[Usage :] $getMean()$ 
     287    \item[Arguments :] no argument 
     288    \item[Value :] a NumericalPoint, the value of the considered distribution mean 
     289    \end{description} 
     290    \bigskip 
     291     
     292  \item $getNumericalSample$ 
     293    \begin{description} 
     294    \item[Usage :] $getNumericalSample(n)$ 
     295    \item[Arguments :] $n$ : integer, the size of the sample 
     296    \item[Value :] a NumericalSample representing $n$ realizations of the random variable with the considered distribution  
     297    \end{description} 
     298    \bigskip 
     299     
     300  \item $getParametersCollection$ 
     301    \begin{description} 
     302    \item[Usage :] $getParametersCollection()$ 
     303    \item[Arguments :] one 
     304    \item[Value :] a NumericalPointCollection, the list of the parameters of the distribution 
     305       
     306    \end{description} 
     307    \bigskip 
     308     
     309     
     310  \item $getRealization$ 
     311    \begin{description} 
     312    \item[Usage :] $getRealization()$ 
     313    \item[Arguments :] no argument 
     314    \item[Value :] a NumericalPoint, one realization of random variable with the considered distribution 
     315    \end{description} 
     316    \bigskip  
     317     
     318  \item $getRoughness$ 
     319    \begin{description} 
     320    \item[Usage :] $getRoughness()$ 
     321    \item[Arguments :] no argument 
     322    \item[Value :] a NumericalScalar, the value $roughness(\vect{X}) = ||p||_{\mathcal{L}^2} = \sqrt{\int_\vect{x} p^2(\vect{x})d\vect{x}}$ 
     323    \end{description} 
     324    \bigskip 
     325     
     326  \item $getSkewness$ 
     327    \begin{description} 
     328    \item[Usage :] $getSkewness()$ 
     329    \item[Arguments :] no argument 
     330    \item[Value :] a NumericalPoint, the value the standard deviation of each 1D marginal of the distribution 
     331    \end{description} 
     332    \bigskip 
     333     
     334  \item $getStandardDeviation$ 
     335    \begin{description} 
     336    \item[Usage :] $getStandardDeviation()$ 
     337    \item[Arguments :] no argument 
     338    \item[Value :] a NumericalPoint, the value the standard deviation of each 1D marginal of the distribution 
     339    \end{description} 
     340    \bigskip 
     341     
     342  \item $getWeight$ 
     343    \begin{description} 
     344    \item[Usage :] $getWeight()$ 
     345    \item[Arguments :] no argument 
     346    \item[Value :] a NumericalScalar between 0 and 1, the weight of the considered distribution if used in a Mixture 
     347    \end{description} 
     348    \bigskip 
     349     
     350  \item $hasEllipticalCopula$ 
     351    \begin{description} 
     352    \item[Usage :] $hasEllipticalCopula()$ 
     353    \item[Arguments :] no argument 
     354    \item[Value :] a boolean, it says if the considered distribution is elliptical  
     355    \end{description} 
     356    \bigskip 
     357     
     358  \item $hasIndependentCopula$ 
     359    \begin{description} 
     360    \item[Usage :] $hasIndependentCopula()$ 
     361    \item[Arguments :] no argument 
     362    \item[Value :] a boolean which indicates wether the considered distribution is independent  
     363    \end{description} 
     364    \bigskip 
     365  \item $isElliptical$ 
     366    \begin{description} 
     367    \item[Usage :] $isElliptical()$  
     368    \item[Arguments :] no argument 
     369    \item[Value :] a boolean which indicates wether the considered distribution has an elliptical distribution  
     370    \end{description} 
     371    \bigskip 
     372     
     373  \item $str$ 
     374    \begin{description} 
     375    \item[Usage :] $str()$ 
     376    \item[Arguments :] no argument 
     377    \item[Value :] a string describing the object 
     378    \end{description} 
     379    \bigskip 
     380     
     381  \end{description} 
     382   
    383383\end{description}    
    384384 
    …… 
    386386\newpage \subsection{Usual Distributions} \label{UsualDistributions} 
    387387 
    388  \subsubsection{Beta} 
    389  
    390 This class inherits from the Distribution class. 
    391  
    392 \begin{description} 
    393  
    394         \item[Usage :] \strut 
    395         \begin{description}      
    396