RandomGeomArray-class {DelayedRandomArray} | R Documentation

## DelayedArray of random geometric-distributed values

### Description

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

### Usage

    RandomGeomArraySeed(dim, prob, chunkdim = NULL, sparse = FALSE)

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

    RandomGeomArray(dim, prob, chunkdim = NULL, sparse = FALSE)

### Arguments

`dim` | Integer vector of positive length, specifying the dimensions of the array.
`prob` | Numeric vector used as `prob` in `qgeom`. 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.
`sparse` | Logical scalar indicating whether the sampled array should be treated as sparse.
`seed` | A RandomGeomArraySeed object.

### Value

All constructors return an instance of a RandomGeomArray object, containing random draws from a geometric distribution with the specified parameters.

### Author(s)

Aaron Lun

### See Also

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

### Examples

    X <- RandomGeomArraySeed(c(1e5, 1e5), prob=0.5)
    Y <- DelayedArray(X)
    Y

    # Fiddling with the distribution parameters:
    X2 <- RandomGeomArraySeed(c(1e5, 1e5), prob=runif(1e5, 0, 0.1), sparse=TRUE)
    Y2 <- DelayedArray(X2)
    Y2

    # Using another array as input:
    library(Matrix)
    prob <- RandomUnifArray(c(1e5, 1e5))
    X3 <- RandomGeomArraySeed(c(1e5, 1e5), prob=prob)
    Y3 <- DelayedArray(X3)
    Y3

[Package DelayedRandomArray version 1.0.0 Index]