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 | |
ResponseEvaluatorWithStorageVector () | |
Creates a ResponseEvaluatorAnalysis object. More... | |
ResponseEvaluatorWithStorageVector (IVectorFunction evaluationFunction) | |
Creates a ResponseEvaluatorAnalysis object with the specified response evaluator (analysis object) that will be used for response evaluation. More... | |
virtual void | CopyFromDto< TypeResponseEvaluator > (ResponseEvaluatorWithStorageVectorDtoBase< 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 (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 (VectorFunctionResults 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 VectorFunctionResults | CopyResults (VectorFunctionResults results) |
Creates and returns a copy of the speccified results object. More... | |
override void | CreateRequestThis (IVector parameters, ref VectorFunctionResults ret) |
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 (VectorFunctionResults requestAndResponse) |
Evaluates the response. More... | |
![]() | |
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 = -1 |
int | _numValues = -1 |
bool | _valuesDefined = true |
bool | _derivativeDefined = false |
bool | _secondDerivativeDefined = true |
bool | _componentEvaluation = false |
bool | _reqvalues = true |
bool | _reqGradients = false |
bool | _reqHessians = false |
Properties | |
override IVectorFunction | EvaluationObject [get, set] |
Analysis object that is actually used for evaluation of response. More... | |
virtual int | NumParameters [get, protected set] |
Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters). More... | |
virtual int | NumFunctions [get, protected set] |
Gets number of values of the current vector function (-1 for not defined, e.g. in case that function works with different numbers of parameters and number of functions depends on number of parameters). More... | |
virtual bool | ValueDefined [get, protected set] |
Tells whether value of the function is defined by implementation. More... | |
virtual bool | DerivativeDefined [get, protected set] |
Tells whether the first derivative is defined for this function (by implementation, not mathematically) More... | |
virtual bool | SecondDerivativeDefined [get, protected set] |
Tells whether the second derivative is defined for this function (by implementation, not mathematically) More... | |
virtual bool | ReqValues [get, set] |
Indicates whether calculation of functions is requested. More... | |
virtual bool | ReqGradients [get, set] |
Indicates whether calculation of function gradients is requested. More... | |
virtual bool | ReqHessians [get, set] |
Indicates whether calculation of functions' Hessians is 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 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] |
![]() | |
object | Lock [get] |
Private Attributes | |
IVectorFunction | _vectorFunction |
Base class for response evaluators where response is evaluated by objects of type IAnalysis .
$A Igor Dec10;
|
inline |
Creates a ResponseEvaluatorAnalysis object.
|
inline |
Creates a ResponseEvaluatorAnalysis object with the specified response evaluator (analysis object) that will be used for response evaluation.
evaluationFunction | 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.VectorFunctionResults.NumFunctions, IG.Num.VectorFunctionResults.NumParameters, IG.Num.VectorFunctionResults.ReqGradients, IG.Num.VectorFunctionResults.ReqHessians, and IG.Num.VectorFunctionResults.ReqValues.
|
inlineprotected |
Creates and returns a copy of the speccified results object.
results | Results object to be copied. |
References IG.Num.VectorFunctionResults.GetCopy().
|
inlineprotected |
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. |
results | Reference to the object where request data for response evaluation is written to.</para |
References IG.Num.IVector.GetCopy(), IG.Num.VectorFunctionResults.NumFunctions, IG.Num.VectorFunctionResults.NumParameters, IG.Num.VectorFunctionResults.Parameters, IG.Num.VectorFunctionResults.ReqGradients, IG.Num.VectorFunctionResults.ReqHessians, and IG.Num.VectorFunctionResults.ReqValues.
|
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 | : | ResponseEvaluatorWithStorageVector |
References IG.Num.ResponseEvaluatorWithStorageVector.NumParameters.
|
private |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
getset |
Analysis object that is actually used for evaluation of response.
|
getprotected set |
Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters).
Referenced by IG.Num.ResponseEvaluatorWithStorageVector.CopyFromDto< TypeResponseEvaluator >(), and IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Gets number of values of the current vector function (-1 for not defined, e.g. in case that function works with different numbers of parameters and number of functions depends on number of parameters).
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Tells whether value of the function is defined by implementation.
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Tells whether the first derivative is defined for this function (by implementation, not mathematically)
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getprotected set |
Tells whether the second derivative is defined for this function (by implementation, not mathematically)
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of functions is requested.
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of function gradients is requested.
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().
|
getset |
Indicates whether calculation of functions' Hessians is requested.
Referenced by IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyFromPlain().