standard_test_func: Create a standard test function.

View source: R/test_func_apply.R

standard_test_funcR Documentation

Create a standard test function.

Description

This makes it easier to create many functions that follow the same template. R CMD check doesn't like the ... if this command is used to create functions in the package, so it is not currently used.

Usage

standard_test_func(
  func,
  scale_it_ = F,
  scale_low_ = NULL,
  scale_high_ = NULL,
  noise_ = 0,
  ...
)

Arguments

func

A function that takes a vector representing a single point.

scale_it_

Should the function scale the inputs from [0, 1]^D to [scale_low_, scale_high_] by default? This can be overridden when actually giving the output function points to evaluate.

scale_low_

What is the default lower bound of the data?

scale_high_

What is the default upper bound of the data?

noise_

Should noise be added to the function by default?

...

Parameters passed to func when evaluating points.

Value

A test function created using the standard_test_func template.

Examples

.gaussian1 <- function(x, center=.5, s2=.01) {
  exp(-sum((x-center)^2/2/s2))
}
gaussian1 <- standard_test_func(.gaussian1, scale_it=FALSE, scale_low = c(0,0), scale_high = c(1,1))
curve(gaussian1(matrix(x,ncol=1)))

TestFunctions documentation built on Sept. 30, 2024, 9:31 a.m.