Common Interface to Parameter Optimization Algorithms. More...

Inheritance diagram for SiMoPO.IParameterOptimization:

Public Member Functions
int	Start ()
	To trigger an optimization run, the return values are OK = 0, OPTI_ERROR_NOT_LICENSED = -1, OPTI_ERROR_TARGET_FUNCTION_NULL = -2, OPTI_ERROR_DIMENSION_OVERSIZED = -3, OPTI_ERROR_IS_RUNNING = -4, OPTI_ERROR_NO_FEASIBLE_SOLUTION = -5, OPTI_ERROR_EXCEPTION = -100 or OPTI_ERROR_ARITHMETICEXCEPTION = -101.

Properties
byte	Maximization `[get, set]`
	If TRUE the search goes for a maximum of the target function, if FALSE for a minimum.
int	Dimension `[get, set]`
	Number of parameters to be optimized.
int	Id `[get, set]`
	Id of the PO algorithm to be used with parallel computing.
double[]	OptiPara `[get]`
	Start parameters and runtime values of the parameters.
double[]	OptiParaMin `[get]`
	Minimal allowed values for the parameters.
double[]	OptiParaMax `[get]`
	Maximal allowed values for the parameters.
double[]	OptiParaStep `[get]`
	Step width for the parameters (until now only used by Simple Hill Climbing).
byte[]	OptiParaIsInvolved `[get]`
	If FALSE this parameter is not taken into optimization.
double[]	OptiParaOptimum `[get]`
	Optimal values of the parameters after an optimization run.
double	Optimum `[get]`
	Target function value after an optimization run.
byte	InfeasibleSolution `[get, set]`
	If hill climbing parameters are set to RandomizeStartParam and hill climbing property RandomPopulationSize is greater than zero the target function must set this flag if the solution is infeasible (and reset if feasible), with genetic algorithms this parameter has no meaning yet.
byte	BreakOptimization `[get, set]`
	To break an optimization run.
byte	HaltOptimization `[get, set]`
	To halt an optimization run, as a handshake the optimization sets BreakOptimization, which has to be reset by the user.
string	LicenseKey `[get, set]`
	To input a Developer or Developer Deploy license string, when read the hardware or software license is stated.
TargetFunctionCall	TargetFunction `[get, set]`
	The target funtion is the function to be searched for an optimum according the parameters.
byte	IsRunning `[get]`
	Signals the user that an optimization run is in progress.

Detailed Description

Common Interface to Parameter Optimization Algorithms.

Member Function Documentation

◆ Start()

int SiMoPO.IParameterOptimization.Start ( )

To trigger an optimization run, the return values are OK = 0, OPTI_ERROR_NOT_LICENSED = -1, OPTI_ERROR_TARGET_FUNCTION_NULL = -2, OPTI_ERROR_DIMENSION_OVERSIZED = -3, OPTI_ERROR_IS_RUNNING = -4, OPTI_ERROR_NO_FEASIBLE_SOLUTION = -5, OPTI_ERROR_EXCEPTION = -100 or OPTI_ERROR_ARITHMETICEXCEPTION = -101.

Property Documentation

◆ BreakOptimization

byte SiMoPO.IParameterOptimization.BreakOptimization

getset

To break an optimization run.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ Dimension

int SiMoPO.IParameterOptimization.Dimension

getset

Number of parameters to be optimized.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ HaltOptimization

byte SiMoPO.IParameterOptimization.HaltOptimization

getset

To halt an optimization run, as a handshake the optimization sets BreakOptimization, which has to be reset by the user.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ Id

int SiMoPO.IParameterOptimization.Id

getset

Id of the PO algorithm to be used with parallel computing.

Default value is 0

Referenced by SiMoPO.GA.GeneticAlgorithmsFactory.Create(), and SiMoPO.HC.HillClimbingAlgorithmsFactory.Create().

◆ InfeasibleSolution

byte SiMoPO.IParameterOptimization.InfeasibleSolution

getset

If hill climbing parameters are set to RandomizeStartParam and hill climbing property RandomPopulationSize is greater than zero the target function must set this flag if the solution is infeasible (and reset if feasible), with genetic algorithms this parameter has no meaning yet.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ IsRunning

byte SiMoPO.IParameterOptimization.IsRunning

get

Signals the user that an optimization run is in progress.

◆ LicenseKey

string SiMoPO.IParameterOptimization.LicenseKey

getset

To input a Developer or Developer Deploy license string, when read the hardware or software license is stated.

◆ Maximization

byte SiMoPO.IParameterOptimization.Maximization

getset

If TRUE the search goes for a maximum of the target function, if FALSE for a minimum.

Default value is TRUE

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ Optimum

double SiMoPO.IParameterOptimization.Optimum

get

Target function value after an optimization run.

◆ OptiPara

double [] SiMoPO.IParameterOptimization.OptiPara

get

Start parameters and runtime values of the parameters.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ OptiParaIsInvolved

byte [] SiMoPO.IParameterOptimization.OptiParaIsInvolved

get

If FALSE this parameter is not taken into optimization.

Default values are TRUE

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ OptiParaMax

double [] SiMoPO.IParameterOptimization.OptiParaMax

get

Maximal allowed values for the parameters.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ OptiParaMin

double [] SiMoPO.IParameterOptimization.OptiParaMin

get

Minimal allowed values for the parameters.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ OptiParaOptimum

double [] SiMoPO.IParameterOptimization.OptiParaOptimum

get

Optimal values of the parameters after an optimization run.

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ OptiParaStep

double [] SiMoPO.IParameterOptimization.OptiParaStep

get

Step width for the parameters (until now only used by Simple Hill Climbing).

Referenced by SiMoPO.GA.IGeneticAlgorithms.StartRaw(), SiMoPO.HC.IHillClimbingAlgorithms.StartRaw(), and SiMoPO.GA.IGeneticAlgorithms.StartRaw101().

◆ TargetFunction

TargetFunctionCall SiMoPO.IParameterOptimization.TargetFunction

getset

The target funtion is the function to be searched for an optimum according the parameters.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Start()

Property Documentation

◆ BreakOptimization

◆ Dimension

◆ HaltOptimization

◆ Id

◆ InfeasibleSolution

◆ IsRunning

◆ LicenseKey

◆ Maximization

◆ Optimum

◆ OptiPara

◆ OptiParaIsInvolved

◆ OptiParaMax

◆ OptiParaMin

◆ OptiParaOptimum

◆ OptiParaStep

◆ TargetFunction