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
|
\name{DiracParameter-class}
\docType{class}
\alias{DiracParameter-class}
\alias{initialize,DiracParameter-method}
\title{Class "DiracParameter"}
\description{ The parameter of a Dirac distribution, used by \code{Dirac}-class}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("DiracParameter", location)}.
Usually an object of this class is not needed on its own, it is generated automatically when an object of the class \code{Dirac}
is instantiated.
}
\section{Slots}{
\describe{
\item{\code{location}}{Object of class \code{"numeric"}: the location of a Dirac distribution }\cr
\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 = "DiracParameter")}: initialize method }
\item{location}{\code{signature(object = "DiracParameter")}: returns the slot location of the parameter of the
distribution }
\item{location<-}{\code{signature(object = "DiracParameter")}: modifies the slot location 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{Dirac-class}}
\code{\link{Parameter-class}}
}
\examples{
W <- new("DiracParameter",location=1)
location(W) # location of this distribution is 1.
location(W) <- 2 # location of this distribution is now 2.
}
\keyword{distribution}
\concept{parameter}
\concept{location parameter}
\concept{Dirac distribution}
\concept{S4 parameter class}
|