IG.Num.OptimizationDataBase Class Reference

Base class for holding information about optimization data and algorithm parameters. More...

Inheritance diagram for IG.Num.OptimizationDataBase:

Collaboration diagram for IG.Num.OptimizationDataBase:

Protected Attributes
int	_numParameters = -1
int	_numObjectives = -1
int	_numConstraints = -1
int	_numEqualityConstraints = -1
bool	_copyReferences = false
IVector	_initialGuess
IVector	_initialStep
double	_tolerance = 0.0
int	_maxIterations = 0
int	_maxAnalyses = 0

Properties
int	NumParameters [get, set]
	Number of parameters. More...
int	NumObjectives [get, set]
	Number of objective functions (normally 1 for this type, but can be 0). More...
int	NumConstraints [get, set]
	Number of constraints. More...
int	NumEqualityConstraints [get, set]
	Number of equality constraints. More...
virtual bool	CopyReferences [get, set]
	Indicates whether just references can be copied when setting optimization parameters or results. If false then deep copy is always be performed. Default is false. More...
IVector	InitialGuess [get, set]
	Gets or sets initial guess used in optimization. More...
IVector	InitialStep [get, set]
	Gets or sets initial step used in optimization. More...
double	Tolerance [get, set]
	Gets or sets the main tolerance (its exact meaning depends on the algorithm in use). More...
int	MaxIterations [get, set]
	Gets or sets maximal number of iterations. More...
int	MaxAnalyses [get, set]
	Gets or sets maximal number of analyses. More...
Properties inherited from IG.Num.IOptimizationData
int	NumParameters [get, set]
	Number of parameters. More...
int	NumObjectives [get, set]
	Number of objective functions (normally 1 for this type, but can be 0). More...
int	NumConstraints [get, set]
	Number of constraints. More...
int	NumEqualityConstraints [get, set]
	Number of equality constraints. More...
bool	CopyReferences [get, set]
	Indicates whether just references can be copied when setting optimization parameters or results or auxiliary data. If false then deep copy is always be performed. Default is false. More...
IVector	InitialGuess [get, set]
	Gets or sets initial guess used in optimization. More...
IVector	InitialStep [get, set]
	Gets or sets initial step used in optimization. More...
double	Tolerance [get, set]
	Gets or sets the main tolerance (its exact meaning depends on the algorithm in use). More...
int	MaxIterations [get, set]
	Gets or sets maximal number of iterations. More...
int	MaxAnalyses [get, set]
	Gets or sets maximal number of analyses. More...

Detailed Description

Base class for holding information about optimization data and algorithm parameters.

Properties on this kind of classes usually have public getters and setters. It is a habit to protect the whole object inside another class, and access individual components by properties and methods that can be more restrictive.

$A Igor Jan08 Jun08;

Member Data Documentation

int IG.Num.OptimizationDataBase._numParameters = -1

protected

int IG.Num.OptimizationDataBase._numObjectives = -1

protected

int IG.Num.OptimizationDataBase._numConstraints = -1

protected

int IG.Num.OptimizationDataBase._numEqualityConstraints = -1

protected

bool IG.Num.OptimizationDataBase._copyReferences = false

protected

IVector IG.Num.OptimizationDataBase._initialGuess

protected

IVector IG.Num.OptimizationDataBase._initialStep

protected

double IG.Num.OptimizationDataBase._tolerance = 0.0

protected

int IG.Num.OptimizationDataBase._maxIterations = 0

protected

int IG.Num.OptimizationDataBase._maxAnalyses = 0

protected

Property Documentation

int IG.Num.OptimizationDataBase.NumParameters

getset

Number of parameters.

int IG.Num.OptimizationDataBase.NumObjectives

getset

Number of objective functions (normally 1 for this type, but can be 0).

int IG.Num.OptimizationDataBase.NumConstraints

getset

Number of constraints.

int IG.Num.OptimizationDataBase.NumEqualityConstraints

getset

Number of equality constraints.

virtual bool IG.Num.OptimizationDataBase.CopyReferences

getset

Indicates whether just references can be copied when setting optimization parameters or results. If false then deep copy is always be performed. Default is false.

IVector IG.Num.OptimizationDataBase.InitialGuess

getset

Gets or sets initial guess used in optimization.

IVector IG.Num.OptimizationDataBase.InitialStep

getset

Gets or sets initial step used in optimization.

double IG.Num.OptimizationDataBase.Tolerance

getset

Gets or sets the main tolerance (its exact meaning depends on the algorithm in use).

int IG.Num.OptimizationDataBase.MaxIterations

getset

Gets or sets maximal number of iterations.

int IG.Num.OptimizationDataBase.MaxAnalyses

getset

Gets or sets maximal number of analyses.

---

The documentation for this class was generated from the following file:

• igbase/optimization/OptimizationInputData.cs