R/size.R

In flifo: Don't Get Stuck with Stacks in R

#' @title 
#' Size of a stack
#' 
#' @description 
#' The function \code{size} returns the size of a stack, in bytes. 
#' The function \code{max_size} returns the maximum number 
#' of objects a stack can contains; this number can be changed 
#' with \code{max_size<-}. 
#' 
#' @param .stack
#' A stack. 
#' 
#' @param x
#' A stack. 
#' 
#' @param value
#' numeric. The new maximum size of the stack. 
#' 
#' @return 
#' \code{size} always returns a nonnegative numeric.  
#' \code{max_size} returns a (possibly infinite) nonnegative numeric. 
#' 
#' @export
#' 
size <- 
function(.stack)
{
  sum(sizes(.stack))
}


# not exported, since the size should be modified directly
sizes <- 
function(.stack)
{
  attr(.stack, "sizes")
}


# not exported, since the size should be modified directly
"sizes<-" <-
function(x, 
         value)
{
  attr(x, "sizes") <- value
  x
}


#' @export
#' @rdname size
#' 
max_size <- 
function(.stack)
{
  attr(.stack, "max_size")
}


#' @export
#' @rdname size
#' 
"max_size<-" <-
function(x, 
         value)
{
  attr(x, "max_size") <- value
  x
}