R/RandomNormArray-class.R

In LTLA/DelayedRandomArray: Delayed Arrays of Random Values

#' DelayedArray of random normal values
#'
#' A \linkS4class{DelayedArray} subclass that performs on-the-fly sampling of normally distributed values.
#'
#' @param dim Integer vector of positive length, specifying the dimensions of the array.
#' @param mean,sd Numeric vector used as \code{mean} and \code{sd}, respectively, in \code{\link{qnorm}}.
#' Alternatively, a numeric array-like object with the same dimensions as \code{dim}.
#' @param chunkdim Integer vector of length equal to \code{dim}, containing the dimensions of each chunk.
#' @param seed A RandomNormArraySeed object.
#' 
#' @return 
#' All constructors return an instance of a RandomNormArray object,
#' containing random draws from a normal distribution with the specified parameters.
#'
#' @author Aaron Lun
#' 
#' @aliases
#' RandomNormArray-class
#' RandomNormArraySeed-class
#' RandomNormMatrix-class
#' sampleDistrParam,RandomNormArraySeed-method
#' sampleDistrFun,RandomNormArraySeed-method
#' matrixClass,RandomNormArray-method
#'
#' @seealso
#' The \linkS4class{RandomArraySeed} class, for details on chunking and the distributional parameters.
#' 
#' @examples
#' 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
#' 
#' @docType class
#' @name RandomNormArray-class
NULL

#' @export
#' @rdname RandomNormArray-class
RandomNormArraySeed <- function(dim, mean=0, sd=1, chunkdim=NULL) {
    new("RandomNormArraySeed", dim=dim, mean=mean, sd=sd, chunkdim=chunkdim)
}

#' @export
setMethod("sampleDistrParam", "RandomNormArraySeed", function(x) c("mean", "sd"))

#' @export
setMethod("sampleDistrFun", "RandomNormArraySeed", function(x) stats::qnorm)

#' @export
setMethod("matrixClass", "RandomNormArray", function(x) "RandomNormMatrix")

#' @export
#' @rdname RandomNormArray-class
setMethod("DelayedArray", "RandomNormArraySeed", function(seed) new_DelayedArray(seed, Class="RandomNormArray"))

#' @export
#' @rdname RandomNormArray-class
RandomNormArray <- function(dim, mean=0, sd=1, chunkdim=NULL) {
    DelayedArray(RandomNormArraySeed(dim, mean, sd, chunkdim=chunkdim))
}