DTO (Data Transfer Objects) for storing contents of direct analysis request (in optimization problems). More...

Inheritance diagram for IG.Num.AnalysisResultsDto:

Collaboration diagram for IG.Num.AnalysisResultsDto:

Public Member Functions
	AnalysisResultsDto ()
	Default constructor. More...

Public Member Functions inherited from IG.Num.AnalysisRequestDto
	AnalysisRequestDto ()
	Default constructor. More...

override AnalysisResults	CreateObject ()
	Creates and returns a new analysis request object. More...

Protected Member Functions
override void	CopyFromPlain (AnalysisResults anres)
	Copies data to the current DTO from an analysis results object. More...

override void	CopyToPlain (ref AnalysisResults anres)
	Copies data from the current DTO to an analysis results object. More...

Protected Member Functions inherited from IG.Num.AnalysisRequestDto
override void	CopyFromPlain (AnalysisResults anres)
	Copies data to the current DTO from an analysis results object. More...

override void	CopyToPlain (ref AnalysisResults anres)
	Copies data from the current DTO to a vector object. More...

Protected Attributes
int	_errorCode = 0

string	_errorString = null

Properties
virtual int	ErrorCode `[get, set]`
	Error code. 0 - everything is OK. negative value - something went wrong. More...

virtual String	ErrorString `[get, set]`
	Error string indicating what went wrong. More...

bool	CalculatedObjective `[get, set]`
	Flag indicating whether calculation of objective function is required or not. More...

bool	CalculatedConstraints `[get, set]`
	Flag indicating whether calculation of constraint functions is required or not. More...

bool	CalculatedObjectiveGradient `[get, set]`
	Flag indicating whether calculation of objective function gradient is required or not. More...

bool	CalculatedConstraintGradients `[get, set]`
	Flag indicating whether calculation of constraint function gradients is required or not. More...

bool	CalculatedObjectiveHessian `[get, set]`
	Flag indicating whether calculation of objective function Hessian is required or not. More...

bool	CalculatedConstraintHessians `[get, set]`
	Flag indicating whether calculation of constraint function Hessians is required or not. More...

Double	Objective `[get, set]`
	Value of the objective function. More...

double[]	Constraints `[get, set]`

VectorDtoBase	ObjectiveGradient `[get, set]`
	Gradient of the objective function. More...

VectorDtoBase[]	ConstraintGradients `[get, set]`
	Gradients of constraint functions. More...

MatrixDtoBase	ObjectiveHessian `[get, set]`
	Hessian of the objective function. More...

MatrixDtoBase[]	ConstraintHessians `[get, set]`
	Hessians of constraint functions. More...

Properties inherited from IG.Num.AnalysisRequestDto
int	NumParameters `[get, set]`
	Number of parameters of an optimization problem. More...

int	NumObjectives `[get, set]`
	Number of objective functions (usually 1, always less or equal to 1 - since this is not meant for multiobjective optimization). More...

int	NumConstraints `[get, set]`
	Number of constraint functions in the optimization problem. More...

int	NumEqualityConstraints `[get, set]`
	Number of equality constraints. More...

VectorDtoBase	Parameters `[get, set]`
	Vector of parameters at which response functons are requested. More...

bool	RequestedObjective `[get, set]`
	Flag indicating whether calculation of objective function is required or not. More...

bool	RequestedConstraints `[get, set]`
	Flag indicating whether calculation of constraint functions is required or not. More...

bool	RequestedObjectiveGradient `[get, set]`
	Flag indicating whether calculation of objective function gradient is required or not. More...

bool	RequestedConstraintGradients `[get, set]`
	Flag indicating whether calculation of constraint function gradients is required or not. More...

bool	RequestedObjectiveHessian `[get, set]`
	Flag indicating whether calculation of objective function Hessian is required or not. More...

bool	RequestedConstraintHessians `[get, set]`
	Flag indicating whether calculation of constraint function Hessians is required or not. More...

Private Attributes
bool	_calculatedObjective = true

bool	_calculatedConstraints = true

bool	_calculatedObjectiveGradient = false

bool	_calculatedConstraintGradients = false

