addAlgorithm: Define Algorithms for Experiments

Description Usage Arguments Value See Also

View source: R/Algorithm.R

Description

Algorithms are functions which get the codedata part as well as the problem instance (the return value of the function defined in Problem) and return an arbitrary R object.

This function serializes all components to the file system and registers the algorithm in the ExperimentRegistry.

removeAlgorithm removes all jobs from the registry which depend on the specific algorithm. reg$algorithms holds the IDs of already defined algorithms.

Usage

1
2
3

Arguments

name

[character(1)]
Unique identifier for the algorithm.

fun

[function]
The algorithm function. The static problem part is passed as “data”, the generated problem instance is passed as “instance” and the Job/Experiment as “job”. Therefore, your function must have the formal arguments “job”, “data” and “instance” (or dots ...).

If you do not provide a function, it defaults to a function which just returns the instance.

reg

[ExperimentRegistry]
Registry. If not explicitly passed, uses the last created registry.

Value

[Algorithm]. Object of class “Algorithm”.

See Also

Problem, addExperiments


batchtools documentation built on Jan. 14, 2021, 5:20 a.m.