Scientist v0.2.0 Scientist.Observation

A set of functions for working with experiment observations.

A Scientist.Observation struct contains information about the execution of a given candidate, including its execution duration, value, and cleaned value.

The timestamp is recorded as the system time, and along with the duration, is reported in milliseconds.

Summary

Functions

Returns true if the observations match

Re-raises or throws the exception that occurred during observation, if any

Returns true if the observation threw or raised an exception

Creates a new observation for experiment

Returns true if the observation raised an exception

Returns true if the observation threw an exception

Functions

equivalent?(observation, other, compare \\ &Kernel.==/2)

Returns true if the observations match.

The observations will be compared using the experiment’s configured compare function.

except!(observation)

Re-raises or throws the exception that occurred during observation, if any.

except?(observation)

Returns true if the observation threw or raised an exception.

new(experiment, name, candidate)

Creates a new observation for experiment.

Evaluates candidate, capturing any exceptions raised. The observation will be cleaned using the experiment’s configured clean function.

raised?(observation)

Returns true if the observation raised an exception.

thrown?(observation)

Returns true if the observation threw an exception.