RandomLogisArray-class: DelayedArray of random log-normal values

RandomLogisArray-classR Documentation

DelayedArray of random log-normal values

Description

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

Usage

RandomLogisArraySeed(dim, location = 0, scale = 1, chunkdim = NULL)

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

RandomLogisArray(dim, location = 0, scale = 1, chunkdim = NULL)

Arguments

dim

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

location, scale

Numeric vector used as the argument of the same name in qlogis. 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 RandomLogisArraySeed object.

Value

All constructors return an instance of a RandomLogisArray object, containing random draws from a log-normal distribution with the specified parameters.

Author(s)

Aaron Lun

See Also

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

Examples

X <- RandomLogisArraySeed(c(1e5, 1e5))
Y <- DelayedArray(X)
Y

# Fiddling with the distribution parameters:
X2 <- RandomLogisArraySeed(c(1e5, 1e5), location=runif(1e5), scale=runif(1e5))
Y2 <- DelayedArray(X2)
Y2

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


LTLA/DelayedRandomArray documentation built on July 7, 2024, 12:39 p.m.