Class benchmarkInstanceAbstract

constructor

• new benchmarkInstance(name): benchmarkInstance

• Parameters

  • name: string

  Returns benchmarkInstance

StaticCACHE_ENABLE

close

• close(): void

• Restores the AST previous to load().

  Returns void

compile

• compile(): undefined | File

• Compiles the current version of the benchmark that is in the AST. Requires calling .load() first.

  Returns undefined | File

execute

• execute(): processExecutor

• Executes the current version of the benchmark. Requires calling .compile() first.

  Returns processExecutor

  the ProcessExecutor used to execute this instance

getBaseFolder

• getBaseFolder(): File

• Returns File

  The base folder for all benchmark instances. Currently is a folder 'laraBenchmarks' inside the working directory.

getCompilationEngine

• getCompilationEngine(): benchmarkCompilationEngine

• Returns benchmarkCompilationEngine

  An available BenchmarkCompilationEngine that can be used to run compiled the program (implementations may vary). If used, can be used to configure the compilation.

getExecutor

• getExecutor(): processExecutor

• Returns processExecutor

  The executor that will be used to run the compiled program, can be used to configure the execution.

AbstractgetKernel

• getKernel(): LaraJoinPoint

• Returns LaraJoinPoint

  Point in the code representing the execution of the benchmark kernel, around which metrics should be measured.

getName

• getName(): string

• Returns string

  The name of this BenchmarkInstance.

isCachedAst

• isCachedAst(): boolean

• Returns boolean

load

• load(): void

• Saves the current AST and loads this benchmark into the AST.

  Returns void

setCompilationEngine

• setCompilationEngine<T>(compilationEngineProvider): void

• Type Parameters

  • T extends benchmarkCompilationEngine

  Parameters

  • compilationEngineProvider: (new (name: string) => T)
    • • new (name): T

      • Parameters

        • name: string

        Returns T

  Returns void

setExecutable

• setExecutable(executable): void

• Parameters

  • executable: File

  Returns void

test

• test(worker?, executeCode?, outputProcessor?): boolean

• Test the current instance.

  Parameters

  • worker: ((instance: benchmarkInstance) => boolean) = ...

    Function with no parameters that will be called after loading the benchmark code as AST.

    • • (instance): boolean

      • Parameters

        • instance: benchmarkInstance

        Returns boolean

  • executeCode: boolean = false

    If true, executes the code after worker is applied.
  • outputProcessor: ((executor: processExecutor) => void) = ...

    If execution is enabled, will be called after execution with the corresponding ProcessExecutor.

    • • (executor): void

      • Parameters

        • executor: processExecutor

        Returns void

  Returns boolean

  True, if finished without problems

StaticpurgeCache

• purgeCache(): void

• Clears compilation cache of all BenchmarkInstances.

  Returns void

StaticsetCache

• setCache(enable): void

• Parameters

  • enable: boolean

    If true, enables caching of parsed files. By default, caching is enabled.

  Returns void