knitr::opts_chunk$set( collapse = TRUE, comment = "#>" ) options("digits"=3) library(doBy) library(microbenchmark) #devtools::load_all()
section_fun()The section_fun utility in doBy creates a new function by fixing some arguments of an existing function. The result is a section of the original function, defined only on the remaining arguments.
For example, if you have:
$$ f(x,y) = x + y $$
then fixing $x=10$ yields:
$$ f_x(y) = 10 + y $$
In R terms, section_fun lets you programmatically create such specialized versions.
section_fun workssection_fun() offers three ways to fix arguments:
Example:
fun <- function(a, b, c=4, d=9) { a + b + c + d }
fun_def <- section_fun(fun, list(b=7, d=10)) fun_def fun_body <- section_fun(fun, list(b=7, d=10), method="sub") fun_body fun_env <- section_fun(fun, list(b=7, d=10), method = "env") fun_env
You can inspect the environment-based section:
get_section(fun_env) ## same as: attr(fun_env, "arg_env")$args get_fun(fun_env) ## same as: environment(fun_env)$fun
Example evaluations:
fun(a=10, b=7, c=5, d=10) fun_def(a=10, c=5) fun_body(a=10, c=5) fun_env(a=10, c=5)
Suppose you want to benchmark a function for different input values without writing repetitive code:
inv_toep <- function(n) { solve(toeplitz(1:n)) }
Instead of typing the following
microbenchmark( inv_toep(4), inv_toep(8), inv_toep(16), times=3 )
you can create specialized versions programmatically:
n.vec <- c(4, 8, 16) fun_list <- lapply(n.vec, function(ni) { section_fun(inv_toep, list(n=ni)) }) fun_list
Inspect and evaluate:
fun_list[[1]]
fun_list[[1]]()
To use with microbenchmark, we need expressions:
bquote_list <- function(fun_list) { lapply(fun_list, function(g){ bquote(.(g)()) }) }
We get:
bq_fun_list <- bquote_list(fun_list) bq_fun_list bq_fun_list[[1]] eval(bq_fun_list[[1]])
Now run:
microbenchmark( list = bq_fun_list, times = 5 )
Running the code below provides a benchmark of the different ways of sectioning in terms of speed.
n.vec <- seq(20, 80, by=20) fun_def <- lapply(n.vec, function(n){ section_fun(inv_toep, list(n=n), method="def") }) fun_body <- lapply(n.vec, function(n){ section_fun(inv_toep, list(n=n), method="sub") }) fun_env <- lapply(n.vec, function(n){ section_fun(inv_toep, list(n=n), method="env") }) names(fun_def) <- paste0("def", n.vec) names(fun_body) <- paste0("body", n.vec) names(fun_env) <- paste0("env", n.vec) bq_fun_list <- bquote_list(c(fun_def, fun_body, fun_env)) bq_fun_list |> head() mb <- microbenchmark( list = bq_fun_list, times = 2 ) mb
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.