IGLib  1.7.2
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Num.AnalysisBase Class Referenceabstract

Base class for direct analysis classes that define optimization problems. Represent the complete definition of the optimization problem (without initial parameters). Concrete analysis classes (e.g. representing optimization examples or complex direct problems solved through numerical simulation) should be derived from this class. More...

+ Inheritance diagram for IG.Num.AnalysisBase:
+ Collaboration diagram for IG.Num.AnalysisBase:

Public Member Functions

abstract void Analyse (IAnalysisResults analysisData)
 Performs analysis - calculates requested results and writes them to the provided data structure. More...
 

Protected Attributes

int _numParameters = -1
 
int _numObjectives = -1
 
int _numConstraints = -1
 
int _numEqualityConstraints = -1
 

Properties

object Lock [get]
 
virtual int NumParameters [get, set]
 Number of parameters. More...
 
virtual int NumObjectives [get, set]
 Number of objective functions (normally 1 for this type, but can be 0). More...
 
virtual int NumConstraints [get, set]
 Number of constraints. More...
 
virtual int NumEqualityConstraints [get, set]
 Number of equality constraints. More...
 
- Properties inherited from IG.Num.IAnalysis
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...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Private Attributes

object _lock = new object()
 

Detailed Description

Base class for direct analysis classes that define optimization problems. Represent the complete definition of the optimization problem (without initial parameters). Concrete analysis classes (e.g. representing optimization examples or complex direct problems solved through numerical simulation) should be derived from this class.

$A Igor May08 Jun10;

Member Function Documentation

abstract void IG.Num.AnalysisBase.Analyse ( IAnalysisResults  analysisData)
pure virtual

Performs analysis - calculates requested results and writes them to the provided data structure.

Parameters
analysisDataData structure where analysis request parameters are obtained and where analysis results are written.

Implements IG.Num.IAnalysis.

Implemented in IG.Lib.LoadableScriptOptBase.AnalysisScript.

Member Data Documentation

object IG.Num.AnalysisBase._lock = new object()
private
int IG.Num.AnalysisBase._numParameters = -1
protected
int IG.Num.AnalysisBase._numObjectives = -1
protected
int IG.Num.AnalysisBase._numConstraints = -1
protected
int IG.Num.AnalysisBase._numEqualityConstraints = -1
protected

Property Documentation

object IG.Num.AnalysisBase.Lock
get
virtual int IG.Num.AnalysisBase.NumParameters
getset

Number of parameters.

virtual int IG.Num.AnalysisBase.NumObjectives
getset

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

virtual int IG.Num.AnalysisBase.NumConstraints
getset

Number of constraints.

virtual int IG.Num.AnalysisBase.NumEqualityConstraints
getset

Number of equality constraints.


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