1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
# This is mostly a copy of https://github.com/r-lib/fs/blob/0f5b6191935fe4c862d2e5003655e6c1669f4afd/R/fs_bytes.R
# If I end up needing this in a third package it should probably live in a package somewhere, maybe prettyunits?
byte_units <- c(
'B' = 1,
'K' = 1024,
'M' = 1024^2,
'G' = 1024^3,
'T' = 1024^4,
'P' = 1024^5,
'E' = 1024^6,
'Z' = 1024^7,
'Y' = 1024^8
)
#' Human readable memory sizes
#'
#' Construct, manipulate and display vectors of byte sizes. These are numeric
#' vectors, so you can compare them numerically, but they can also be compared
#' to human readable values such as '10MB'.
#'
#' These memory sizes are always assumed to be base 1024, rather than 1000.
#'
#' @param x A numeric or character vector. Character representations can use
#' shorthand sizes (see examples).
#' @examples
#' bench_bytes("1")
#' bench_bytes("1K")
#' bench_bytes("1Kb")
#' bench_bytes("1KiB")
#' bench_bytes("1MB")
#'
#' bench_bytes("1KB") < "1MB"
#'
#' sum(bench_bytes(c("1MB", "5MB", "500KB")))
#' @name bench_bytes
#' @export
as_bench_bytes <- function(x) {
UseMethod("as_bench_bytes")
}
#' @export
#' @rdname bench_bytes
bench_bytes <- as_bench_bytes
new_bench_bytes <- function(x) {
structure(x, class = c("bench_bytes", "numeric"))
}
setOldClass(c("bench_bytes", "numeric"), numeric())
#' @export
as_bench_bytes.default <- function(x) {
x <- as.character(x)
m <- captures(
x,
regexpr(
"^(?<size>[[:digit:].]+)\\s*(?<unit>[KMGTPEZY]?)i?[Bb]?$",
x,
perl = TRUE
)
)
m$unit[m$unit == ""] <- "B"
new_bench_bytes(unname(as.numeric(m$size) * byte_units[m$unit]))
}
#' @export
as_bench_bytes.bench_bytes <- function(x) {
return(x)
}
#' @export
as_bench_bytes.numeric <- function(x) {
new_bench_bytes(x)
}
# Adapted from https://github.com/gaborcsardi/prettyunits
#' @export
format.bench_bytes <- function(
x,
scientific = FALSE,
digits = 3,
drop0trailing = TRUE,
...
) {
nms <- names(x)
bytes <- unclass(x)
unit <- vcapply(x, find_unit, byte_units)
res <- round(bytes / byte_units[unit], digits = digits)
## Zero bytes
res[bytes == 0] <- 0
unit[bytes == 0] <- "B"
## NA and NaN bytes
res[is.na(bytes)] <- NA_real_
res[is.nan(bytes)] <- NaN
unit[is.na(bytes)] <- "" # Includes NaN as well
# Append an extra B to each unit
large_units <- unit %in% names(byte_units)[-1]
unit[large_units] <- paste0(unit[large_units], "B")
res <- format(
res,
scientific = scientific,
digits = digits,
drop0trailing = drop0trailing,
...
)
stats::setNames(paste0(res, unit), nms)
}
#' @export
as.character.bench_bytes <- format.bench_bytes
#' @export
print.bench_bytes <- function(x, ...) {
print(format.bench_bytes(x, ...), quote = FALSE)
}
#' @export
sum.bench_bytes <- function(x, ...) {
new_bench_bytes(NextMethod())
}
#' @export
min.bench_bytes <- function(x, ...) {
new_bench_bytes(NextMethod())
}
#' @export
max.bench_bytes <- function(x, ...) {
new_bench_bytes(NextMethod())
}
#' @export
`[.bench_bytes` <- function(x, i) {
new_bench_bytes(NextMethod("["))
}
#' @export
`[[.bench_bytes` <- function(x, i) {
new_bench_bytes(NextMethod("[["))
}
#' @export
# Adapted from Ops.numeric_version
Ops.bench_bytes <- function(e1, e2) {
if (nargs() == 1L) {
stop(
sprintf("unary '%s' not defined for \"bench_bytes\" objects", .Generic),
call. = FALSE
)
}
boolean <- switch(
.Generic,
`+` = TRUE,
`-` = TRUE,
`*` = TRUE,
`/` = TRUE,
`^` = TRUE,
`<` = TRUE,
`>` = TRUE,
`==` = TRUE,
`!=` = TRUE,
`<=` = TRUE,
`>=` = TRUE,
FALSE
)
if (!boolean) {
stop(
sprintf("'%s' not defined for \"bench_bytes\" objects", .Generic),
call. = FALSE
)
}
e1 <- as_bench_bytes(e1)
e2 <- as_bench_bytes(e2)
NextMethod(.Generic)
}
#' @export
pillar_shaft.bench_bytes <- function(x, ...) {
pillar::new_pillar_shaft_simple(format.bench_bytes(x), align = "right", ...)
}
#' @export
type_sum.bench_bytes <- function(x) {
"bch:byt"
}
#' Benchmark time transformation
#'
#' This both log transforms the times and formats the labels as a `bench_time`
#' object.
#' @inheritParams bench_time_trans
#' @keywords internal
#' @export
bench_bytes_trans <- function(base = 2) {
if (is.null(base)) {
return(
scales::trans_new(
name = "bch:byt",
transform = as.numeric,
inverse = as_bench_bytes,
breaks = scales::pretty_breaks(),
domain = c(1e-100, Inf)
)
)
}
trans <- function(x) log(as.numeric(x), base)
inv <- function(x) as_bench_bytes(base^as.numeric(x))
scales::trans_new(
name = paste0("bch:byt-", format(base)),
transform = trans,
inverse = inv,
breaks = scales::log_breaks(base = base),
domain = c(1e-100, Inf)
)
}
# Lazily registered in `.onLoad()`
scale_type.bench_bytes <- function(x) "bench_bytes"
#' Position scales for bench_time data
#'
#' Default scales for the `bench_time` class, these are added to plots using
#' `bench_time` objects automatically.
#' @name scale_bench_time
#' @keywords internal
#' @export
scale_x_bench_bytes <- function(base = 10, ...) {
ggplot2::scale_x_continuous(..., transform = bench_bytes_trans(base = base))
}
#' @rdname scale_bench_time
#' @keywords internal
#' @export
scale_y_bench_bytes <- function(base = 10, ...) {
ggplot2::scale_y_continuous(..., transform = bench_bytes_trans(base = base))
}
|