accessors: Accessors

In memuse: Memory Estimation Utilities

Accessors

Description

Accessor methods for slots of objects of class memuse.

Usage

mu.size(x, as.is = TRUE)

mu.unit(x)

mu.prefix(x)

mu.names(x)

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

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

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

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

Arguments

x	memuse object
as.is	logical; should the size be "as-is", or converted to bytes first.

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

Examples

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

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

## End(Not run)

memuse documentation built on Feb. 16, 2023, 6:36 p.m.