rmslash: Multivariate Slash Random Deviates

Description Usage Arguments Details Value References Examples

View source: R/random.R

Description

Random number generation from the multivariate Slash distribution.

Usage

1
2
rmslash(n = 1, center = rep(0, nrow(Scatter)), Scatter = diag(length(center)),
  df = 2)

Arguments

n

the number of samples requested

center

a vector giving the locations of each variable

Scatter

a positive-definite dispersion matrix

df

degrees of freedom (positive, maybe non-integer)

Details

The function rmslash is an interface to C routines, which make calls to subroutines from LAPACK. The matrix decomposition is internally done using the Cholesky decomposition. If Scatter is not non-negative definite then there will be a warning message.

Value

If n = 1 a vector of the same length as center, otherwise a matrix of n rows of random vectors.

References

Devroye, L. (1986). Non-Uniform Random Variate Generation. Springer-Verlag, New York.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# dispersion parameters
Scatter <- matrix(c(10,3,3,2), ncol = 2)
Scatter

# generate the sample
y <- rmslash(n = 1000, Scatter = Scatter)

# scatterplot of a random bivariate slash sample with center
# vector zero and scale matrix 'Scatter'
par(pty = "s")
plot(y, xlab = "", ylab = "")
title("bivariate slash sample (df = 2)", font.main = 1)

Example output

     [,1] [,2]
[1,]   10    3
[2,]    3    2

heavy documentation built on Oct. 30, 2019, 9:48 a.m.

Related to rmslash in heavy...