← Back to branch summary

~ubuntu-branches/ubuntu/saucy/openturns/saucy

« back to all changes in this revision

Viewing changes to debian/rotRPackage/man/estimateTruncatedNormalParameters.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Christophe Prud'homme
  • Date: 2008-10-03 10:55:20 UTC
  • Revision ID: james.westby@ubuntu.com-20081003105520-i4sqk110f19vp7hd
Tags: 0.12.1-6
* debian/rules: Fix FTBS on hppa, sparc, arm, and armel because of
  __sync_fetch_and_add_4 not being available, the remedy is to use
  -DBOOST_SP_USE_PTHREADS
* debian/rules: add --disable-debug option to configure and set the
  compiler flags to -g -O2 (no -Wall)

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/rotRPackage/man/estimateTruncatedNormalParameters.Rd
 
1
\name{estimateTruncatedNormalParameters}
 
2
\alias{estimateTruncatedNormalParameters}
 
3
\title{Estimates the underlying truncated normal distribution parameters from a sample.}
 
4
\description{
 
5
This ROT function, called from a TruncatedNormalFactory C++ object, is given a sample
 
6
and returns the estimated parameters of the underlying TruncatedNormal distribution,   
 
7
as well as the corresponding confidence intervals of required level.                          
 
8
}
 
9
\usage{
 
10
estimateTruncatedNormalParameters(numericalSample, testLevel = 0.975)
 
11
}
 
12
\arguments{
 
13
  \item{numericalSample}{A vector containing the sample.}
 
14
  \item{testLevel}{the test level. (scalar in [0:1])}
 
15
}
 
16
\value{
 
17
A list is returned, containing :
 
18
  \item{distribution}{The distribution name.}
 
19
  \item{mu}{The estimated mu parameter.}
 
20
  \item{sigma}{The sigma parameter.}
 
21
  \item{a}{The aParameter parameter.}
 
22
  \item{b}{The bParameter parameter.}
 
23
  \item{confidenceIntervalmu}{CI for the mu parameter (vector).}
 
24
  \item{confidenceIntervalsigma}{CI for the sigma parameter (vector).}
 
25
  \item{logLikelihood}{The model loglikelihood.}
 
26
}
 
27
\author{Pierre-Matthieu Pair, R�gis Lebrun.}
 
28
\examples{
 
29
# Standard TruncatedNormal distribution example.
 
30
numericalSample <- rnorm(1000, 3, 1.5)
 
31
numericalSample <- numericalSample[numericalSample > 0.0 &&
 
32
numericalSample < 5.0]
 
33
print(estimateTruncatedNormalParameters(numericalSample))
 
34
}
 
35
\keyword{distribution}