IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Num.ResponseEvaluatorWithStorageAnalysis Class Reference

Base class for response evaluators where response is evaluated by objects of type IAnalysis . More...

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

Public Member Functions

 ResponseEvaluatorWithStorageAnalysis ()
 Creates a ResponseEvaluatorAnalysis object. More...
 
 ResponseEvaluatorWithStorageAnalysis (IAnalysis analysis)
 Creates a ResponseEvaluatorAnalysis object with the specified response evaluator (analysis object) that will be used for response evaluation. More...
 
virtual void CopyFromDto< TypeResponseEvaluator > (ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator > Dto)
 Copies some data from the corresponding Dto. This method is exposed because some properties' setters don't have public access and can therefore not be accessed from the DTO's CopyTo() method. More...
 
- Public Member Functions inherited from IG.Num.ResponseEvaluatorWithStorageBase< TypeData, TypeEvaluator >
 ResponseEvaluatorWithStorageBase ()
 Creates a ResponseEvaluatorBase object. More...
 
 ResponseEvaluatorWithStorageBase (TypeEvaluator evaluationFunction)
 Creates a ResponseEvaluatorBase object with the specified response evaluator that will be used for response evaluation. More...
 
virtual void EvaluateResponse (IVector parameters)
 Evaluates the response at specific parameters. More...
 
virtual void EvaluateResponse (TypeData requestAndResponse)
 
void ClearResults ()
 Removes all results from the list of results. The list is intended to store the results. More...
 
void AddResult (TypeData result)
 Adds a new result to the list of results. The list is intended to store the results. More...
 

Protected Member Functions

override void GetData (AnalysisResults results)
 Copies input data (problem characteristics such as number of parameters, number of contraints, etc., and analysis request flags) from the specified analysis results object. More...
 
override AnalysisResults CopyResults (AnalysisResults results)
 Creates and returns a copy of the speccified results object. More...
 
override void CreateRequestThis (IVector parameters, ref AnalysisResults request)
 Creates and returns request for response evaluation at the specified parameters, where request options are transcribed from the current response evaluator. More...
 
override void EvaluateResponseThis (AnalysisResults requestAndResponse)
 Evaluates the response. More...
 
- Protected Member Functions inherited from IG.Num.ResponseEvaluatorWithStorageBase< TypeData, TypeEvaluator >
abstract void GetData (TypeData results)
 Copies input data from results object. More...
 
abstract TypeData CopyResults (TypeData results)
 Creates and returns a copy of the speccified results object. More...
 
abstract void CreateRequestThis (IVector parameters, ref TypeData request)
 Creates a request for response evaluation at the specified parameters, where request options are transcribed from the current response evaluator. More...
 
TypeData CreateRequestThis (IVector parameters)
 Creates and returns request for response evaluation at the specified parameters, where request options are transcribed from the current response evaluator. More...
 
abstract void EvaluateResponseThis (TypeData requestAndResponse)
 Evaluates the response. More...
 

Protected Attributes

int _numParameters = 0
 
int _numObjectives = 1
 
int _numConstraints = 0
 
int _numEqualityConstraints = 0
 
bool _reqObjective = false
 
bool _reqConstraints = false
 
bool _reqObjectiveGradient = false
 
bool _reqConstraintGradients = false
 
bool _reqObjectiveHessian = false
 
bool _reqConstraintHessians = false
 

Properties

override IAnalysis EvaluationObject [get, set]
 Analysis object that is actually used for evaluation of response. More...
 
virtual int NumParameters [get, protected set]
 Number of parameters. More...
 
virtual int NumObjectives [get, protected set]
 Number of objective functions (normally 1 for this type, but can be 0). More...
 
virtual int NumConstraints [get, protected set]
 Number of constraints. More...
 
virtual int NumEqualityConstraints [get, protected set]
 Number of equality constraints. More...
 
virtual bool ReqObjective [get, set]
 Indicates whether calculation of objective function is/was requested. More...
 
virtual bool ReqObjectiveGradient [get, set]
 Indicates whether calculation of objective function gradient is/was requested. More...
 
virtual bool ReqObjectiveHessian [get, set]
 Indicates whether calculation of objective function Hessian is/was requested. More...
 
virtual bool ReqConstraints [get, set]
 Indicates whether calculation of constraint functions is/was requested. More...
 
virtual bool ReqConstraintGradients [get, set]
 Indicates whether calculation of constraint functions gradient is/was requested. More...
 
virtual bool ReqConstraintHessians [get, set]
 Indicates whether calculation of constraint functions Hessian is/was requested. More...
 
- Properties inherited from IG.Num.ResponseEvaluatorWithStorageBase< TypeData, TypeEvaluator >
object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
 
object InternalLock [get]
 Used internally for locking access to internal fields. More...
 
virtual TypeData LastResults [get, set]
 Results of the last evaluation of response performed by the current response evaluator. More...
 
virtual bool AddResultsAutomatically [get, set]
 Flag indicated whether the last evaluated results are automatically added to the list of results when these results are set (by setting the LastResults property). More...
 
List< TypeData > Results [get, protected set]
 List of calculated results. The list is intended to store the results. More...
 
virtual TypeData this[int which] [get, set]
 
abstract TypeEvaluator EvaluationObject [get, set]
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Private Attributes

IAnalysis _analysis
 

Detailed Description

