Single objective optimization analysis results. Used to transfer parameters input (e.g. vector of parameters, request flags) to the analysis function and to store analysis output results (e.g. objective and constraint functions, their gradients, error codes, and flags indicating what has actually been calculated). REMARKS: Property CopyReferences specifies whether only references are copied when individial object fields are assigned and set (when the property is true), or values are actually copied (when false - deep copy). Each setter method also has the variant that always copies only the reference (function name appended by "Reference"). This makes possible to avoid duplication of allocated data and also to avoid having different data with the same references. In the beginning of analysis functions, call ResetResults(). More...

Inheritance diagram for IG.Num.IAnalysisResults:

Public Member Functions
IVector	GetParameters ()
	Returns vector of optimization parameters. More...

void	SetParameters (IVector value)
	Sets the vector of optimization parameters. If CopyReferences=true (false by default) then only the reference is copied. More...

void	SetParametersReference (IVector reference)
	Sets the vector of optimization parameters. Only the reference is copied. More...

double	GetParameter (int index)
	Returns specific optimization parameter. Throws exception if not defined or index out of bounds. More...

void	SetParameter (int index, double value)
	Sets the specified optimization parameter. More...

double	GetObjective ()
	Returns the value of the objective function. More...

void	SetObjective (double value)
	Sets the value of the objective function. More...

IVector	GetObjectiveGradient ()
	Returns the objective function gradient. More...

void	SetObjectiveGradient (IVector value)
	Sets the objective function gradient. If CopyReferences=true (false by default) then only the reference is copied. More...

void	SetObjectiveGradientReference (IVector reference)
	Sets the objective function gradient. Only the reference is copied. More...

double	GetObjectiveGradient (int index)
	Returns the specified component of the objective function gradient. More...

void	SetObjectiveGradient (int index, double value)
	Sets the specified component of the objective function gradient. More...

List< double >	GetConstraints ()
	Returns a list of constraint function values. More...

void	SetConstraints (List< double > values)
	Sets the list of constraint function values. If CopyReferences=true (false by default) then only the list reference is copied. More...

void	SetConstraintsReference (List< double > reference)
	Sets the list of constraint function values. Only the list reference is copied. More...

double	GetConstraint (int which)
	Returns the specified constraint function value. More...

void	SetConstraint (int which, double value)
	Sets the specified constraint function value. More...

List< IVector >	GetConstraintGradients ()
	Returns a list of constraint function gradients. More...

void	SetConstraintGradients (List< IVector > values)
	Sets constraint function gradients. If CopyReferences=true (false by default) then only the list reference is copied. More...

void	SetConstraintGradientsReference (List< IVector > reference)
	Sets constraint function gradients. Only the list reference is copied. More...

IVector	GetConstraintGradient (int which)
	Returns the gradient of the specified constraint function. More...

double	GetConstraintGradient (int which, int index)
	Returns the specific constraint function gradient component. More...

void	SetConstraintGradient (int which, IVector value)
	Sets the specified constraint function gradient. If CopyReferences=true (false by default) then only the reference is copied. More...

void	SetConstraintGradientReference (int which, IVector reference)
	Sets the specified constraint function gradient. Only the reference is copied. More...

void	SetConstraintGradient (int which, int index, double value)
	Sets the specified constraint fuction gradient component. More...

IMatrix	GetObjectiveHessian ()
	Returns the objective function's Hessian. More...

void	SetObjectiveHessian (IMatrix value)
	Sets the objective functions' Hessian. If CopyReferences=true (false by default) then only the reference is copied. More...

void	SetObjectiveHessianReference (IMatrix reference)
	Sets the objective functions' Hessian. Only the reference is copied. More...

double	GetObjectiveHessian (int rowIndex, int columnIndex)
	Returns the specified component of the objective function Hessian. More...

void	SetObjectiveHessian (int rowIndex, int columnIndex, double value)
	Sets the specified component of the objective function's Hessian. More...

List< IMatrix >	GetConstraintHessians ()
	Returns the list of constraint functions' Hessians. More...

