VaRES (version 1.0.1)

secant: Hyperbolic secant distribution

Description

Computes the pdf, cdf, value at risk and expected shortfall for the hyperbolic secant distribution given by $$\begin{array}{ll}& {\displaystyle f(x)=\frac{1}{2}\mathrm{s}\mathrm{e}\mathrm{c}\mathrm{h}\left(\frac{\pi x}{2}\right),}\\ & {\displaystyle F(x)=\frac{2}{\pi }\arctan [\exp \left(\frac{\pi x}{2}\right)],}\\ & {\displaystyle {\mathrm{V}\mathrm{a}\mathrm{R}}_p(X)=\frac{2}{\pi }\log [\tan \left(\frac{\pi p}{2}\right)],}\\ & {\displaystyle {\mathrm{E}\mathrm{S}}_p(X)=\frac{2}{\pi p}{\int }_0^p\log [\tan \left(\frac{\pi v}{2}\right)]dv}\end{array}$$ for $-\mathrm{\infty }<x<\mathrm{\infty }$, and $0<p<1$.

Usage

dsecant(x, log=FALSE)
psecant(x, log.p=FALSE, lower.tail=TRUE)
varsecant(p, log.p=FALSE, lower.tail=TRUE)
essecant(p)

Arguments

x

scaler or vector of values at which the pdf or cdf needs to be computed

p

scaler or vector of values at which the value at risk or expected shortfall needs to be computed

log

if TRUE then log(pdf) are returned

log.p

if TRUE then log(cdf) are returned and quantiles are computed for exp(p)

lower.tail

if FALSE then 1-cdf are returned and quantiles are computed for 1-p

Value

An object of the same length as x, giving the pdf or cdf values computed at x or an object of the same length as p, giving the values at risk or expected shortfall computed at p.

References

S. Nadarajah, S. Chan and E. Afuecheta, An R Package for value at risk and expected shortfall, submitted

Examples

# NOT RUN {
x=runif(10,min=0,max=1)
dsecant(x)
psecant(x)
varsecant(x)
essecant(x)
# }