IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Num::IOptimizationData Interface Reference

Information about optimization data and algorithm parameters. More...

Inheritance diagram for IG::Num::IOptimizationData:

List of all members.

Properties

int NumParameters [get, set]
 Number of parameters.
int NumObjectives [get, set]
 Number of objective functions (normally 1 for this type, but can be 0).
int NumConstraints [get, set]
 Number of constraints.
int NumEqualityConstraints [get, set]
 Number of equality constraints.
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.
IVector InitialGuess [get, set]
 Gets or sets initial guess used in optimization.
IVector InitialStep [get, set]
 Gets or sets initial step used in optimization.
double Tolerance [get, set]
 Gets or sets the main tolerance (its exact meaning depends on the algorithm in use).
int MaxIterations [get, set]
 Gets or sets maximal number of iterations.
int MaxAnalyses [get, set]
 Gets or sets maximal number of analyses.

Detailed Description

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;


Property Documentation

int IG::Num::IOptimizationData::NumParameters [get, set]

Number of parameters.

Implemented in IG::Num::OptimizationDataBase.

int IG::Num::IOptimizationData::NumObjectives [get, set]

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

Implemented in IG::Num::OptimizationDataBase.

int IG::Num::IOptimizationData::NumConstraints [get, set]

Number of constraints.

Implemented in IG::Num::OptimizationDataBase.

int IG::Num::IOptimizationData::NumEqualityConstraints [get, set]

Number of equality constraints.

Implemented in IG::Num::OptimizationDataBase.

bool IG::Num::IOptimizationData::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.

Implemented in IG::Num::OptimizationDataBase.

IVector IG::Num::IOptimizationData::InitialGuess [get, set]

Gets or sets initial guess used in optimization.

Implemented in IG::Num::OptimizationDataBase.

IVector IG::Num::IOptimizationData::InitialStep [get, set]

Gets or sets initial step used in optimization.

Implemented in IG::Num::OptimizationDataBase.

double IG::Num::IOptimizationData::Tolerance [get, set]

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

Implemented in IG::Num::OptimizationDataBase.

int IG::Num::IOptimizationData::MaxIterations [get, set]

Gets or sets maximal number of iterations.

Implemented in IG::Num::OptimizationDataBase.

int IG::Num::IOptimizationData::MaxAnalyses [get, set]

Gets or sets maximal number of analyses.

Implemented in IG::Num::OptimizationDataBase.


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events