void	SetConstraintHessians (List< IMatrix > values)
	Sets constraint functios' Hessians. If CopyReferences=true (false by default) then only the list reference is copied. More...

void	SetConstraintHessiansReference (List< IMatrix > reference)
	Sets constraint functios' Hessians. Only the list reference is copied. More...

IMatrix	GetConstraintHessian (int which)
	Returns Hessian of the specified constraint function. More...

double	GetConstraintHessian (int which, int rowIndex, int columnIndex)
	Returns the specified component of Hessian of the specified constraint function. More...

void	SetConstraintHessian (int which, IMatrix value)
	Sets the specified constraint function's Hessian. If CopyReferences=true (false by default) then only the reference is copied. More...

void	SetConstraintHessianReference (int which, IMatrix reference)
	Sets the specified constraint function's Hessian. Only the reference is copied. More...

void	SetConstraintHessian (int which, int rowIndex, int columnIndex, double value)
	Sets the specified component of the specified constraint's Hessian. More...

void	NullifyAll ()
	Sets all objects (parameter and result objects) to null. If the references are not assigned elsewhere, these objects become eligible for garbage collection. More...

void	NullifyResults ()
	Sets all result objects to null. If the references are not assigned elsewhere, these objects become eligible for garbage collection. More...

void	AllocateParameters ()
	Allocates space for parameters. More...

void	AllocateRequested ()
	Allocates space for all requested result objects. More...

void	AllocateObjectiveGradient ()
	Allocate space for objective function gradient. More...

void	AllocateObjectiveHessian ()
	Allocates space for objective function Hessian. More...

void	AllocateConstraintsList ()
	Allocates space for list of constraint functions. More...

void	AllocateConstraintGradientsList ()
	Allocates space for list of constraint function gradients. More...

void	AllocateConstrainGradients ()
	Allocates space for constraint function gradients (including for the list, if necessarty). More...

void	AllocateConstraintGradient (int which)
	Allocates space for the specified constraint function gradient. More...

void	AllocateConstraintHessiansList ()
	Allocates space for the list of constraint functions' Hessians. More...

void	AllocateConstraintHessians ()
	Allocates space for constraint functions' Hessians (including space for the list, if necessary). More...

void	AllocateConstraintHessian (int which)
	Allocates space for the specified constraint fucnction's Hessian. More...

void	ResetResults ()
	Sets all calculated flags to false, error code to 0 (no error) and error string to null. More...

void	SetDimensions (int numParameters, int numConstraints)
	Sets the dimension of the analysis results object according to the specified values. More...

void	SetDimensions (int numParameters, int numObjectives, int numConstraints)
	Sets the dimension of the analysis results object according to the specified values. More...

void	PrepareResultStorage ()
	Prepares data storage for results (allocates the appropriate vectors, matrices, lists, etc.) according to the numbers of parameters, constraint functions, and request flags, and resets calculation flags to false. More...

void	PrepareResultStorage (bool resetCalculatedFlags)
	Prepares data storage for results (allocates the appropriate vectors, matrices, lists, etc.) according to the numbers of parameters, constraint functions, and request flags. More...

void	PrepareResultStorage (int numParameters, int numConstraints)
	Prepares data storage for results (allocates the appropriate vectors, matrices, lists, etc.) according to the numbers of parameters, constraint functions, and request flags, and resets calculation flags to false. More...

void	PrepareResultStorage (int numParameters, int numObjectives, int numConstraints)
	Prepares data storage for results (allocates the appropriate vectors, matrices, lists, etc.) according to the numbers of parameters, constraint functions, and request flags, and resets calculation flags to false. More...

void	PrepareResultStorage (int numParameters, int numObjectives, int numConstraints, bool resetCalculatedFlags)
	Prepares data storage for results (allocates the appropriate vectors, matrices, lists, etc.) according to the numbers of parameters, constraint functions, and request flags. More...

void	Copy (IAnalysisResults results)
	Copies data from another analysis results. More...

IAnalysisResults	GetCopy ()
	Returns an exact deep copy of the current object. More...

bool	IsViolated (int which, double equalityTolerance)
	Returns true if the specified constraint is violated according to the current analysis results, false otherwise. More...

bool	IsViolated (int which)
	Returns true if the specified constraint is violated according to the current analysis results, false otherwise. More...

bool	IsFeasible (double equalityTolerance)
	Returns true if the current analysis results represent a feasible point. Feasible point is one where no constraints are violated. For unconstraint problems this method always returns true. More...

bool	IsFeasible ()
	Returns true if the current analysis results represent a feasible point. Feasible point is one where no constraints are violated. For unconstraint problems this method always returns true. More...

int	GetNumViolatedConstraints (double equalityTolerance)
	Returns number of violated constraints in the current analysis results. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

int	GetNumViolatedConstraints ()
	Returns number of violated constraints in the current analysis results. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

double	GetSumResiduals (double equalityTolerance)
	Returns sum of constraint function values corresponding to violated constraints in the current analysis results. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

double	GetSumResiduals ()
	Returns sum of constraint function values corresponding to violated constraints in the current analysis results. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

double	GetMaximalResidual (double equalityTolerance)
	Returns the largest constraint function value corresponding to any violated constraint in the current analysis results, or 0 if there are no violated constraints. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

double	GetMaximalResidual ()
	Returns sum of constraint function values corresponding to violated constraints in the current analysis results. Specific constraint is violated if the corresponding constraint function is greater than 0. More...

double	GetPenaltyTerm (int which, IPenaltyEvaluator evaluator)
	Returns value of the penalty term corresponding to the specified constraint, calculated by the specified penalty evaluator. More...

double	GetSumPenaltyTerms (IPenaltyEvaluator evaluator)
	Returns sum of the penalty terms corresponding to all constraint, calculated by the specified penalty evaluator. More...

double	GetMaxPenaltyTerm (IPenaltyEvaluator evaluator)
	Returns sum of the penalty terms corresponding to all constraint, calculated by the specified penalty evaluator. More...

Properties
int	NumParameters `[get, set]`
	Number of parameters. More...

int	NumObjectives `[get, set]`
	Number of objective functions (normally 1 for this type, but can be 0). More...

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

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

bool	CopyReferences `[get, set]`
	Indicates whether just references can be copied when setting optimization parameters or results. If false then deep copy is always be performed. Default is false. More...

IVector	Parameters `[get, set]`
	Optimization parameters. If CopyReferences=true (false by default) then only the reference is copied when assigning. More...

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

IVector	ObjectiveGradient `[get, set]`
	Objective function gradient. If CopyReferences=true (false by default) then only the reference is copied in assignments. More...

List< double >	Constraints `[get, set]`
	Constraint function values. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...

List< IVector >	ConstraintGradients `[get, set]`
	Constraint function gradients. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...

IMatrix	ObjectiveHessian `[get, set]`
	Objective function Hessian (matrix of second derivatives). If CopyReferences=true (false by default) then only the reference is copied in assignments. More...

List< IMatrix >	ConstraintHessians `[get, set]`
	Constraint functions' Hessians (matrices of second derivatives). If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...

bool	ReqObjective `[get, set]`
	Indicates whether calculation of objective function is/was requested. More...

bool	ReqObjectiveGradient `[get, set]`
	Indicates whether calculation of objective function gradient is/was requested. More...

bool	ReqObjectiveHessian `[get, set]`
	Indicates whether calculation of objective function Hessian is/was requested. More...

bool	ReqConstraints `[get, set]`
	Indicates whether calculation of constraint functions is/was requested. More...

bool	ReqConstraintGradients `[get, set]`
	Indicates whether calculation of constraint functions gradient is/was requested. More...

bool	ReqConstraintHessians `[get, set]`
	Indicates whether calculation of constraint functions Hessian is/was requested. More...

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

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

bool	Calculated `[get, set]`
	Collectively gets or sets calculated flags. Set false: all calculated flags are set to false. Set true: all calculated flags for which the corresponding request flags are true, are set to truee, others are set to false. Get: returns true if all the flags for which the corresponding request flags are true, are also true. Otherwise returns false. More...

