R/utils.R

In coolbutuseless/minitypes: Vector Type Conversions

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' Relative sizes of types compared to 'raw'
#'
#' @export
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
relative_size <- c(
  raw       = 1,
  uint8     = 1,
  uint16    = 2,
  uint24    = 3,
  int8      = 1,
  int16     = 2,
  int24     = 3,
  int32     = 4,
  hex8      = 1,
  hex16     = 2,
  hex24     = 3,
  utf8      = 1,
  chr       = 1,
  bit       = 1/8,
  logical   = 1/8,
  bitstring = 1/8
)


#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' Get the number of bytes in a vector of the given type
#'
#' @param vec vector of values
#' @param type type of values
#'
#' @return Number of bytes in the vector
#' @export
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
nbytes <- function(vec, type) {
  nelems(vec, type) * relative_size[[type]]
}


#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' Tidy bitstring e.g. remove spaces
#'
#' @param bitstring bitstring
#' @return bitstring with spaces removed
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
tidy_bitstring <- function(bitstring) {
  gsub("\\s", "", bitstring)
}


#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' Return the number of elements in a vector of values of the given type
#'
#' @param values values
#' @param type type
#'
#' @return length
#'
#' @export
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
nelems <- function(values, type) {
  if (type == 'bitstring') {
    nchar(tidy_bitstring(values))
  } else if (type %in% c('chr', 'utf8')) {
    nchar(values)
  } else {
    length(values)
  }
}