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
|
\name{NormParameter-class}
\docType{class}
\alias{NormParameter-class}
\alias{initialize,NormParameter-method}
\title{Class "NormParameter"}
\description{ The parameter of a normal distribution, used by Norm-class}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("NormParameter", sd, mean)}.
Usually an object of this class is not needed on its own. It is the
mother-class of the class UniNormParameter, which is generated
automatically when such a distribution is instantiated.
}
\section{Slots}{
\describe{
\item{\code{sd}}{Object of class \code{"numeric"}: the sd of a normal distribution }
\item{\code{mean}}{Object of class \code{"numeric"}: the mean of a normal distribution }
\item{\code{name}}{Object of class \code{"character"}: a name / comment for the parameters }
}
}
\section{Extends}{
Class \code{"Parameter"}, directly.
}
\section{Methods}{
\describe{
\item{initialize}{\code{signature(.Object = "NormParameter")}:
initialize method}
\item{mean}{\code{signature(object = "NormParameter")}:
returns the slot mean of the parameter of the distribution}
\item{mean<-}{\code{signature(object = "NormParameter")}:
modifies the slot mean of the parameter of the distribution}
\item{sd}{\code{signature(object = "NormParameter")}:
returns the slot sd of the parameter of the distribution}
\item{sd<-}{\code{signature(object = "NormParameter")}:
modifies the slot sd of the parameter of the distribution}
}
}
\author{
Thomas Stabla \email{statho3@web.de},\cr
Florian Camphausen \email{fcampi@gmx.de},\cr
Peter Ruckdeschel \email{peter.ruckdeschel@uni-oldenburg.de},\cr
Matthias Kohl \email{Matthias.Kohl@stamats.de}}
\seealso{
\code{\link{Norm-class}}
\code{\link{Parameter-class}}
}
\examples{
W <- new("NormParameter", mean = 0, sd = 1)
sd(W) # sd of this distribution is 1.
sd(W) <- 2 # sd of this distribution is now 2.
}
\keyword{distribution}
\concept{parameter}
\concept{Gaussian distribution}
\concept{Normal distribution}
\concept{S4 parameter class}
\concept{location scale family}
|