optimization

type Bound struct {
	From int `json:"from"`
	To   int `json:"to"`
}

type ConfigModifier func(int)

type Cost = float64

type CostFunction func(ctx context.Context) (Cost, error)

type InitStrategy int8

type ParameterDescription struct {
	Bound          *Bound         `json:"bound"`
	ConfigModifier ConfigModifier `json:"-"`
	Name           string         `json:"name"`
}

type ParameterValue struct {
	Name  string
	Value int
}

type Report struct {
	Cost            Cost              `json:"cost"`    // Discovered optimal value of a CostFunction
	Optimum         []*ParameterValue `json:"optimum"` // Parameter values matching the optimum point
	Iterations      int               `json:"iterations"`
	Evaluations     int               `json:"evaluations"`
	FastEvaluations int               `json:"fast_evaluations"`
}

type Settings struct {
	// RootDir - place to store reports and other things
	// (optimizer will create it if it doesn't exist).
	RootDir string
	// CostFunction itself
	CostFunction CostFunction
	// Arguments of a CostFunctions
	Parameters []*ParameterDescription
	// RBFOpt: limits number of evaluations
	MaxEvaluations uint
	// RBFOpt: limits number of iterations
	MaxIterations uint
	// RBFOpt: reason: https://github.com/coin-or/rbfopt/issues/28
	InvalidParameterCombinationCost Cost
	// Set to true if you don't want to see large values corresponding to the ErrInvalidParametersCombination on your plots
	SkipInvalidParameterCombinationOnPlots bool
	// Strategy to select initial points.
	InitStrategy InitStrategy
}