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

Base class for DTOs (Data Transfer Objects) for response evaluators with storage where response is evaluated by an (optimization) direct analysis. More...

+ Inheritance diagram for IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >:
+ Collaboration diagram for IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >:

Public Member Functions

 ResponseEvaluatorWithStorageAnalysisDtoBase ()
 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
 
AnalysisResultsDto[] 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 NumObjectives
 Number of objective functions (normally 1 for this type, but can be 0). More...
 
int NumConstraints
 Number of constraints. More...
 
int NumEqualityConstraints
 Number of equality constraints. More...
 
bool ReqObjective
 Indicates whether calculation of objective function is/was requested. More...
 
bool ReqObjectiveGradient
 Indicates whether calculation of objective function gradient is/was requested. More...
 
bool ReqObjectiveHessian
 Indicates whether calculation of objective function Hessian is/was requested. More...
 
bool ReqConstraints
 Indicates whether calculation of constraint functions is/was requested. More...
 
bool ReqConstraintGradients
 Indicates whether calculation of constraint functions gradient is/was requested. More...
 
bool ReqConstraintHessians
 Indicates whether calculation of constraint functions Hessian is/was requested. More...
 

Protected Member Functions

override void CopyFromPlain (ResponseEvaluatorWithStorageAnalysis responseEvaluator)
 Copies data to the current DTO from a vector function-based response evaluator object. More...
 
override void CopyToPlain (ref ResponseEvaluatorWithStorageAnalysis 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 an (optimization) direct analysis.

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

$A Igor May10;

Type Constraints
TypeResponseEvaluator :ResponseEvaluatorWithStorageAnalysis 

Constructor & Destructor Documentation

IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ResponseEvaluatorWithStorageAnalysisDtoBase ( )
inline

Default constructor, sets IsNull to true.

Member Function Documentation

abstract TypeResponseEvaluator IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CreateResponseEvaluator ( )
pure virtual

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

Parameters
lengthVector dimension.

Implemented in IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDto.

override TypeResponseEvaluator IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CreateObject ( )
inline

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

override void IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.CopyToPlain ( ref ResponseEvaluatorWithStorageAnalysis  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.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.AddresultsAutomatically
AnalysisResultsDto [] IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.Results
int IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< 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.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.NumObjectives

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

int IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.NumConstraints

Number of constraints.

int IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.NumEqualityConstraints

Number of equality constraints.

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqObjective

Indicates whether calculation of objective function is/was requested.

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqObjectiveGradient

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

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqObjectiveHessian

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

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqConstraints

Indicates whether calculation of constraint functions is/was requested.

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqConstraintGradients

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

bool IG.NumExperimental.ResponseEvaluatorWithStorageAnalysisDtoBase< TypeResponseEvaluator >.ReqConstraintHessians

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


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