model

Documentation

Index

• Constants
• Variables
• func NewNullModel() *nullModel
• type ContainedModel
  • func (c *ContainedModel) Model() Model
  • func (c *ContainedModel) SetModel(model Model)
• type Container
• type DecisionVariableContainer
• type InitialisationType
• type Model

Constants

const LogLevel logging.Level = "Model"

Variables

var NullModel = new(nullModel)

Functions

func NewNullModel

func NewNullModel() *nullModel

Types

type ContainedModel

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

ContainedModel is a struct offering a default implementation of ContainedLogger

func (*ContainedModel) Model

func (c *ContainedModel) Model() Model

func (*ContainedModel) SetModel

func (c *ContainedModel) SetModel(model Model)

type Container

type Container interface {
	Model() Model
	SetModel(model Model)
}

ContainedLogger defines an interface embedding a Model

type DecisionVariableContainer

type DecisionVariableContainer interface {
	NameMappedVariables() *variable.DecisionVariableMap

	DecisionVariable(name string) variable.DecisionVariable
	OffersDecisionVariable(name string) bool
	DecisionVariableChange(decisionVariableName string) float64
}

type InitialisationType

type InitialisationType int

const (
	AsIs InitialisationType = iota
	Random
	Unchanged
)

type Model

type Model interface {
	name.Nameable
	name.Identifiable
	DecisionVariableContainer

	Initialise(initialisationType InitialisationType)
	Randomize()
	TearDown()

	DoRandomChange()
	UndoChange()

	TryRandomChange()
	ChangeIsValid() (bool, *errors.CompositeError)
	AcceptChange()
	RevertChange()

	IsEquivalentTo(Model) bool
	SynchroniseTo(Model)

	DeepClone() Model

	ManagementActions() []action.ManagementAction
	ActiveManagementActions() []action.ManagementAction
	SetManagementAction(index int, value bool)
	SetManagementActionUnobserved(index int, value bool)

	PlanningUnits() planningunit.Ids
}