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.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator > Class Template Referenceabstract

Base class for DTOs (Data Transfer Objects) for response evaluators with storage where response is evaluated by a vector function. More...

+ Inheritance diagram for IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >:
+ Collaboration diagram for IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >:

Public Member Functions

 ResponseEvaluatorWithStorageVectorDtoBase ()
 Default constructor, sets IsNull to true. More...
 
abstract TypeResponseEvaluator CreateResponseEvaluator ()
 Creates and returns a new response evaluator of the specified type. More...
 
override TypeResponseEvaluator CreateObject ()
 Creates and returns a new response evaluator of the specified type. More...
 

Public Attributes

bool AddresultsAutomatically
 
VectorFunctionResultsDto[] Results
 
int NumParameters
 Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters). More...
 
int NumFunctions
 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...
 
bool ValueDefined
 Tells whether value of the function is defined by implementation. More...
 
bool DerivativeDefined
 Tells whether the first derivative is defined for this function (by implementation, not mathematically) More...
 
bool SecondDerivativeDefined
 Tells whether the second derivative is defined for this function (by implementation, not mathematically) More...
 
bool ReqValues
 Indicates whether calculation of functions is requested. More...
 
bool ReqGradients
 Indicates whether calculation of function gradients is requested. More...
 
bool ReqHessians
 Indicates whether calculation of functions' Hessians is requested. More...
 

Protected Member Functions

override void CopyFromPlain (ResponseEvaluatorWithStorageVector responseEvaluator)
 Copies data to the current DTO from a vector function-based response evaluator object. More...
 
override void CopyToPlain (ref ResponseEvaluatorWithStorageVector responseEvaluator)
 Copies data from the current DTO to a response evaluator object. More...
 

Detailed Description

Base class for DTOs (Data Transfer Objects) for response evaluators with storage where response is evaluated by a vector function.

Template Parameters
TypeResponseEvaluatorType parameter specifying the specific response evaluator type for which a concrete DTO is designed.

$A Igor May10;

Type Constraints
TypeResponseEvaluator :ResponseEvaluatorWithStorageVector 

Constructor & Destructor Documentation

IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.ResponseEvaluatorWithStorageVectorDtoBase ( )
inline

Default constructor, sets IsNull to true.

Member Function Documentation

abstract TypeResponseEvaluator IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CreateResponseEvaluator ( )
pure virtual

Creates and returns a new response evaluator of the specified type.

Parameters
lengthVector dimension.

Implemented in IG.Num.ResponseEvaluatorWithStorageVectorDto.

override TypeResponseEvaluator IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CreateObject ( )
inline

Creates and returns a new response evaluator of the specified type.

override void IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.CopyToPlain ( ref ResponseEvaluatorWithStorageVector  responseEvaluator)
inlineprotected

Copies data from the current DTO to a response evaluator object.

Parameters
vecResponse evaluator object that data is copied to.

Member Data Documentation

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.AddresultsAutomatically
VectorFunctionResultsDto [] IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.Results
int IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.NumParameters

Gets number of parameters of the current vector function (-1 for not defined, in case that function works with different numbers of parameters).

int IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.NumFunctions

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).

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.ValueDefined

Tells whether value of the function is defined by implementation.

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.DerivativeDefined

Tells whether the first derivative is defined for this function (by implementation, not mathematically)

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.SecondDerivativeDefined

Tells whether the second derivative is defined for this function (by implementation, not mathematically)

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.ReqValues

Indicates whether calculation of functions is requested.

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.ReqGradients

Indicates whether calculation of function gradients is requested.

bool IG.Num.ResponseEvaluatorWithStorageVectorDtoBase< TypeResponseEvaluator >.ReqHessians

Indicates whether calculation of functions' Hessians is requested.


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