Base class for response evaluators where response is evaluated by objects of type IAnalysis .

$A Igor Jul08;

Constructor & Destructor Documentation

IG.Num.ResponseEvaluatorWithStorageAnalysis.ResponseEvaluatorWithStorageAnalysis ( )
inline

Creates a ResponseEvaluatorAnalysis object.

IG.Num.ResponseEvaluatorWithStorageAnalysis.ResponseEvaluatorWithStorageAnalysis ( IAnalysis  analysis)
inline

Creates a ResponseEvaluatorAnalysis object with the specified response evaluator (analysis object) that will be used for response evaluation.

Parameters
analysisAnalysis object that is used for calculation of respones.

Member Function Documentation

override void IG.Num.ResponseEvaluatorWithStorageAnalysis.GetData ( AnalysisResults  results)
inlineprotected

Copies input data (problem characteristics such as number of parameters, number of contraints, etc., and analysis request flags) from the specified analysis results object.

Parameters
resultsAnalysis results object form which various input data is copied.

References IG.Num.AnalysisResults.NumConstraints, IG.Num.AnalysisResults.NumEqualityConstraints, IG.Num.AnalysisResults.NumObjectives, IG.Num.AnalysisResults.NumParameters, IG.Num.AnalysisResults.ReqConstraintGradients, IG.Num.AnalysisResults.ReqConstraintHessians, IG.Num.AnalysisResults.ReqConstraints, IG.Num.AnalysisResults.ReqObjective, IG.Num.AnalysisResults.ReqObjectiveGradient, and IG.Num.AnalysisResults.ReqObjectiveHessian.

override AnalysisResults IG.Num.ResponseEvaluatorWithStorageAnalysis.CopyResults ( AnalysisResults  results)
inlineprotected

Creates and returns a copy of the speccified results object.

Parameters
resultsResults object to be copied.
Returns
A copy of results object.

References IG.Num.AnalysisResults.Copy().

override void IG.Num.ResponseEvaluatorWithStorageAnalysis.CreateRequestThis ( IVector  parameters,
ref AnalysisResults  request 
)
inlineprotected

Creates and returns request for response evaluation at the specified parameters, where request options are transcribed from the current response evaluator.

Parameters
parametersVector of parameters for which response will be calculated.
Returns
Object containing complete request data for response evaluation.
Parameters
requestReference to the object where request data for response evaluation is written to.

References IG.Num.IVector.GetCopy().

override void IG.Num.ResponseEvaluatorWithStorageAnalysis.EvaluateResponseThis ( AnalysisResults  requestAndResponse)
inlineprotected

Evaluates the response.

Parameters
resultsObject that must contain complete response evaluation request data, and where results of response evaluation will be stored.
virtual void IG.Num.ResponseEvaluatorWithStorageAnalysis.CopyFromDto< TypeResponseEvaluator > ( ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >  Dto)
inlinevirtual

Copies some data from the corresponding Dto. This method is exposed because some properties' setters don't have public access and can therefore not be accessed from the DTO's CopyTo() method.

Template Parameters
TypeResponseEvaluatorType of response evaluator.
Parameters
DtoDTO from which data is copied.
Type Constraints
TypeResponseEvaluator :ResponseEvaluatorWithStorageAnalysis 

References IG.Num.ResponseEvaluatorWithStorageAnalysis.NumParameters.

Member Data Documentation

IAnalysis IG.Num.ResponseEvaluatorWithStorageAnalysis._analysis
private
int IG.Num.ResponseEvaluatorWithStorageAnalysis._numParameters = 0
protected
int IG.Num.ResponseEvaluatorWithStorageAnalysis._numObjectives = 1
protected
int IG.Num.ResponseEvaluatorWithStorageAnalysis._numConstraints = 0
protected
int IG.Num.ResponseEvaluatorWithStorageAnalysis._numEqualityConstraints = 0
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqObjective = false
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqConstraints = false
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqObjectiveGradient = false
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqConstraintGradients = false
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqObjectiveHessian = false
protected
bool IG.Num.ResponseEvaluatorWithStorageAnalysis._reqConstraintHessians = false
protected

Property Documentation

override IAnalysis IG.Num.ResponseEvaluatorWithStorageAnalysis.EvaluationObject
getset

Analysis object that is actually used for evaluation of response.

virtual int IG.Num.ResponseEvaluatorWithStorageAnalysis.NumParameters
getprotected set
virtual int IG.Num.ResponseEvaluatorWithStorageAnalysis.NumObjectives
getprotected set

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

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual int IG.Num.ResponseEvaluatorWithStorageAnalysis.NumConstraints
getprotected set
virtual int IG.Num.ResponseEvaluatorWithStorageAnalysis.NumEqualityConstraints
getprotected set
virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqObjective
getset

Indicates whether calculation of objective function is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqObjectiveGradient
getset

Indicates whether calculation of objective function gradient is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqObjectiveHessian
getset

Indicates whether calculation of objective function Hessian is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqConstraints
getset

Indicates whether calculation of constraint functions is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqConstraintGradients
getset

Indicates whether calculation of constraint functions gradient is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().

virtual bool IG.Num.ResponseEvaluatorWithStorageAnalysis.ReqConstraintHessians
getset

Indicates whether calculation of constraint functions Hessian is/was requested.

Referenced by IG.Num.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().


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