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: string): 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: new (
        name: string,
    ) => BenchmarkCompilationEngine,
): void
Parameters
- compilationEngineProviderFunction: new (name: string) => BenchmarkCompilationEngine
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/benchmark/BenchmarkSet.ts:25

test

test(
    worker?: ((instance: BenchmarkInstance) => boolean) | undefined,
    executeCode?: boolean | undefined,
    outputProcessor?: ((executor: ProcessExecutor) => void) | undefined,
): string[]
Test the current benchmark set.
Parameters
- worker: ((instance: BenchmarkInstance) => boolean) | undefined = ...
  Function with no parameters that will be called after loading the bencharmk code as AST.
- executeCode: boolean | undefined = false
  If true, executes the code after worker is applied.
- outputProcessor: ((executor: ProcessExecutor) => void) | undefined = ...
  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