R6_par_log10: R6 class for hyperparameter on log10 scale

In CollinErickson/comparer: Compare Output and Run Time

R6 class for hyperparameter on log10 scale

Description

R6 class for hyperparameter on log10 scale

R6 class for hyperparameter on log10 scale

Super class

comparer::par_hype -> par_log10

Public fields

name

Name of the parameter, must match the input to 'eval_func'.

lower

Lower bound of the parameter

upper

Upper bound of the parameter

ggtrans

Transformation for ggplot, see ggplot2::scale_x_continuous()

Methods

Public methods

• R6_par_log10$fromraw()

• R6_par_log10$toraw()

• R6_par_log10$generate()

• R6_par_log10$isvalid()

• R6_par_log10$convert_to_mopar()

• R6_par_log10$new()

• R6_par_log10$print()

• R6_par_log10$clone()

Inherited methods

• comparer::par_hype$getseq()

---

Method fromraw()

Function to convert from raw scale to transformed scale

Usage

R6_par_log10$fromraw(x)

Arguments

x

Value of raw scale

---

Method toraw()

Function to convert from transformed scale to raw scale

Usage

R6_par_log10$toraw(x)

Arguments

x

Value of transformed scale

---

Method generate()

Generate values in the raw space based on quantiles.

Usage

R6_par_log10$generate(q)

Arguments

q

In [0,1].

---

Method isvalid()

Check if input is valid for parameter

Usage

R6_par_log10$isvalid(x)

Arguments

x

Parameter value

---

Method convert_to_mopar()

Convert this to a parameter for the mixopt R package.

Usage

R6_par_log10$convert_to_mopar(raw_scale = FALSE)

Arguments

raw_scale

Should it be on the raw scale?

---

Method new()

Create a hyperparameter with uniform distribution

Usage

R6_par_log10$new(name, lower, upper)

Arguments

name

Name of the parameter, must match the input to 'eval_func'.

lower

Lower bound of the parameter

upper

Upper bound of the parameter

---

Method print()

Print details of the object.

Usage

R6_par_log10$print(...)

Arguments

...

not used

---

Method clone()

The objects of this class are cloneable with this method.

Usage

R6_par_log10$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

p1 <- par_log10('x1', 1e-4, 1e4)
class(p1)
print(p1)

CollinErickson/comparer documentation built on Oct. 11, 2024, 10:21 p.m.