Class benchmarkSet`Abstract`

Represents a set of BenchmarkInstances.

Param: name

The name of this benchmark set.

Deprecated

Use javascript's builtin Set instead to build a set of BenchmarkInstances (e.g. new Set()).

Index

Constructors

Methods

_getInstancesPrivate [iterator] getInstances getName setCompilationEngine test

Constructors

constructor

new benchmarkSet(name): benchmarkSet
Parameters
- name: string
Returns benchmarkSet
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:17

Methods

`Protected` `Abstract`_getInstancesPrivate

_getInstancesPrivate(): benchmarkInstance[]
Returns benchmarkInstance[]
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:104

[iterator]

[iterator](): Generator<benchmarkInstance, void, unknown>
Generator function that automatically handles loading/closing BenchmarkInstances.

Returns Generator<benchmarkInstance, void, unknown>
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:37

getInstances

getInstances(): benchmarkInstance[]
Instances of benchmarks, according to the current configuration.

Returns benchmarkInstance[]
An array of BenchmarkInstance.
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:56

getName

getName(): string
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:21

setCompilationEngine

setCompilationEngine(compilationEngineProviderFunction): void
Parameters
- compilationEngineProviderFunction: (new (name: string) => benchmarkCompilationEngine)
  - - new (name): benchmarkCompilationEngine
    - Parameters
      name: string
      Returns benchmarkCompilationEngine
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:25

test

test(worker?, executeCode?, outputProcessor?): string[]
Test the current benchmark set.
Parameters
- worker: undefined | ((instance: benchmarkInstance) => boolean) = ...
  Function with no parameters that will be called after loading the bencharmk code as AST.
- executeCode: undefined | boolean = false
  If true, executes the code after worker is applied.
- outputProcessor: undefined | ((executor: processExecutor) => void) = ...
  If execution is enabled, will be called after execution with the corresponding ProcessExecutor.
Returns string[]
An array with the names of benchmarks that finished with problemas, or an empty array if everything was fine.
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:78