RandomCauchyArray-class {DelayedRandomArray} | R Documentation

## DelayedArray of random Cauchy-distributed values

### Description

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

### Usage

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

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

    RandomCauchyArray(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 `qcauchy`. 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 RandomCauchyArraySeed object.

### Value

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

### Author(s)

Aaron Lun

### See Also

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

### Examples

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

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

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

[Package DelayedRandomArray version 1.2.0 Index]