IGLib
1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
|
Base class for response evaluators where response is evaluated by objects of type IAnalysis . More...
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... | |
![]() | |
ResponseEvaluatorWithStorageBase () | |
Creates a ResponseEvaluatorBase object. More... | |
ResponseEvaluatorWithStorageBase (TypeFunction 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 (TypeResults requestAndResponse) |
void | ClearResults () |
Removes all results from the list of results. The list is intended to store the results. More... | |
void | AddResult (TypeResults 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 AnalysisResults | 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... | |
override void | EvaluateResponseThis (AnalysisResults requestAndResponse) |
Evaluates the response. More... | |
![]() | |
abstract void | GetData (TypeResults results) |
Copies input data from results object. More... | |
abstract TypeResults | CopyResults (TypeResults results) |
Creates and returns a copy of the speccified results object. More... | |
abstract void | EvaluateResponseThis (TypeResults 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... | |
![]() | |
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 TypeResults | 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< TypeResults > | Results [get, protected set] |
List of calculated results. The list is intended to store the results. More... | |
virtual TypeResults | this[int which] [get, set] |
abstract TypeFunction | EvaluationObject [get, set] |
![]() | |
object | Lock [get] |
Private Attributes | |
IAnalysis | _analysis |
Base class for response evaluators where response is evaluated by objects of type IAnalysis .
$A Igor Jul08;
|
inline |
Creates a ResponseEvaluatorAnalysis object.
|
inline |
Creates a ResponseEvaluatorAnalysis object with the specified response evaluator (analysis object) that will be used for response evaluation.
analysis | Analysis object that is used for calculation of respones. |
|
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.
results | Analysis 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.
|
inlineprotected |
Creates and returns a copy of the speccified results object.
results | Results object to be copied. |
References IG.Num.AnalysisResults.Copy().
|
inlineprotectedvirtual |
Creates and returns request for response evaluation at the specified parameters, where request options are transcribed from the current response evaluator.
parameters | Vector of parameters for which response will be calculated. |
Implements IG.NumExperimental.ResponseEvaluatorWithStorageBase< TypeResults, TypeFunction >.
References IG.Num.IVector.GetCopy(), IG.Num.AnalysisResults.NumConstraints, IG.Num.AnalysisResults.NumEqualityConstraints, IG.Num.AnalysisResults.NumObjectives, IG.Num.AnalysisResults.NumParameters, IG.Num.AnalysisResults.Parameters, 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.
|
inlineprotected |
Evaluates the response.
results | Object that must contain complete response evaluation request data, and where results of response evaluation will be stored. |
|
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.
TypeResponseEvaluator | Type of response evaluator. |
Dto | DTO from which data is copied. |
TypeResponseEvaluator | : | ResponseEvaluatorWithStorageAnalysis |
References IG.NumExperimental.ResponseEvaluatorWithStorageAnalysis.NumParameters.
|
private |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
getset |
Analysis object that is actually used for evaluation of response.
|
getprotected set |
|
getprotected set |
Number of objective functions (normally 1 for this type, but can be 0).
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Number of constraints.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Number of equality constraints.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of objective function is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of objective function gradient is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of objective function Hessian is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of constraint functions is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of constraint functions gradient is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of constraint functions Hessian is/was requested.
Referenced by IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyFromPlain().