goga

type CxInt_t func(a, b, A, B []int, prms *Parameters)

type Generator_t func(sols []*Solution, prms *Parameters, reset bool)

type Group struct {
	Ncur    int         // number of current solutions == len(All) / 2
	All     []*Solution // current and future solutions. half part is a view to Solutions
	Indices []int       // indices of current solutions
	Pairs   [][]int     // randomly selected pairs from Indices
	Metrics *Metrics    // metrics
}

type Mesh struct {
	V [][]float64 // vertices
	C [][]int     // cells
}

type Metrics struct {
	Omin   []float64     // current min ova
	Omax   []float64     // current max ova
	Fmin   []float64     // current min float
	Fmax   []float64     // current max float
	Imin   []int         // current min int
	Imax   []int         // current max int
	Fsizes []int         // front sizes
	Fronts [][]*Solution // non-dominated fronts
	// contains filtered or unexported fields
}

type MinProb_t func(f, g, h, x []float64, y []int, cpu int)

type MtInt_t func(a []int, prms *Parameters)

type ObjFunc_t func(sol *Solution, cpu int)

type Optimiser struct {

	// input
	Parameters           // input parameters
	ObjFunc    ObjFunc_t // [optional] objective function
	MinProb    MinProb_t // [optional] minimisation problem function
	CxInt      CxInt_t   // [optional] crossover function for ints
	MtInt      MtInt_t   // [optional] mutation function for ints
	Output     Output_t  // [optional] output function

	// essential
	Generator Generator_t // generate solutions
	Solutions []*Solution // current solutions
	Groups    []*Group    // [cpu] competitors per CPU. pointers to current and future solutions
	Metrics   *Metrics    // metrics

	// meshes
	Meshes [][]*Mesh // meshes for (xi,xj) points. [nflt-1][nflt] only upper diagonal entries

	// auxiliary
	Stat                   // structure holding stat data
	Nf, Ng, Nh int         // number of f, g, h functions
	F, G, H    [][]float64 // [cpu] temporary
	// contains filtered or unexported fields
}

type Output_t func(time int, sols []*Solution)

type Parameters struct {

	// sizes
	Nova int // number of objective values
	Noor int // number of out-of-range values
	Nsol int // total number of solutions
	Ncpu int // number of cpus

	// time
	Tmax  int // final time
	DtExc int // delta time for exchange
	DtOut int // delta time for output

	// options
	DEC      float64 // C-coefficient for differential evolution
	Pll      bool    // parallel
	Seed     int     // seed for random numbers generator
	GenType  string  // generation type: "latin", "halton", "rnd"
	LatinDup int     // Latin Hypercube duplicates number
	EpsH     float64 // minimum value for 'h' constraints
	Verbose  bool    // show messages
	VerbStat bool    // show messages in Stat
	VerbTime bool    // show time messages
	GenAll   bool    // generate all solutions together; i.e. not within each group/CPU
	Nsamples int     // run many samples
	BinInt   int     // flag that integers represent binary numbers if BinInt > 0; thus Nint=BinInt
	ClearFlt bool    // clear flt if corresponding int is 0
	ExcTour  bool    // use exchange via tournament
	ExcOne   bool    // use exchange one randomly
	NormFlt  bool    // normalise float values
	UseMesh  bool    // use meshes to control points movement
	Nbry     int     // number of points along boundary / per iFlt (only if UseMesh==true)

	// crossover and mutation of integers
	IntPc       float64 // probability of crossover for ints
	IntNcuts    int     // number of cuts in crossover of ints
	IntPm       float64 // probability of mutation for ints
	IntNchanges int     // number of changes during mutation of ints

	// range
	FltMin []float64 // minimum float allowed
	FltMax []float64 // maximum float allowed
	IntMin []int     // minimum int allowed
	IntMax []int     // maximum int allowed

	// derived
	Nflt   int       // number of floats
	Nint   int       // number of integers
	DelFlt []float64 // max float range
	DelInt []int     // max int range

	// extra variables not directly related to GOGA (for convenience of having a reader already)
	Strategy int  // strategy
	PlotSet1 bool // plot set of graphs 1
	PlotSet2 bool // plot set of graphs 2
	ProbNum  int  // problem number

	// for mesh method
	NumXiXjPairs  int // number of (Xi,Xj) pairs
	NumXiXjBryPts int // number of points along the boundaries of one (Xi,Xj) plane
	NumExtraSols  int // total number of extra solutions due to all (Xi,Xj) boundaries
}

type PlotParams struct {

	// output directory and filename
	DirOut string // output directory; default = "/tmp/goga"
	FnKey  string // filename key

	// auxiliary
	YfuncX  YfuncX_t // y(x) function to plot from FltMin[iFlt] to FltMax[iFlt]
	NptsYfX int      // number of points for y(x) function
	Extra   func()   // extra plotting commands

	// options
	NoF          bool      // without f(x)
	NoG          bool      // without g(x)
	NoH          bool      // without h(x)
	WithAux      bool      // plot Solution.Aux (with the same colors as g(x))
	OnlyAux      bool      // plot only Solution.Aux
	Limits       bool      // plot limits of variables in contour
	FeasibleOnly bool      // plot feasible solutions only
	WithAll      bool      // with all points
	NoFront      bool      // do not show Pareto front
	Simple       bool      // simple contour
	Npts         int       // number of points for contour
	IdxH         int       // index of h function to plot. -1 means all
	RefX         []float64 // reference x vector with the other values in case Nflt > 2
	Xrange       []float64 // to override x-range
	Yrange       []float64 // to override y-range
	ContourAt    string    // if RefX==nil, options: "minimum", "maximum", "middle", "best" (default)
	Xlabel       string    // x-axis label
	Ylabel       string    // y-axis label

	// plot arguments
	AxEqual    bool   // plot: equal scales
	ArgsLeg    *plt.A // plot: arguments for legend
	ArgsF      *plt.A // plot: f(x) function
	ArgsG      *plt.A // plot: g(x) function
	ArgsH      *plt.A // plot: h(x) function
	ArgsAux    *plt.A // plot: format for auxiliary field
	ArgsSols0  *plt.A // plot: points indicating initial solutions
	ArgsSols   *plt.A // plot: points indicating final solutions
	ArgsBest   *plt.A // plot: points indicating best solution
	ArgsFront  *plt.A // plot: points on Pareto front
	ArgsYfX    *plt.A // plot: y(x) function
	ArgsSimple *plt.A // plot: simple contours
}

type Solution struct {
	Id    int       // identifier (for debugging). future solutions have negative ids
	Fixed bool      // cannot be changed
	Ova   []float64 // objective values
	Oor   []float64 // out-of-range values
	Flt   []float64 // floats
	Int   []int     // ints

	// metrics
	WinOver   []*Solution // solutions dominated by this solution
	Nwins     int         // number of wins => current len(WinOver)
	Nlosses   int         // number of solutions dominating this solution
	FrontId   int         // Pareto front rank
	DistCrowd float64     // crowd distance
	DistNeigh float64     // closest neighbour distance
	Closest   *Solution   // closest neighbour

	// auxiliary
	Aux float64 // auxiliary data to be stored at each solution; e.g. limit state function value
	// contains filtered or unexported fields
}

type Stat struct {

	// stat
	Nfeval     int             // number of function evaluations
	SysTimes   []time.Duration // all system times for each run
	SysTimeAve time.Duration   // average of all system times
	SysTimeTot time.Duration   // total system (real/CPU) time

	// formatting data for reports
	RptName         string    // problem name
	RptFref         []float64 // reference OVAs
	RptXref         []float64 // reference flts
	RptFmin         []float64 // min OVAs for reports/graphs
	RptFmax         []float64 // max OVAs for reports/graphs
	RptFmtF         string    // format for fmin, fave and fmax
	RptFmtFdev      string    // format for fdev
	RptFmtE         string    // format for emin, eave and emax
	RptFmtEdev      string    // format for edev
	RptFmtL         string    // format for lmin, lave and lmax
	RptFmtLdev      string    // format for ldev
	RptFmtX         string    // format for x values
	RptWordF        string    // word to use for 'f'; e.g. '\beta'
	RptDesc         string    // description text
	HistFmt         string    // format in histogram
	HistDelFmin     float64   // Δf for minimum f value in histogram
	HistDelFmax     float64   // Δf for minimum f value in histogram
	HistDelEmin     float64   // Δe for minimum e value in histogram
	HistDelEmax     float64   // Δe for minimum e value in histogram
	HistDelFminZero bool      // use zero for Δf (min)
	HistDelFmaxZero bool      // use zero for Δf (max)
	HistDelEminZero bool      // use zero for Δe (min)
	HistDelEmaxZero bool      // use zero for Δe (max)
	HistNdig        int       // number of digits in histogram
	HistNsta        int       // number of stations in histogram
	HistLen         int       // number of characters (bar length) in histogram

	// RunMany: best solutions
	BestOvas      [][]float64 // best OVAs [nova][nsamples]
	BestFlts      [][]float64 // best flts [nflt][nsamples]
	BestInts      [][]int     // best ints [nint][nsamples]
	BestOfBestOva []float64   // [nova]
	BestOfBestFlt []float64   // [nflt]
	BestOfBestInt []int       // [nint]

	// RunMany: checking multi-obj problems
	F1F0_func      func(f0 float64) float64  // f1(f0) function
	F1F0_err       []float64                 // max(error(f1))
	F1F0_arcLen    []float64                 // arc-length: spreading on (f0,f1) space
	F1F0_arcLenRef float64                   // reference arc-length along f1(f0) curve
	F1F0_f0ranges  [][]float64               // ranges of f0 values to compute arc-length
	Multi_fcnErr   func(f []float64) float64 // computes Pareto-optimal front error with many OVAs
	Multi_err      []float64                 // max(error(f[i]))
	Multi_fStar    [][]float64               // reference points on Pareto front [npoints][nova]
	Multi_IGD      []float64                 // IGD metric

	// RunMany: statistics: F
	Fmin []float64 // minimum of each F [iOva]
	Fave []float64 // average of each F [iOva]
	Fmax []float64 // maximum of each F [iOva]
	Fdev []float64 // deviation of each F [iOva]

	// RunMany: statistics: E and L
	Emin float64 // minimum E
	Eave float64 // avarage E
	Emax float64 // maximum E
	Edev float64 // deviation in E
	Lmin float64 // minimum L
	Lave float64 // avarage L
	Lmax float64 // maximum L
	Ldev float64 // deviation in L

	// RunMany: statistics: IGD
	IGDmin float64 // minimum IGD
	IGDave float64 // avarage IGD
	IGDmax float64 // maximum IGD
	IGDdev float64 // deviation in IGD
}

type TexReport struct {

	// constants
	DroundCte time.Duration // constant for dround(duration) function

	// input
	Opts []*Optimiser // all optimisers

	// options
	Title        string  // title of table
	RtableNotes  string  // footnotes for table with results
	ItableNotes  string  // footnotes for table with input data
	XtableNotes  string  // footnotes for table with x values
	XtableFontSz string  // formatting string for size of text in x-values table
	TableColSep  float64 // column separation in table
	UseGeom      bool    // use TeX geometry package
	Landscape    bool    // landscape paper
	RunPDF       bool    // generate PDF
	DescHeader   string  // description header

	// title and description
	ShowNsamples    bool // show Nsamples
	ShowDescription bool // show description

	// columns: input data columns
	ShowNsol  bool // show Nsol
	ShowNcpu  bool // show Ncpu
	ShowTmax  bool // show Tmax
	ShowDtExc bool // show Dtexc
	ShowDEC   bool // show DE coefficient

	// columns: stat columns
	ShowNfeval     bool // show Nfeval
	ShowSysTimeAve bool // show SysTimeAve
	ShowSysTimeTot bool // show SysTimeTot

	// columns: results columns
	ShowFref bool // show Fref
	ShowFmin bool // show Fmin
	ShowFave bool // show Fave
	ShowFmax bool // show Fmax
	ShowFdev bool // show Fdev
	ShowX01  bool // show x[0] and x[1] in table
	ShowAllX bool // show all x values in table
	ShowXref bool // show X references as well as X values

	// columns: multi-objective columns
	ShowEmin   bool // show Emin
	ShowEave   bool // show Eave
	ShowEmax   bool // show Emax
	ShowEdev   bool // show Edev
	ShowLmin   bool // show Lmin
	ShowLave   bool // show Lave
	ShowLmax   bool // show Lmax
	ShowLdev   bool // show Ldev
	ShowIGDmin bool // show IGDmin
	ShowIGDave bool // show IGDave
	ShowIGDmax bool // show IGDmax
	ShowIGDdev bool // show IGDdev
	// contains filtered or unexported fields
}

type YfuncX_t func(x float64) float64