R: Accessors

Accessors {memuse} | R Documentation

## Accessors

### Description

Accessor methods for slots of objects of class `memuse`.

### Usage

    size(x, as.is = TRUE)

    unit(x)

    unit.prefix(x)

    unit.names(x)

    ## S4 method for signature 'memuse'
    size(x, as.is = TRUE)

    ## S4 method for signature 'memuse'
    unit(x)

    ## S4 method for signature 'memuse'
    unit.prefix(x)

    ## S4 method for signature 'memuse'
    unit.names(x)

### Arguments

`x` | memuse object
`as.is` | logical; should the size be "as-is", or converted to bytes first.
`...` | Additional arguments; in this case, they are ignored.

### Details

These methods are mostly just syntactic sugar for ordinary S4 slot accessing. So for example, `size(x)` is no different semantically from calling `x@size`.

There are two differences, however. The `size()` method has a parameter `as.is` which controls whether the return should be the raw value or the raw value converted to bytes first. For the latter, you should really use `as.numeric` instead, which is equivalent to calling `size(x, as.is=FALSE)`.

### Value

Returns a numeric value in the case of `size()`, and `as.numeric()`, otherwise a string is returned.

### See Also

`memuse-class Replacers`

### Examples

    ## Not run:
    x <- mu(1e6)

    size(x)
    as.numeric(x)
    unit(x)
    unit.prefix(x)
    unit.names(x)

    ## End(Not run)

[Package memuse version 3.0-1 Index]