File: Arcsine-class.Rd

package info (click to toggle)
r-cran-distr 2.9.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,344 kB
  • sloc: ansic: 199; sh: 13; makefile: 2
file content (76 lines) | stat: -rw-r--r-- 2,934 bytes parent folder | download | duplicates (2)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
\name{Arcsine-class}
\docType{class}
\alias{Arcsine-class}
\alias{Arcsine}
\alias{initialize,Arcsine-method}
\title{Class "Arcsine"}
\description{
  The Arcsine distribution has density
  \deqn{f(x)=\frac{1}{\pi \sqrt{1-x^2}%
  }}{1/sqrt(1+x^2)/pi}
  for \eqn{-1 < x < 1}{-1 < x < 1}.
}

\section{Objects from the Class}{
  Objects can be created by calls of the form \code{Arcsine()}.
  This object is an Arcsine distribution.
}
\section{Slots}{
  \describe{
    \item{\code{img}}{Object of class \code{"Reals"}:
      The space of the image of this distribution has got dimension 1 and the name "Real Space". }
    \item{\code{r}}{Object of class \code{"function"}:
      generates random numbers (calls function rArcsine)}
    \item{\code{d}}{Object of class \code{"function"}:
      density function (calls function dArcsine)}
    \item{\code{p}}{Object of class \code{"function"}:
      cumulative function (calls function pArcsine)}
    \item{\code{q}}{Object of class \code{"function"}:
      inverse of the cumulative function (calls function qArcsine)}
    \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{"AbscontDistribution"}, directly. \cr
  Class \code{"UnivariateDistribution"}, by class \code{"AbscontDistribution"}. \cr
  Class \code{"Distribution"}, by class \code{"AbscontDistribution"}.
}
\section{Methods}{
  \describe{
    \item{initialize}{\code{signature(.Object = "Arcsine")}:
      initialize method}
  }
}

\author{
  Peter Ruckdeschel \email{peter.ruckdeschel@uni-oldenburg.de}
  }
\seealso{
  \code{\link{AbscontDistribution-class}}
  \code{\link{Reals-class}}
}
\examples{
A <- Arcsine()
# A is a Arcsine distribution with shape1 = 1 and shape2 = 1.
r(A)(3) # three random number generated from this distribution, e.g. 0.6979795
d(A)(c(-2,-1,-0.2,0,0.2,1,2)) # Density at x=c(-1,-0.2,0,0.2,1).
p(A)(c(-2,-1,-0.2,0,0.2,1,2)) # cdf at q=c(-1,-0.2,0,0.2,1).
q(A)(c(0,0.2,1,2)) # quantile function at at x=c(0,0.2,1).
## in RStudio or Jupyter IRKernel, use q.l(A)(c(0,0.2,1,2)) instead
}
\keyword{distribution}
\concept{absolutely continuous distribution}
\concept{Arcsine distribution}
\concept{S4 distribution class}
\concept{generating function}