scenario

package

v0.0.0-...-c864ae1 Latest Latest Go to latest Published: Apr 13, 2023 License: BSD-2-Clause, BSD-3-Clause, MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/LindsayBradford/crem

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	CompressedModel = "CompressedModel"
	ModelArchive    = "ModelArchive"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BaseScenario ¶

type BaseScenario struct {
	// contains filtered or unexported fields
}

func NewBaseScenario ¶

func NewBaseScenario() *BaseScenario

func (*BaseScenario) LogHandler ¶

func (s *BaseScenario) LogHandler() logging.Logger

func (*BaseScenario) Run ¶

func (s *BaseScenario) Run() error

func (*BaseScenario) SetAnnealer ¶

func (s *BaseScenario) SetAnnealer(annealer annealing.Annealer)

func (*BaseScenario) WithObserver ¶

func (s *BaseScenario) WithObserver(observer observer.Observer) *BaseScenario

func (*BaseScenario) WithRunner ¶

func (s *BaseScenario) WithRunner(runner CallableRunner) *BaseScenario

type CallableRunner ¶

type CallableRunner interface {
	SetAnnealer(annealer annealing.Annealer)
	LogHandler() logging.Logger

	Run() error
}

var NullRunner CallableRunner = new(nullRunner)

type CallableSaver ¶

type CallableSaver interface {
	observer.Observer
	logging.Container
	SetDecompressionModel(model model.Model)
}

type OutputLevel ¶

type OutputLevel string

type ProfilingRunner ¶

type ProfilingRunner struct {
	// contains filtered or unexported fields
}

func (*ProfilingRunner) LogHandler ¶

func (runner *ProfilingRunner) LogHandler() logging.Logger

func (*ProfilingRunner) Run ¶

func (runner *ProfilingRunner) Run() error

func (*ProfilingRunner) SetAnnealer ¶

func (runner *ProfilingRunner) SetAnnealer(annealer annealing.Annealer)

func (*ProfilingRunner) ThatProfiles ¶

func (runner *ProfilingRunner) ThatProfiles(base CallableRunner) *ProfilingRunner

func (*ProfilingRunner) ToFile ¶

func (runner *ProfilingRunner) ToFile(filePath string) *ProfilingRunner

type Runner ¶

type Runner struct {
	// contains filtered or unexported fields
}

func NewRunner ¶

func NewRunner() *Runner

func (*Runner) ElapsedTime ¶

func (runner *Runner) ElapsedTime() Duration

func (*Runner) LogHandler ¶

func (runner *Runner) LogHandler() logging.Logger

func (*Runner) Run ¶

func (runner *Runner) Run() error

func (*Runner) SetAnnealer ¶

func (runner *Runner) SetAnnealer(annealer annealing.Annealer)

func (*Runner) WithLogHandler ¶

func (runner *Runner) WithLogHandler(logHandler logging.Logger) *Runner

func (*Runner) WithMaximumConcurrentRuns ¶

func (runner *Runner) WithMaximumConcurrentRuns(maxConcurrentRuns uint64) *Runner

func (*Runner) WithName ¶

func (runner *Runner) WithName(name string) *Runner

func (*Runner) WithRunNumber ¶

func (runner *Runner) WithRunNumber(runNumber uint64) *Runner

func (*Runner) WithSaver ¶

func (runner *Runner) WithSaver(saver CallableSaver) *Runner

func (*Runner) WithTearDownFunction ¶

func (runner *Runner) WithTearDownFunction(tearDown func()) *Runner

type Saver ¶

type Saver struct {
	loggers.ContainedLogger
	// contains filtered or unexported fields
}

func NewSaver ¶

func NewSaver() *Saver

func (*Saver) ObserveEvent ¶

func (s *Saver) ObserveEvent(event observer.Event)

func (*Saver) SetDecompressionModel ¶

func (s *Saver) SetDecompressionModel(modelToClone model.Model)

func (*Saver) WithLogHandler ¶

func (s *Saver) WithLogHandler(logHandler logging.Logger) *Saver

func (*Saver) WithOutputLevel ¶

func (s *Saver) WithOutputLevel(outputLevel OutputLevel) *Saver

func (*Saver) WithOutputPath ¶

func (s *Saver) WithOutputPath(outputPath string) *Saver

func (*Saver) WithOutputType ¶

func (s *Saver) WithOutputType(outputType encoding.OutputType) *Saver

type Scenario ¶

type Scenario interface {
	LogHandler() logging.Logger
	SetAnnealer(annealer annealing.Annealer)
	Run() error
}

var NullScenario Scenario = new(nullScenario)

type SpreadsheetSafeScenarioRunner ¶

type SpreadsheetSafeScenarioRunner struct {
	// contains filtered or unexported fields
}

func (*SpreadsheetSafeScenarioRunner) LogHandler ¶

func (runner *SpreadsheetSafeScenarioRunner) LogHandler() logging.Logger

func (*SpreadsheetSafeScenarioRunner) Run ¶

func (runner *SpreadsheetSafeScenarioRunner) Run() error

func (*SpreadsheetSafeScenarioRunner) SetAnnealer ¶

func (runner *SpreadsheetSafeScenarioRunner) SetAnnealer(annealer annealing.Annealer)

func (*SpreadsheetSafeScenarioRunner) ThatLocks ¶

func (runner *SpreadsheetSafeScenarioRunner) ThatLocks(base CallableRunner) *SpreadsheetSafeScenarioRunner

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
profiling

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL