RandomChisqArray-class: DelayedArray of random chi-squared-distributed values

Description Usage Arguments Value Author(s) See Also Examples

Description

A DelayedArray subclass that performs on-the-fly sampling of chi-squared-distributed values.

Usage

1
2
3
4
5
6
RandomChisqArraySeed(dim, df, ncp = 0, chunkdim = NULL)

## S4 method for signature 'RandomChisqArraySeed'
DelayedArray(seed)

RandomChisqArray(dim, df, ncp = 0, chunkdim = NULL)

Arguments

dim

Integer vector of positive length, specifying the dimensions of the array.

df, ncp

Numeric vector used as the argument of the same name in qchisq. Alternatively, a numeric array-like object with the same dimensions as dim.

chunkdim

Integer vector of length equal to dim, containing the dimensions of each chunk.

seed

A RandomChisqArraySeed object.

Value

All constructors return an instance of a RandomChisqArray object, containing random draws from a chi-squared distribution with the specified parameters.

Author(s)

Aaron Lun

See Also

The RandomArraySeed class, for details on chunking and the distributional parameters.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
X <- RandomChisqArraySeed(c(1e5, 1e5), df=5)
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomChisqArraySeed(c(1e5, 1e5), df=runif(1e5)*20)
Y2 <- DelayedArray(X2)
Y2

# Using another array as input:
library(Matrix)
df <- rsparsematrix(1e5, 1e5, density=0.00001)
df <- abs(DelayedArray(df) + 1) * 10
X3 <- RandomChisqArraySeed(c(1e5, 1e5), df=df)
Y3 <- DelayedArray(X3)
Y3

LTLA/DelayedRandomArray documentation built on Dec. 18, 2021, 3:40 a.m.