R: Terminator that stops when a performance level has been...

mlr_terminators_perf_reached {bbotk} | R Documentation

## Terminator that stops when a performance level has been reached

### Description

Class to terminate the optimization after a performance level has been hit.

### Dictionary

This Terminator can be instantiated via the dictionary mlr_terminators or with the associated sugar function `trm()`:

    mlr_terminators$get("perf_reached")
    trm("perf_reached")

### Parameters

`level`

  `numeric(1)`
  Performance level that needs to be reached, default is 0. Terminates if the performance exceeds (respective measure has to be maximized) or falls below (respective measure has to be minimized) this value.

### Super class

`bbotk::Terminator` -> `TerminatorPerfReached`

### Methods

#### Public methods

- `TerminatorPerfReached$new()`

- `TerminatorPerfReached$is_terminated()`

- `TerminatorPerfReached$clone()`

Inherited methods

- `bbotk::Terminator$format()`

- `bbotk::Terminator$print()`

#### Method `new()`

Creates a new instance of this R6 class.

##### Usage

    TerminatorPerfReached$new()

#### Method `is_terminated()`

Is `TRUE` iff the termination criterion is positive, and `FALSE` otherwise.

##### Usage

    TerminatorPerfReached$is_terminated(archive)

##### Arguments

`archive`

  (Archive).

##### Returns

`logical(1)`.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    TerminatorPerfReached$clone(deep = FALSE)

##### Arguments

`deep`

  Whether to make a deep clone.

### See Also

Other Terminator: `Terminator`, `mlr_terminators_clock_time`, `mlr_terminators_combo`, `mlr_terminators_evals`, `mlr_terminators_none`, `mlr_terminators_run_time`, `mlr_terminators_stagnation_batch`, `mlr_terminators_stagnation`, `mlr_terminators`

### Examples

    TerminatorPerfReached$new()
    trm("perf_reached")

[Package bbotk version 0.2.2 Index]