bool	CalculatedObjective `[get, set]`
	Indicates whether calculation of objective function is/was requested. More...

bool	CalculatedObjectiveGradient `[get, set]`
	Indicates whether calculation of objective function gradient is/was requested. More...

bool	CalculatedObjectiveHessian `[get, set]`
	Indicates whether calculation of objective function Hessian is/was requested. More...

bool	CalculatedConstraints `[get, set]`
	Indicates whether calculation of constraint functions is/was requested. More...

bool	CalculatedConstraintGradients `[get, set]`
	Indicates whether calculation of constraint functions gradient is/was requested. More...

bool	CalculatedConstraintHessians `[get, set]`
	Indicates whether calculation of constraint functions Hessian is/was requested. More...

Detailed Description

Single objective optimization analysis results. Used to transfer parameters input (e.g. vector of parameters, request flags) to the analysis function and to store analysis output results (e.g. objective and constraint functions, their gradients, error codes, and flags indicating what has actually been calculated). REMARKS: Property CopyReferences specifies whether only references are copied when individial object fields are assigned and set (when the property is true), or values are actually copied (when false - deep copy). Each setter method also has the variant that always copies only the reference (function name appended by "Reference"). This makes possible to avoid duplication of allocated data and also to avoid having different data with the same references. In the beginning of analysis functions, call ResetResults().

$A Igor Jun08;

Member Function Documentation

IVector IG.Num.IAnalysisResults.GetParameters ( )

Returns vector of optimization parameters.

void IG.Num.IAnalysisResults.SetParameter	(	int	index,
		double	value
	)

index	Index of parameter to be set (counting from 0).
value	Parameter value.

void IG.Num.IAnalysisResults.SetObjectiveGradient	(	int	index,
		double	value
	)

index	Index of objective gradient component to be set.
value	Value of the objective gradient component.

void IG.Num.IAnalysisResults.SetConstraint	(	int	which,
		double	value
	)

which	Specifies which constraint function is set (counting from 0).
value	Assigned value of the constraint function.

double IG.Num.IAnalysisResults.GetConstraintGradient	(	int	which,
		int	index
	)

which	Specifies which constraint function to take (couonted from 0).
index	Specifies gradient component (conted form 0).

which	Specifies which constraint function to take (couonted from 0).
reference	Gradient reference to be assigned.

double IG.Num.IAnalysisResults.GetObjectiveHessian	(	int	rowIndex,
		int	columnIndex
	)

rowIndex	Row index of the component (counting from 0).
columnIndex	Column index of the component (counting from 0).

void IG.Num.IAnalysisResults.SetObjectiveHessian	(	int	rowIndex,
		int	columnIndex,
		double	value
	)

which	Specifies which constraint function it applies to (counting from 0).
rowIndex	Row index of the component (counting from 0).
columnIndex	Column index of the component (counting from 0).

void IG.Num.IAnalysisResults.SetDimensions	(	int	numParameters,
		int	numConstraints
	)

numParameters	Number of parameters.
numConstraints	Number of constraints.

void IG.Num.IAnalysisResults.SetDimensions	(	int	numParameters,
		int	numObjectives,
		int	numConstraints
	)

numParameters	Number of parameters.
numObjectives	Number of objective functions.
numConstraints	Number of constraints.

void IG.Num.IAnalysisResults.PrepareResultStorage	(	int	numParameters,
		int	numConstraints
	)

bool IG.Num.IAnalysisResults.IsViolated	(	int	which,
		double	equalityTolerance
	)

which	Specifies the constraint in question.
equalityTolerance	Tolerance for violation of equality constraints. If constraint function corresponding to equality conatraint is less or equal than tolerance then the corresponding constraint is considered non-violated.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation

IndexOutOfRangeException	when constraint index is smaller lesser than 0 or greater than the number of constraints.
InvalidOperationException	when constraints are not evaluated.

double IG.Num.IAnalysisResults.GetPenaltyTerm	(	int	which,
		IPenaltyEvaluator	evaluator
	)

which	Specifies the constraint in question.
evaluator	Penalty function evaluator that evaluates penalty functions.