RandomNormArray-class: DelayedArray of random normal values

Description Usage Arguments Value Author(s) See Also Examples

Description

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

Usage

1
2
3
4
5
6
RandomNormArraySeed(dim, mean = 0, sd = 1, chunkdim = NULL)

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

RandomNormArray(dim, mean = 0, sd = 1, chunkdim = NULL)

Arguments

dim

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

mean, sd

Numeric vector used as mean and sd, respectively, in qnorm. 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 RandomNormArraySeed object.

Value

All constructors return an instance of a RandomNormArray object, containing random draws from a normal 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
X <- RandomNormArraySeed(c(1e5, 1e5))
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomNormArraySeed(c(1e5, 1e5), mean=runif(1e5), sd=runif(1e5))
Y2 <- DelayedArray(X2)
Y2

# Using another array as input:
library(Matrix)
mean <- rsparsematrix(1e5, 1e5, density=0.00001)
X3 <- RandomNormArraySeed(c(1e5, 1e5), mean=mean)
Y3 <- DelayedArray(X3)
Y3

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