R/XDouble-class.R

In XVector: Foundation of external vector representation and manipulation in Bioconductor

### =========================================================================
### XDouble objects
### -------------------------------------------------------------------------
###
### The XDouble class is a container for storing an "external double
### vector" i.e. a *single* view on a SharedDouble object.
###
### IMPORTANT NOTE: Our concept/representation/implementation of "external
### vector" in general differ significantly from those found in the
### externalVector package!
###

setClass("XDouble",
    contains="XVector",
    representation(
        shared="SharedDouble"
    )
)


### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
### Initialization.
###

setMethod("initialize", "XDouble",
    function(.Object, length=0L, val=NULL)
    {
        if (!isSingleNumber(length) || length < 0)
            stop("'length' must be a single non-negative integer")
        if (!is.integer(length))
            length <- as.integer(length)
        .Object@shared <- SharedDouble(length=length, val=val)
        .Object@offset <- 0L
        .Object@length <- length
        .Object
    }
)

XDouble <- function(length=base::length(val), val=NULL)
    new2("XDouble", length=length, val=val, check=FALSE)

### Just an alias for XDouble().
XNumeric <- function(...) XDouble(...)


### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
### Coercion.
###

### From standard vectors to XDouble objects:
setAs("numeric", "XDouble", function(from) XDouble(length(from), val=from))
setAs("numeric", "XVector", function(from) as(from, "XDouble"))

### From XDouble objects to standard vectors:
setMethod("as.numeric", "XDouble",
    function(x, ...) SharedDouble.read(x@shared, x@offset + 1L, x@offset + x@length)
)
setMethod("as.vector", "XDouble",
    function(x, mode="any")
    {
        if (!identical(mode, "any"))
            stop("\"as.vector\" method for XDouble objects ",
                 "does not support the 'mode' argument")
        as.numeric(x)
    }
)