[Distr-commits] r567 - branches/distr-2.2/pkg/distr/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Sep 4 12:11:19 CEST 2009
Author: stamats
Date: 2009-09-04 12:11:19 +0200 (Fri, 04 Sep 2009)
New Revision: 567
Added:
branches/distr-2.2/pkg/distr/man/AbscontDistribution-class.Rd
branches/distr-2.2/pkg/distr/man/AbscontDistribution.Rd
Removed:
branches/distr-2.2/pkg/distr/man/ContDistribution-class.Rd
branches/distr-2.2/pkg/distr/man/ContDistribution.Rd
Modified:
branches/distr-2.2/pkg/distr/man/0distr-package.Rd
branches/distr-2.2/pkg/distr/man/Math-methods.Rd
branches/distr-2.2/pkg/distr/man/distroptions.Rd
branches/distr-2.2/pkg/distr/man/internals.Rd
branches/distr-2.2/pkg/distr/man/operators-methods.Rd
branches/distr-2.2/pkg/distr/man/options.Rd
branches/distr-2.2/pkg/distr/man/plot-methods.Rd
Log:
html-Links should work now in package distr
Modified: branches/distr-2.2/pkg/distr/man/0distr-package.Rd
===================================================================
--- branches/distr-2.2/pkg/distr/man/0distr-package.Rd 2009-09-04 10:00:51 UTC (rev 566)
+++ branches/distr-2.2/pkg/distr/man/0distr-package.Rd 2009-09-04 10:11:19 UTC (rev 567)
@@ -49,8 +49,6 @@
SweaveListingUtils\cr
LazyLoad: \tab yes \cr
License: \tab LGPL-3 \cr
-License: \tab LGPL-3 \cr
-License: \tab LGPL-3 \cr
URL: \tab http://distr.r-forge.r-project.org/\cr
}}
@@ -240,7 +238,7 @@
\section{Methods}{
-The group \code{Math} of unary (see \link[base]{Math}) as well as
+The group \code{Math} of unary (see \link[methods:S4groupGeneric]{Math}) as well as
convolution are made available for distributions, see \link{operators-methods};
in particular for convolution powers, we have method \link{convpow}.
Besides, there are \code{plot} and \code{print}-methods for distributions.
Copied: branches/distr-2.2/pkg/distr/man/AbscontDistribution-class.Rd (from rev 564, branches/distr-2.2/pkg/distr/man/ContDistribution-class.Rd)
===================================================================
--- branches/distr-2.2/pkg/distr/man/AbscontDistribution-class.Rd (rev 0)
+++ branches/distr-2.2/pkg/distr/man/AbscontDistribution-class.Rd 2009-09-04 10:11:19 UTC (rev 567)
@@ -0,0 +1,174 @@
+\name{AbscontDistribution-class}
+\docType{class}
+\alias{AbscontDistribution-class}
+\alias{AffLinDistribution-class}
+\alias{AffLinAbscontDistribution-class}
+\alias{sqrt,AbscontDistribution-method}
+\alias{initialize,AbscontDistribution-method}
+\alias{initialize,AffLinAbscontDistribution-method}
+\alias{sqrt,AbscontDistribution-method}
+
+\title{Class "AbscontDistribution"}
+\description{The \code{AbscontDistribution}-class is the mother-class of the classes \code{Beta}, \code{Cauchy},
+\code{Chisq}, \code{Exp}, \code{F}, \code{Gammad}, \code{Lnorm}, \code{Logis}, \code{Norm}, \code{T}, \code{Unif} and
+\code{Weibull}. Further absolutely continuous distributions can be defined either by declaration of
+own random number generator, density, cumulative distribution and quantile functions, or as result of a
+convolution of two absolutely continuous distributions or by application of a mathematical operator to an absolutely
+continuous distribution.}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("AbscontDistribution", r, d, p, q)}.
+More comfortably, you may use the generating function \code{\link{AbscontDistribution}}.
+The result of these calls is an absolutely continuous distribution.
+}
+\section{Slots}{
+ \describe{
+ \item{\code{img}}{Object of class \code{"Reals"}: the space of the image of this distribution which has dimension 1
+ and the name "Real Space" }
+ \item{\code{param}}{Object of class \code{"Parameter"}: the parameter of this distribution, having only
+ the slot name "Parameter of an absolutely continuous distribution" }
+ \item{\code{r}}{Object of class \code{"function"}: generates random numbers}
+ \item{\code{d}}{Object of class \code{"function"}: density function}
+ \item{\code{p}}{Object of class \code{"function"}: cumulative distribution function}
+ \item{\code{q}}{Object of class \code{"function"}: quantile function}
+ \item{\code{gaps}}{[from version 1.9 on] Object of class \code{"OptionalMatrix"},
+ i.e.; an object which may either be \code{NULL} ora \code{matrix}.
+ This slot, if non-\code{NULL}, contains left and right
+ endpoints of intervals where the density of the object is 0. This slot
+ may be inspected by the accessor \code{\link{gaps}()} and modified by a corresponding
+ replacement method. It may also be filled automatically by
+ \code{\link{setgaps}()}. For saved objects from earlier versions, we provide functions
+ \code{\link{isOldVersion}} and \code{\link{conv2NewVersion}}.}
+ \item{\code{.withArith}}{logical: used internally to issue warnings as to
+ interpretation of arithmetics}
+ \item{\code{.withSim}}{logical: used internally to issue warnings as to
+ accuracy}
+ \item{\code{.logExact}}{logical: used internally to flag the case where
+ there are explicit formulae for the log version of density, cdf, and
+ quantile function}
+ \item{\code{.lowerExact}}{logical: used internally to flag the case where
+ there are explicit formulae for the lower tail version of cdf and quantile
+ function}
+ \item{\code{Symmetry}}{object of class \code{"DistributionSymmetry"};
+ used internally to avoid unnecessary calculations.}
+}}
+\section{Extends}{
+Class \code{"UnivariateDistribution"}, directly. \cr
+Class \code{"Distribution"}, by class \code{"UnivariateDistribution"}.
+}
+\section{Methods}{
+ \describe{
+ \item{initialize}{\code{signature(.Object = "AbscontDistribution")}: initialize method }
+ \item{Math}{\code{signature(x = "AbscontDistribution")}: application of a mathematical function, e.g. \code{sin} or
+ \code{exp} (does not work with \code{log}, \code{sign}!), to this absolutely continouos distribution
+ \itemize{
+ \item \code{abs}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{abs(x)}.
+ \item \code{exp}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{exp(x)}.
+ \item \code{sign}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sign(x)}.
+ \item \code{sqrt}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sqrt(x)}.
+ \item \code{log}: \code{signature(x = "AbscontDistribution")}: (with optional further argument \code{base}, defaulting to \code{exp(1)}) exact image distribution of \code{log(x)}.
+ \item \code{log10}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{log10(x)}.
+ \item \code{gamma}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{gamma(x)}.
+ \item \code{lgamma}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{lgamma(x)}.
+ \item \code{sqrt}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sqrt(x)}.
+ }}
+ \item{-}{\code{signature(e1 = "AbscontDistribution")}: application of `-' to this absolutely continuous distribution.}
+ \item{*}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: multiplication of this absolutely continuous distribution by an object of class \code{"numeric"}}
+ \item{/}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: division of this absolutely continuous distribution by an object of class \code{"numeric"}}
+ \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: addition of this absolutely continuous distribution to an object of class \code{"numeric"}.}
+ \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: subtraction of an object of class \code{"numeric"} from this absolutely continuous distribution.}
+ \item{*}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: multiplication of this absolutely continuous distribution by an object of class \code{"numeric"}.}
+ \item{+}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: addition of this absolutely continuous distribution to an object of class \code{"numeric"}.}
+ \item{-}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: subtraction of this absolutely continuous distribution from an object of class \code{"numeric"}.}
+ \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "AbscontDistribution")}: Convolution of two absolutely continuous distributions. The slots p, d and q are approximated by grids.}
+ \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "AbscontDistribution")}: Convolution of two absolutely continuous distributions. The slots p, d and q are approximated by grids.}
+ \item{plot}{\code{signature(object = "AbscontDistribution")}: plots density, cumulative distribution and quantile function.}
+ }
+}
+
+\section{Internal subclass "AffLinAbscontDistribution"}{
+To enhance accuracy of several functionals on distributions,
+ mainly from package \pkg{distrEx}, from version 1.9 of this package on,
+ there is an internally used (but exported) subclass
+ \code{"AffLinAbscontDistribution"} which has extra slots
+ \code{a}, \code{b} (both of class \code{"numeric"}), and \code{X0}
+ (of class \code{"AbscontDistribution"}), to capture the fact
+ that the object has the same distribution as \code{a * X0 + b}. This is
+ the class of the return value of methods
+ \describe{
+ \item{-}{\code{signature(e1 = "AbscontDistribution")}}
+ \item{*}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
+ \item{/}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
+ \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
+ \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
+ \item{*}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
+ \item{+}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
+ \item{-}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
+ \item{-}{\code{signature(e1 = "AffLinAbscontDistribution")}}
+ \item{*}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
+ \item{/}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
+ \item{+}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
+ \item{-}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
+ \item{*}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
+ \item{+}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
+ \item{-}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
+ }
+ There also is a class union of \code{"AffLinAbscontDistribution"},
+ \code{"AffLinDiscreteDistribution"}, \code{"AffLinUnivarLebDecDistribution"}
+ and called \code{"AffLinDistribution"}
+ which is used for functionals.
+}
+\section{Internal virtual superclass "AcDcLcDistribution"}{
+As many operations should be valid no matter whether the operands
+are of class \code{"AbscontDistribution"},
+ \code{"DiscreteDistribution"}, or \code{"UnivarLebDecDistribution"},
+there is a class union of these classes called \code{"AcDcLcDistribution"};
+in partiucalar methods for \code{"*"}, \code{"/"},
+\code{"^"} (see \link{operators-methods}) and methods
+\code{\link{Minimum}}, \code{Maximum}, \code{\link{Truncate}}, and
+ \code{\link{Huberize}}, and \code{\link{convpow}} are defined for this
+ class union.
+}
+
+\author{
+ Thomas Stabla \email{statho3 at web.de},\cr
+ Florian Camphausen \email{fcampi at gmx.de},\cr
+ Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de},\cr
+ Matthias Kohl \email{Matthias.Kohl at stamats.de}
+ }
+
+
+\seealso{
+\code{\link{AbscontDistribution}}
+\code{\link{Parameter-class}}
+\code{\link{UnivariateDistribution-class}}
+\code{\link{Beta-class}}
+\code{\link{Cauchy-class}}
+\code{\link{Chisq-class}}
+\code{\link{Exp-class}}
+\code{\link{Fd-class}}
+\code{\link{Gammad-class}}
+\code{\link{Lnorm-class}}
+\code{\link{Logis-class}}
+\code{\link{Norm-class}}
+\code{\link{Td-class}}
+\code{\link{Unif-class}}
+\code{\link{Weibull-class}}
+\code{\link{DiscreteDistribution-class}}
+\code{\link{Reals-class}}
+\code{\link{RtoDPQ}}
+
+}
+\examples{
+N <- Norm() # N is a normal distribution with mean=0 and sd=1.
+E <- Exp() # E is an exponential distribution with rate=1.
+A1 <- E+1 # a new absolutely continuous distributions with exact slots d, p, q
+A2 <- A1*3 # a new absolutely continuous distributions with exact slots d, p, q
+A3 <- N*0.9 + E*0.1 # a new absolutely continuous distribution with approximated slots d, p, q
+r(A3)(1) # one random number generated from this distribution, e.g. -0.7150937
+d(A3)(0) # The (approximated) density for x=0 is 0.4379882.
+p(A3)(0) # The (approximated) probability that x <= 0 is 0.4562021.
+q(A3)(.1) # The (approximated) 10 percent quantile is 0.1.
+}
+\keyword{distribution}
+\concept{absolutely continuous distribution}
+\concept{S4 distribution class}
Property changes on: branches/distr-2.2/pkg/distr/man/AbscontDistribution-class.Rd
___________________________________________________________________
Name: svn:keywords
+
Name: svn:mergeinfo
+
Copied: branches/distr-2.2/pkg/distr/man/AbscontDistribution.Rd (from rev 564, branches/distr-2.2/pkg/distr/man/ContDistribution.Rd)
===================================================================
--- branches/distr-2.2/pkg/distr/man/AbscontDistribution.Rd (rev 0)
+++ branches/distr-2.2/pkg/distr/man/AbscontDistribution.Rd 2009-09-04 10:11:19 UTC (rev 567)
@@ -0,0 +1,119 @@
+\name{AbscontDistribution}
+\alias{AbscontDistribution}
+
+\title{Generating function "AbscontDistribution"}
+\description{Generates an object of class \code{"AbscontDistribution"}}
+
+\usage{
+AbscontDistribution(r = NULL, d = NULL, p = NULL, q = NULL,
+ gaps = NULL, param = NULL, img = new("Reals"),
+ .withSim = FALSE, .withArith = FALSE,
+ .lowerExact = FALSE, .logExact = FALSE,
+ withgaps = getdistrOption("withgaps"),
+ low1 = NULL, up1 = NULL, low = -Inf, up =Inf,
+ withStand = FALSE,
+ ngrid = getdistrOption("DefaultNrGridPoints"),
+ ep = getdistrOption("TruncQuantile"),
+ e = getdistrOption("RtoDPQ.e"),
+ Symmetry = NoSymmetry())
+}
+\arguments{
+ \item{r}{slot \code{r} to be filled}
+ \item{d}{slot \code{d} to be filled}
+ \item{p}{slot \code{p} to be filled}
+ \item{q}{slot \code{q} to be filled}
+ \item{gaps}{slot gaps (of class \code{"matrix"} with two columns) to be filled
+ (i.e. \code{t(gaps)} must be ordered if read as vector)}
+ \item{param}{parameter (of class \code{"OptionalParameter"})}
+ \item{img}{image range of the distribution (of class \code{"rSpace"})}
+ \item{low1}{lower bound (to be the lower TruncQuantile-quantile of the distribution)}
+ \item{up1}{upper bound (to be the upper TruncQuantile-quantile of the distribution)}
+ \item{low}{lower bound (to be the 100-percent-quantile of the distribution)}
+ \item{up}{upper bound (to be the 100-percent-quantile of the distribution)}
+ \item{withStand}{logical: shall we standardize argument function \code{d}
+ to integrate to 1 --- default is no resp. \code{FALSE}}
+ \item{ngrid}{number of gridpoints}
+ \item{ep}{tolerance epsilon}
+ \item{e}{exponent to base 10 to be used for simulations}
+ \item{withgaps}{logical; shall gaps be reconstructed empirically?}
+ \item{.withArith}{normally not set by the user, but if determining the entries \code{supp}, \code{prob}
+ distributional arithmetics was involved, you may set this to \code{TRUE}.}
+ \item{.withSim}{normally not set by the user, but if determining the entries \code{supp}, \code{prob}
+ simulations were involved, you may set this to \code{TRUE}.}
+ \item{.lowerExact}{normally not set by the user: whether the \code{lower.tail=FALSE}
+ part is calculated exactly, avoing a ``\code{1-.}''.}
+ \item{.logExact}{normally not set by the user: whether in determining slots \code{d,p,q},
+ we make particular use of a logarithmic representation to enhance accuracy.}
+ \item{Symmetry}{you may help \R in calculations if you tell it whether
+ the distribution is non-symmetric (default) or symmetric with respect
+ to a center; in this case use \code{Symmetry=SphericalSymmetry(center)}.}
+}
+\details{
+ Typical usages are
+ \preformatted{
+ AbscontDistribution(r)
+ AbscontDistribution(r = NULL, d)
+ AbscontDistribution(r = NULL, d = NULL, p)
+ AbscontDistribution(r = NULL, d = NULL, p = NULL, d)
+ AbscontDistribution(r, d, p, q)
+ }
+
+
+Minimally, only one of the slots \code{r}, \code{d}, \code{p} or \code{q} needs to be given as argument.
+The other non-given slots are then reconstructed according to the following scheme:
+
+\tabular{ccccl}{
+r\tab d\tab p\tab q\tab proceding\cr
+-\tab -\tab -\tab -\tab excluded\cr
+-\tab +\tab -\tab -\tab p by \code{.D2P}, q by \code{.P2Q}, r by \code{q(runif(n))}\cr
+-\tab -\tab +\tab -\tab d by \code{.P2D}, q by \code{.P2Q}, r by \code{q(runif(n))}\cr
+-\tab +\tab +\tab -\tab q by \code{.P2Q}, r by \code{q(runif(n))}\cr
+-\tab -\tab -\tab +\tab p by \code{.Q2P}, d by \code{.P2D}, r by \code{q(runif(n))}\cr
+-\tab +\tab -\tab +\tab p by \code{.Q2P}, r by \code{q(runif(n))}\cr
+-\tab -\tab +\tab +\tab d by \code{.P2D}, r by \code{q(runif(n))}\cr
+-\tab +\tab +\tab +\tab r by \code{q(runif(n))}\cr
++\tab -\tab -\tab -\tab call to \code{\link{RtoDPQ}}\cr
++\tab +\tab -\tab -\tab p by \code{.D2P}, q by \code{.P2Q}\cr
++\tab -\tab +\tab -\tab d by \code{.P2D}, q by \code{.P2Q}\cr
++\tab +\tab +\tab -\tab q by \code{.P2Q}\cr
++\tab -\tab -\tab +\tab p by \code{.Q2P}, d by \code{.P2D}\cr
++\tab +\tab -\tab +\tab p by \code{.Q2P}\cr
++\tab -\tab +\tab +\tab d by \code{.P2D}\cr
++\tab +\tab +\tab +\tab nothing\cr}
+For this purpose, one may alternatively give arguments \code{low1} and \code{up1} (\code{NULL} each by default,
+and determined through slot \code{q}, resp. \code{p}, resp. \code{d}, resp. \code{r} in this order
+according to availability),
+for the (finite) range of values in the support of this distribution,
+as well as the possibly infinite theoretical range given by
+arguments \code{low} and \code{up} with default values \code{-Inf}, \code{Inf}, respectively.
+Of course all other slots may be specified as arguments.}
+
+\value{Object of class \code{"AbscontDistribution"}}
+
+
+\author{
+ Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}
+ }
+
+
+\seealso{
+\code{\link{AbscontDistribution-class}},
+\code{\link{DiscreteDistribution-class}},
+\code{\link{RtoDPQ}}
+}
+\examples{
+plot(Norm())
+plot(AbscontDistribution(r = rnorm))
+plot(AbscontDistribution(d = dnorm))
+plot(AbscontDistribution(p = pnorm))
+plot(AbscontDistribution(q = qnorm))
+plot(Ac <- AbscontDistribution(d = function(x, log = FALSE){
+ d <- exp(-abs(x^3))
+ ## unstandardized!!
+ if(log) d <- log(d)
+ return(d)},
+ withStand = TRUE))
+}
+\keyword{distribution}
+\concept{absolutely continuous distribution}
+\concept{generating function}
Property changes on: branches/distr-2.2/pkg/distr/man/AbscontDistribution.Rd
___________________________________________________________________
Name: svn:keywords
+
Name: svn:mergeinfo
+
Deleted: branches/distr-2.2/pkg/distr/man/ContDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distr/man/ContDistribution-class.Rd 2009-09-04 10:00:51 UTC (rev 566)
+++ branches/distr-2.2/pkg/distr/man/ContDistribution-class.Rd 2009-09-04 10:11:19 UTC (rev 567)
@@ -1,174 +0,0 @@
-\name{AbscontDistribution-class}
-\docType{class}
-\alias{AbscontDistribution-class}
-\alias{AffLinDistribution-class}
-\alias{AffLinAbscontDistribution-class}
-\alias{sqrt,AbscontDistribution-method}
-\alias{initialize,AbscontDistribution-method}
-\alias{initialize,AffLinAbscontDistribution-method}
-\alias{sqrt,AbscontDistribution-method}
-
-\title{Class "AbscontDistribution"}
-\description{The \code{AbscontDistribution}-class is the mother-class of the classes \code{Beta}, \code{Cauchy},
-\code{Chisq}, \code{Exp}, \code{F}, \code{Gammad}, \code{Lnorm}, \code{Logis}, \code{Norm}, \code{T}, \code{Unif} and
-\code{Weibull}. Further absolutely continuous distributions can be defined either by declaration of
-own random number generator, density, cumulative distribution and quantile functions, or as result of a
-convolution of two absolutely continuous distributions or by application of a mathematical operator to an absolutely
-continuous distribution.}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("AbscontDistribution", r, d, p, q)}.
-More comfortably, you may use the generating function \code{\link{AbscontDistribution}}.
-The result of these calls is an absolutely continuous distribution.
-}
-\section{Slots}{
- \describe{
- \item{\code{img}}{Object of class \code{"Reals"}: the space of the image of this distribution which has dimension 1
- and the name "Real Space" }
- \item{\code{param}}{Object of class \code{"Parameter"}: the parameter of this distribution, having only
- the slot name "Parameter of an absolutely continuous distribution" }
- \item{\code{r}}{Object of class \code{"function"}: generates random numbers}
- \item{\code{d}}{Object of class \code{"function"}: density function}
- \item{\code{p}}{Object of class \code{"function"}: cumulative distribution function}
- \item{\code{q}}{Object of class \code{"function"}: quantile function}
- \item{\code{gaps}}{[from version 1.9 on] Object of class \code{"OptionalMatrix"},
- i.e.; an object which may either be \code{NULL} ora \code{matrix}.
- This slot, if non-\code{NULL}, contains left and right
- endpoints of intervals where the density of the object is 0. This slot
- may be inspected by the accessor \code{\link{gaps}()} and modified by a corresponding
- replacement method. It may also be filled automatically by
- \code{\link{setgaps}()}. For saved objects from earlier versions, we provide functions
- \code{\link{isOldVersion}} and \code{\link{conv2NewVersion}}.}
- \item{\code{.withArith}}{logical: used internally to issue warnings as to
- interpretation of arithmetics}
- \item{\code{.withSim}}{logical: used internally to issue warnings as to
- accuracy}
- \item{\code{.logExact}}{logical: used internally to flag the case where
- there are explicit formulae for the log version of density, cdf, and
- quantile function}
- \item{\code{.lowerExact}}{logical: used internally to flag the case where
- there are explicit formulae for the lower tail version of cdf and quantile
- function}
- \item{\code{Symmetry}}{object of class \code{"DistributionSymmetry"};
- used internally to avoid unnecessary calculations.}
-}}
-\section{Extends}{
-Class \code{"UnivariateDistribution"}, directly. \cr
-Class \code{"Distribution"}, by class \code{"UnivariateDistribution"}.
-}
-\section{Methods}{
- \describe{
- \item{initialize}{\code{signature(.Object = "AbscontDistribution")}: initialize method }
- \item{Math}{\code{signature(x = "AbscontDistribution")}: application of a mathematical function, e.g. \code{sin} or
- \code{exp} (does not work with \code{log}, \code{sign}!), to this absolutely continouos distribution
- \itemize{
- \item \code{abs}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{abs(x)}.
- \item \code{exp}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{exp(x)}.
- \item \code{sign}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sign(x)}.
- \item \code{sqrt}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sqrt(x)}.
- \item \code{log}: \code{signature(x = "AbscontDistribution")}: (with optional further argument \code{base}, defaulting to \code{exp(1)}) exact image distribution of \code{log(x)}.
- \item \code{log10}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{log10(x)}.
- \item \code{gamma}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{gamma(x)}.
- \item \code{lgamma}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{lgamma(x)}.
- \item \code{sqrt}: \code{signature(x = "AbscontDistribution")}: exact image distribution of \code{sqrt(x)}.
- }}
- \item{-}{\code{signature(e1 = "AbscontDistribution")}: application of `-' to this absolutely continuous distribution.}
- \item{*}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: multiplication of this absolutely continuous distribution by an object of class \code{"numeric"}}
- \item{/}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: division of this absolutely continuous distribution by an object of class \code{"numeric"}}
- \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: addition of this absolutely continuous distribution to an object of class \code{"numeric"}.}
- \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}: subtraction of an object of class \code{"numeric"} from this absolutely continuous distribution.}
- \item{*}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: multiplication of this absolutely continuous distribution by an object of class \code{"numeric"}.}
- \item{+}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: addition of this absolutely continuous distribution to an object of class \code{"numeric"}.}
- \item{-}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}: subtraction of this absolutely continuous distribution from an object of class \code{"numeric"}.}
- \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "AbscontDistribution")}: Convolution of two absolutely continuous distributions. The slots p, d and q are approximated by grids.}
- \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "AbscontDistribution")}: Convolution of two absolutely continuous distributions. The slots p, d and q are approximated by grids.}
- \item{plot}{\code{signature(object = "AbscontDistribution")}: plots density, cumulative distribution and quantile function.}
- }
-}
-
-\section{Internal subclass "AffLinAbscontDistribution"}{
-To enhance accuracy of several functionals on distributions,
- mainly from package \pkg{distrEx}, from version 1.9 of this package on,
- there is an internally used (but exported) subclass
- \code{"AffLinAbscontDistribution"} which has extra slots
- \code{a}, \code{b} (both of class \code{"numeric"}), and \code{X0}
- (of class \code{"AbscontDistribution"}), to capture the fact
- that the object has the same distribution as \code{a * X0 + b}. This is
- the class of the return value of methods
- \describe{
- \item{-}{\code{signature(e1 = "AbscontDistribution")}}
- \item{*}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
- \item{/}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
- \item{+}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
- \item{-}{\code{signature(e1 = "AbscontDistribution", e2 = "numeric")}}
- \item{*}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
- \item{+}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
- \item{-}{\code{signature(e1 = "numeric", e2 = "AbscontDistribution")}}
- \item{-}{\code{signature(e1 = "AffLinAbscontDistribution")}}
- \item{*}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
- \item{/}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
- \item{+}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
- \item{-}{\code{signature(e1 = "AffLinAbscontDistribution", e2 = "numeric")}}
- \item{*}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
- \item{+}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
- \item{-}{\code{signature(e1 = "numeric", e2 = "AffLinAbscontDistribution")}}
- }
- There also is a class union of \code{"AffLinAbscontDistribution"},
- \code{"AffLinDiscreteDistribution"}, \code{"AffLinUnivarLebDecDistribution"}
- and called \code{"AffLinDistribution"}
- which is used for functionals.
-}
-\section{Internal virtual superclass "AcDcLcDistribution"}{
-As many operations should be valid no matter whether the operands
-are of class \code{"AbscontDistribution"},
- \code{"DiscreteDistribution"}, or \code{"UnivarLebDecDistribution"},
-there is a class union of these classes called \code{"AcDcLcDistribution"};
-in partiucalar methods for \code{"*"}, \code{"/"},
-\code{"^"} (see \link{operators-methods}) and methods
-\code{\link{Minimum}}, \code{Maximum}, \code{\link{Truncate}}, and
- \code{\link{Huberize}}, and \code{\link{convpow}} are defined for this
- class union.
-}
-
-\author{
- Thomas Stabla \email{statho3 at web.de},\cr
- Florian Camphausen \email{fcampi at gmx.de},\cr
- Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de},\cr
- Matthias Kohl \email{Matthias.Kohl at stamats.de}
- }
-
-
-\seealso{
-\code{\link{AbscontDistribution}}
-\code{\link{Parameter-class}}
-\code{\link{UnivariateDistribution-class}}
-\code{\link{Beta-class}}
-\code{\link{Cauchy-class}}
-\code{\link{Chisq-class}}
-\code{\link{Exp-class}}
-\code{\link{Fd-class}}
-\code{\link{Gammad-class}}
-\code{\link{Lnorm-class}}
-\code{\link{Logis-class}}
-\code{\link{Norm-class}}
-\code{\link{Td-class}}
-\code{\link{Unif-class}}
-\code{\link{Weibull-class}}
-\code{\link{DiscreteDistribution-class}}
-\code{\link{Reals-class}}
-\code{\link{RtoDPQ}}
-
-}
-\examples{
-N <- Norm() # N is a normal distribution with mean=0 and sd=1.
-E <- Exp() # E is an exponential distribution with rate=1.
-A1 <- E+1 # a new absolutely continuous distributions with exact slots d, p, q
-A2 <- A1*3 # a new absolutely continuous distributions with exact slots d, p, q
-A3 <- N*0.9 + E*0.1 # a new absolutely continuous distribution with approximated slots d, p, q
-r(A3)(1) # one random number generated from this distribution, e.g. -0.7150937
-d(A3)(0) # The (approximated) density for x=0 is 0.4379882.
-p(A3)(0) # The (approximated) probability that x <= 0 is 0.4562021.
-q(A3)(.1) # The (approximated) 10 percent quantile is 0.1.
-}
-\keyword{distribution}
-\concept{absolutely continuous distribution}
-\concept{S4 distribution class}
Deleted: branches/distr-2.2/pkg/distr/man/ContDistribution.Rd
===================================================================
--- branches/distr-2.2/pkg/distr/man/ContDistribution.Rd 2009-09-04 10:00:51 UTC (rev 566)
+++ branches/distr-2.2/pkg/distr/man/ContDistribution.Rd 2009-09-04 10:11:19 UTC (rev 567)
@@ -1,119 +0,0 @@
-\name{AbscontDistribution}
-\alias{AbscontDistribution}
-
-\title{Generating function "AbscontDistribution"}
-\description{Generates an object of class \code{"AbscontDistribution"}}
-
-\usage{
-AbscontDistribution(r = NULL, d = NULL, p = NULL, q = NULL,
- gaps = NULL, param = NULL, img = new("Reals"),
- .withSim = FALSE, .withArith = FALSE,
- .lowerExact = FALSE, .logExact = FALSE,
- withgaps = getdistrOption("withgaps"),
- low1 = NULL, up1 = NULL, low = -Inf, up =Inf,
- withStand = FALSE,
- ngrid = getdistrOption("DefaultNrGridPoints"),
- ep = getdistrOption("TruncQuantile"),
- e = getdistrOption("RtoDPQ.e"),
- Symmetry = NoSymmetry())
-}
-\arguments{
- \item{r}{slot \code{r} to be filled}
- \item{d}{slot \code{d} to be filled}
- \item{p}{slot \code{p} to be filled}
- \item{q}{slot \code{q} to be filled}
- \item{gaps}{slot gaps (of class \code{"matrix"} with two columns) to be filled
- (i.e. \code{t(gaps)} must be ordered if read as vector)}
- \item{param}{parameter (of class \code{"OptionalParameter"})}
- \item{img}{image range of the distribution (of class \code{"rSpace"})}
- \item{low1}{lower bound (to be the lower TruncQuantile-quantile of the distribution)}
- \item{up1}{upper bound (to be the upper TruncQuantile-quantile of the distribution)}
- \item{low}{lower bound (to be the 100-percent-quantile of the distribution)}
- \item{up}{upper bound (to be the 100-percent-quantile of the distribution)}
- \item{withStand}{logical: shall we standardize argument function \code{d}
- to integrate to 1 --- default is no resp. \code{FALSE}}
- \item{ngrid}{number of gridpoints}
- \item{ep}{tolerance epsilon}
- \item{e}{exponent to base 10 to be used for simulations}
- \item{withgaps}{logical; shall gaps be reconstructed empirically?}
- \item{.withArith}{normally not set by the user, but if determining the entries \code{supp}, \code{prob}
- distributional arithmetics was involved, you may set this to \code{TRUE}.}
- \item{.withSim}{normally not set by the user, but if determining the entries \code{supp}, \code{prob}
- simulations were involved, you may set this to \code{TRUE}.}
- \item{.lowerExact}{normally not set by the user: whether the \code{lower.tail=FALSE}
- part is calculated exactly, avoing a ``\code{1-.}''.}
- \item{.logExact}{normally not set by the user: whether in determining slots \code{d,p,q},
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/distr -r 567
More information about the Distr-commits
mailing list