~ubuntu-branches/ubuntu/precise/r-cran-stabledist/precise

« back to all changes in this revision

Viewing changes to man/dist-stableMode.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2011-03-18 08:33:40 UTC
  • Revision ID: james.westby@ubuntu.com-20110318083340-u3amutr8bf808yav
Tags: upstream-0.6-0
ImportĀ upstreamĀ versionĀ 0.6-0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\name{StableMode}
 
2
\alias{stableMode}
 
3
\title{Mode of the Stable Distribution Function}
 
4
\description{
 
5
  Computes the mode of the stable distribution function.
 
6
 
 
7
  Finds the maximum of \code{\link{dstable}} numerically, using
 
8
  \code{\link{uniroot}}.
 
9
}
 
10
\usage{
 
11
stableMode(alpha, beta,
 
12
           beta.max = 1 - 1e-11,
 
13
           tol = .Machine$double.eps^0.25)
 
14
}
 
15
\arguments{
 
16
  \item{alpha, beta}{numeric parameters:
 
17
    value of the index parameter \code{alpha} in the range \eqn{(0,2]},
 
18
    and the skewness parameter \code{beta}, in the range \eqn{[-1, 1]}.}
 
19
  \item{beta.max}{for numerical purposes, values of beta too close to 1,
 
20
    are set to \code{beta.max}.  Do not modify unless you know what
 
21
    you're doing.}
 
22
  \item{tol}{numerical tolerance for \code{\link{optimize}()}.}
 
23
}
 
24
\value{
 
25
  returns a numeric value, the location of the stable mode.
 
26
}
 
27
 
 
28
\author{
 
29
  Diethelm Wuertz for the Rmetrics \R-port;
 
30
  minor cleanup by Martin Maechler.
 
31
}
 
32
 
 
33
\references{
 
34
Chambers J.M., Mallows, C.L. and Stuck, B.W. (1976);
 
35
    \emph{A Method for Simulating Stable Random Variables},
 
36
    J. Amer. Statist. Assoc. 71, 340--344.
 
37
 
 
38
Nolan J.P. (1999);
 
39
    \emph{Stable Distributions},
 
40
    Preprint, University Washington DC, 30 pages.
 
41
 
 
42
Nolan J.P. (1999);
 
43
    \emph{Numerical Calculation of Stable Densities and Distribution
 
44
    Functions},
 
45
    Preprint, University Washington DC, 16 pages.
 
46
 
 
47
Samoridnitsky G., Taqqu M.S. (1994);
 
48
    \emph{Stable Non-Gaussian Random Processes, Stochastic Models
 
49
    with Infinite Variance},
 
50
    Chapman and Hall, New York, 632 pages.
 
51
 
 
52
Weron, A., Weron R. (1999);
 
53
    \emph{Computer Simulation of Levy alpha-Stable Variables and
 
54
    Processes},
 
55
    Preprint Technical Univeristy of Wroclaw, 13 pages.
 
56
}
 
57
 
 
58
\examples{
 
59
## stableMode -
 
60
   stableMode(alpha=1, beta=0)
 
61
   stableMode(alpha=1.2, beta=0.1)
 
62
}
 
63
\keyword{distribution}
 
64