bool	_calculatedObjectiveHessian = false

bool	_calculatedConstraintHessians = false

double	_objective

double[]	_constraints

VectorDtoBase	_objectiveGratient

VectorDtoBase[]	_constraintGradients

MatrixDtoBase	_objectiveHessian

MatrixDtoBase[]	_constraintHessians

Detailed Description

DTO (Data Transfer Objects) for storing contents of direct analysis request (in optimization problems).

$A Igor Aug10;

Constructor & Destructor Documentation

IG.Num.AnalysisResultsDto.AnalysisResultsDto ( )

inline

Default constructor.

Member Function Documentation

override void IG.Num.AnalysisResultsDto.CopyFromPlain ( AnalysisResults anres )

inlineprotected

Copies data to the current DTO from an analysis results object.

Parameters

anres Analysis results object from which data is copied.

override void IG.Num.AnalysisResultsDto.CopyToPlain ( ref AnalysisResults anres )

inlineprotected

Copies data from the current DTO to an analysis results object.

Parameters

anres Analysis results object that data is copied to.

Member Data Documentation

int IG.Num.AnalysisResultsDto._errorCode = 0

protected

string IG.Num.AnalysisResultsDto._errorString = null

protected

bool IG.Num.AnalysisResultsDto._calculatedObjective = true

private

bool IG.Num.AnalysisResultsDto._calculatedConstraints = true

private

bool IG.Num.AnalysisResultsDto._calculatedObjectiveGradient = false

private

bool IG.Num.AnalysisResultsDto._calculatedConstraintGradients = false

private

bool IG.Num.AnalysisResultsDto._calculatedObjectiveHessian = false

private

bool IG.Num.AnalysisResultsDto._calculatedConstraintHessians = false

private

double IG.Num.AnalysisResultsDto._objective

private

double [] IG.Num.AnalysisResultsDto._constraints

private

VectorDtoBase IG.Num.AnalysisResultsDto._objectiveGratient

private

VectorDtoBase [] IG.Num.AnalysisResultsDto._constraintGradients

private

MatrixDtoBase IG.Num.AnalysisResultsDto._objectiveHessian

private

MatrixDtoBase [] IG.Num.AnalysisResultsDto._constraintHessians

private

Property Documentation

virtual int IG.Num.AnalysisResultsDto.ErrorCode

getset

Error code. 0 - everything is OK. negative value - something went wrong.

virtual String IG.Num.AnalysisResultsDto.ErrorString

getset

Error string indicating what went wrong.

bool IG.Num.AnalysisResultsDto.CalculatedObjective

getset

Flag indicating whether calculation of objective function is required or not.

bool IG.Num.AnalysisResultsDto.CalculatedConstraints

getset

Flag indicating whether calculation of constraint functions is required or not.

bool IG.Num.AnalysisResultsDto.CalculatedObjectiveGradient

getset

Flag indicating whether calculation of objective function gradient is required or not.

bool IG.Num.AnalysisResultsDto.CalculatedConstraintGradients

getset

Flag indicating whether calculation of constraint function gradients is required or not.

bool IG.Num.AnalysisResultsDto.CalculatedObjectiveHessian

getset

Flag indicating whether calculation of objective function Hessian is required or not.

bool IG.Num.AnalysisResultsDto.CalculatedConstraintHessians

getset

Flag indicating whether calculation of constraint function Hessians is required or not.

Double IG.Num.AnalysisResultsDto.Objective

getset

Value of the objective function.

double [] IG.Num.AnalysisResultsDto.Constraints

getset

VectorDtoBase IG.Num.AnalysisResultsDto.ObjectiveGradient

getset

Gradient of the objective function.

VectorDtoBase [] IG.Num.AnalysisResultsDto.ConstraintGradients

getset

Gradients of constraint functions.

MatrixDtoBase IG.Num.AnalysisResultsDto.ObjectiveHessian

getset

Hessian of the objective function.

MatrixDtoBase [] IG.Num.AnalysisResultsDto.ConstraintHessians

getset

Hessians of constraint functions.

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

igbase/data/serialization/dtos/opt/AnalysisResultsDto.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation