Packages > pkl

pkl.Benchmark0.26.1

Overview
Properties
Methods
Classes

module pkl.Benchmark

A template for writing and running benchmarks.

Module URI:: pkl:Benchmark
Pkl version:: 0.26.1 or higher
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

iterations: UInt32

The number of benchmark iterations to run.

This value can be overridden per benchmark.
link

iterationTime: Duration

The approximate time to spend on each benchmark iteration.

This value indirectly controls the number of repetitions per iteration.

This value can be overridden per benchmark.
link

isVerbose: Boolean

Whether to report detailed results such as BenchmarkResult.samples.

This value can be overridden per benchmark.
link

microbenchmarks: Mapping<String, Microbenchmark>

Benchmarks that measure the time taken to evaluate an expression.

Mapping keys are the benchmarks' descriptive names.
link

outputBenchmarks: Mapping<String, OutputBenchmark>

Benchmarks that measure the time taken to render a module's output.

Mapping keys are the benchmarks' descriptive names.
link

parserBenchmarks: Mapping<String, ParserBenchmark>

Benchmarks that measure the time taken to parse a module's source code into an abstract syntax tree.

Mapping keys are the benchmarks' descriptive names.
link

report: BenchmarkReport

The report containing benchmark results. Typically not configured from user code.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Classes

link

abstract class

Benchmark

Common base class for benchmarks.
link

class

BenchmarkResult

The result of running a benchmark.
link

class

Microbenchmark extends Benchmark

A benchmark that measures the time taken to evaluate an expression.
link

class

OutputBenchmark extends Benchmark

A benchmark that measures the time taken to render a module's output.
link

class

ParserBenchmark extends Benchmark

A benchmark that measures the time taken to parse a module's source code.
link

class

BenchmarkReport

The results of running a module's benchmarks.