kirkpatrick

Documentation

Index

• Constants
• func ParameterSpecifications() *Specifications
• type Explorer
  • func New() *Explorer
  • func (ke *Explorer) AcceptLastChange()
  • func (ke *Explorer) AcceptOrRevertChange(acceptChange func(), revertChange func())
  • func (ke *Explorer) CoolDown()
  • func (ke *Explorer) DeepClone() explorer.Explorer
  • func (ke *Explorer) EventAttributes(eventType observer.EventType) attributes.Attributes
  • func (ke *Explorer) Initialise()
  • func (ke *Explorer) ObjectiveValue() float64
  • func (ke *Explorer) ParameterErrors() error
  • func (ke *Explorer) RevertLastChange()
  • func (ke *Explorer) SetParameters(params parameters.Map) error
  • func (ke *Explorer) SetTemperature(temperature float64) error
  • func (ke *Explorer) TearDown()
  • func (ke *Explorer) TryRandomChange()
  • func (ke *Explorer) WithModel(model model.Model) *Explorer
  • func (ke *Explorer) WithName(name string) *Explorer
  • func (ke *Explorer) WithParameters(params parameters.Map) *Explorer
• type Parameters
  • func (p *Parameters) Initialise() *Parameters

Constants

const (
	CompressedModel        = "CompressedModel"
	ObjectiveValue         = "ObjectiveValue"
	ChangeInObjectiveValue = "ChangeInObjectiveValue"
)

const (
	DecisionVariableName  = "DecisionVariable"
	OptimisationDirection = "OptimisationDirection"
)

const (
	Invalid optimisationDirection = iota
	Minimising
	Maximising
)

Functions

func ParameterSpecifications

func ParameterSpecifications() *Specifications

Types

type Explorer

type Explorer struct {
	name.NameContainer
	name.IdentifiableContainer

	model.ContainedModel
	loggers.ContainedLogger

	kirkpatrick.Coolant

	observer.SynchronousAnnealingEventNotifier
	// contains filtered or unexported fields
}

func New

func New() *Explorer

func (*Explorer) AcceptLastChange

func (ke *Explorer) AcceptLastChange()

func (*Explorer) AcceptOrRevertChange

func (ke *Explorer) AcceptOrRevertChange(acceptChange func(), revertChange func())

func (*Explorer) CoolDown

func (ke *Explorer) CoolDown()

func (*Explorer) DeepClone

func (ke *Explorer) DeepClone() explorer.Explorer

func (*Explorer) EventAttributes

func (ke *Explorer) EventAttributes(eventType observer.EventType) attributes.Attributes

func (*Explorer) Initialise

func (ke *Explorer) Initialise()

func (*Explorer) ObjectiveValue

func (ke *Explorer) ObjectiveValue() float64

func (*Explorer) ParameterErrors

func (ke *Explorer) ParameterErrors() error

func (*Explorer) RevertLastChange

func (ke *Explorer) RevertLastChange()

func (*Explorer) SetParameters

func (ke *Explorer) SetParameters(params parameters.Map) error

func (*Explorer) SetTemperature

func (ke *Explorer) SetTemperature(temperature float64) error

func (*Explorer) TearDown

func (ke *Explorer) TearDown()

func (*Explorer) TryRandomChange

func (ke *Explorer) TryRandomChange()

func (*Explorer) WithModel

func (ke *Explorer) WithModel(model model.Model) *Explorer

func (*Explorer) WithName

func (ke *Explorer) WithName(name string) *Explorer

func (*Explorer) WithParameters

func (ke *Explorer) WithParameters(params parameters.Map) *Explorer

type Parameters

type Parameters struct {
	parameters.Parameters
}

func (*Parameters) Initialise

func (p *Parameters) Initialise() *Parameters