IGLib  1.5
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
IG.Num.VectorFunctionResults Class Reference

Vector function results. Used to transfer parameters input (e.g. vector of parameters, request flags) to the vector function and to store function output results (e.g. values, 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 & 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.VectorFunctionResults:
+ Collaboration diagram for IG.Num.VectorFunctionResults:

Public Member Functions

 VectorFunctionResults ()
 1 parameter, 1 function. No gradients required More...
 
 VectorFunctionResults (bool reqGradients)
 1 parameter, 1 function, gradients required. More...
 
 VectorFunctionResults (int numParameters)
 Specified number of parameters, 1 function. No gradients required. More...
 
 VectorFunctionResults (int numParameters, bool reqGradients)
 Specified number of parameters, 1 function. No gradients required. More...
 
 VectorFunctionResults (int numParameters, int numFunctions)
 Specified number of parameters and functions. No gradients required. More...
 
 VectorFunctionResults (int numParameters, int numFunctions, bool reqGradients)
 Specified number of parameters and functions. No gradients required. More...
 
virtual IVector GetParameters ()
 Returns vector of optimization parameters. More...
 
virtual void SetParameters (IVector value)
 Sets the vector of optimization parameters. If CopyReferences=true (false by default) then only the reference is copied. More...
 
virtual void SetParametersReference (IVector reference)
 Sets the vector of optimization parameters. Only the reference is copied. More...
 
virtual double GetParameter (int index)
 Returns specific optimization parameter. Throws exception if not defined or index out of bounds. More...
 
virtual void SetParameter (int index, double value)
 Sets the specified optimization parameter. More...
 
virtual List< double > GetValues ()
 Returns a list of function values. More...
 
virtual void SetValues (List< double > values)
 Sets the list of function values. If CopyReferences=true (false by default) then only the list reference is copied. More...
 
virtual void SetValuesReference (List< double > reference)
 Sets the list of function values. Only the list reference is copied. More...
 
virtual double GetValue (int which)
 Returns the specified function value. More...
 
virtual void SetValue (int which, double value)
 Sets the specified function value. More...
 
virtual List< IVectorGetGradients ()
 Returns a list of function gradients. More...
 
virtual void SetGradients (List< IVector > values)
 Sets function gradients. If CopyReferences=true (false by default) then only the list reference is copied. More...
 
virtual void SetGradientsReference (List< IVector > reference)
 Sets function gradients. Only the list reference is copied. More...
 
virtual IVector GetGradient (int which)
 Returns the gradient of the specified function. More...
 
virtual double GetGradient (int which, int index)
 Returns the specific function gradient component. More...
 
virtual void SetGradient (int which, IVector value)
 Sets the specified function gradient. If CopyReferences=true (false by default) then only the reference is copied. More...
 
virtual void SetGradientReference (int which, IVector reference)
 Sets the specified function gradient. Only the reference is copied. More...
 
virtual void SetGradient (int which, int index, double value)
 Sets the specified fuction gradient component. More...
 
virtual List< IMatrixGetHessians ()
 Returns the list of functions' Hessians. More...
 
virtual void SetHessians (List< IMatrix > values)
 Sets functios' Hessians. If CopyReferences=true (false by default) then only the list reference is copied. More...
 
virtual void SetHessiansReference (List< IMatrix > reference)
 Sets functios' Hessians. Only the list reference is copied. More...
 
virtual IMatrix GetHessian (int which)
 Returns Hessian of the specified function. More...
 
virtual double GetHessian (int which, int rowIndex, int columnIndex)
 Returns the specified component of Hessian of the specified function. More...
 
virtual void SetHessian (int which, IMatrix value)
 Sets the specified function's Hessian. If CopyReferences=true (false by default) then only the reference is copied. More...
 
virtual void SetHessianReference (int which, IMatrix reference)
 Sets the specified function's Hessian. Only the reference is copied. More...
 
virtual void SetHessian (int which, int rowIndex, int columnIndex, double value)
 Sets the specified component of the specified function's Hessian. More...
 
virtual void NullifyAll ()
 Sets all objects (parameters and result objects) to null. If the references are not assigned elsewhere, these objects become eligible for garbage collection. More...
 
virtual void NullifyResults ()
 Sets all result objects to null. If the references are not assigned elsewhere, these objects become eligible for garbage collection. More...
 
virtual void AllocateParameters ()
 Allocates space for parameters. More...
 
virtual void AllocateRequested ()
 Allocates space for all requested result objects. More...
 
virtual void AllocateValuesList ()
 Allocates space for list of function values. More...
 
virtual void AllocateGradientsList ()
 Allocates space for list of function gradients. More...
 
virtual void AllocateGradients ()
 Allocates space for function gradients (including for the list, if necessarty). More...
 
virtual void AllocateGradient (int which)
 Allocates space for the specified function gradient. More...
 
virtual void AllocateHessiansList ()
 Allocates space for the list of functions' Hessians. More...
 
virtual void AllocateHessians ()
 Allocates space for functions' Hessians (including space for the list, if necessary). More...
 
virtual void AllocateHessian (int which)
 Allocates space for the specified fucnction's Hessian. More...
 
virtual void ResetResults ()
 Sets all calculated flags to false, error code to 0 (no error) and error string to null. More...
 
virtual void Copy (IVectorFunctionResults results)
 Copies data from another vector function results. More...
 
virtual IVectorFunctionResults GetCopy ()
 Returns an exact deep copy of the current object. More...
 
override string ToString ()
 

Protected Attributes

int _numParameters = 1
 
int _numFunctions = 0
 
IVector _parameters
 
List< double > _values
 
List< IVector_gradients
 
List< IMatrix_hessians
 
bool _copyReferences = false
 
bool _reqvalues = true
 
bool _reqGradients = false
 
bool _reqHessians = false
 
int _errorCode = 0
 
string _errorString = null
 
bool _calcValues = false
 
bool _calcGradients = false
 
bool _calcHessians = false
 

Properties

virtual int NumParameters [get, set]
 Number of parameters. More...
 
virtual int NumFunctions [get, set]
 Number of functions. More...
 
virtual 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...
 
virtual IVector Parameters [get, set]
 Optimization parameters. If CopyReferences=true (false by default) then only the reference is copied when assigning. More...
 
virtual List< double > Values [get, set]
 Function values. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
virtual List< IVectorGradients [get, set]
 Function gradients. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
virtual List< IMatrixHessians [get, set]
 Functions' Hessians (matrices of second derivatives). If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
virtual bool ReqValues [get, set]
 Indicates whether calculation of functions is/was requested. More...
 
virtual bool ReqGradients [get, set]
 Indicates whether calculation of function gradients is/was requested. More...
 
virtual bool ReqHessians [get, set]
 Indicates whether calculation of functions' Hessians is/was requested. More...
 
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...
 
virtual 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...
 
virtual bool CalculatedValues [get, set]
 Indicates whether calculation of functions is/was requested. More...
 
virtual bool CalculatedGradients [get, set]
 Indicates whether calculation of functions' gradients is/was requested. More...
 
virtual bool CalculatedHessians [get, set]
 Indicates whether calculation of functions' Hessian is/was requested. More...
 
- Properties inherited from IG.Num.IVectorFunctionResults
int NumParameters [get, set]
 Number of parameters. More...
 
int NumFunctions [get, set]
 Number of functions. 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...
 
List< double > Values [get, set]
 Function values. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
List< IVectorGradients [get, set]
 Function gradients. If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
List< IMatrixHessians [get, set]
 Functions' Hessians (matrices of second derivatives). If CopyReferences=true (false by default) then only the list reference is copied in assignments. More...
 
bool ReqValues [get, set]
 Indicates whether calculation of function values is/was requested. More...
 
bool ReqGradients [get, set]
 Indicates whether calculation of functions gradients is/was requested. More...
 
bool ReqHessians [get, set]
 Indicates whether calculation of 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 CalculatedValues [get, set]
 Indicates whether calculation of function values is/was requested. More...
 
bool CalculatedGradients [get, set]
 Indicates whether calculation of functions gradient is/was requested. More...
 
bool CalculatedHessians [get, set]
 Indicates whether calculation of functions' Hessians are/was requested. More...
 

Detailed Description

Vector function results. Used to transfer parameters input (e.g. vector of parameters, request flags) to the vector function and to store function output results (e.g. values, 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 & 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 xx Apr10;

Constructor & Destructor Documentation

IG.Num.VectorFunctionResults.VectorFunctionResults ( )
inline

1 parameter, 1 function. No gradients required

IG.Num.VectorFunctionResults.VectorFunctionResults ( bool  reqGradients)
inline

1 parameter, 1 function, gradients required.

Parameters
reqGradientsWhether gradient of the function gradient is required.
IG.Num.VectorFunctionResults.VectorFunctionResults ( int  numParameters)
inline

Specified number of parameters, 1 function. No gradients required.

Parameters
numParametersNumber of parameters.
IG.Num.VectorFunctionResults.VectorFunctionResults ( int  numParameters,
bool  reqGradients 
)
inline

Specified number of parameters, 1 function. No gradients required.

Parameters
numParametersNumber of parameters.
reqGradientsWhether gradients are requested.
IG.Num.VectorFunctionResults.VectorFunctionResults ( int  numParameters,
int  numFunctions 
)
inline

Specified number of parameters and functions. No gradients required.

Parameters
numParametersNumber of parameters.
numFunctionsNumber of functions.
IG.Num.VectorFunctionResults.VectorFunctionResults ( int  numParameters,
int  numFunctions,
bool  reqGradients 
)
inline

Specified number of parameters and functions. No gradients required.

Parameters
numParametersNumber of parameters.
numFunctionsNumber of functions.

Member Function Documentation

virtual IVector IG.Num.VectorFunctionResults.GetParameters ( )
inlinevirtual

Returns vector of optimization parameters.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetParameters ( IVector  value)
inlinevirtual

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

Parameters
valueValue to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetParametersReference ( IVector  reference)
inlinevirtual

Sets the vector of optimization parameters. Only the reference is copied.

Parameters
valueReference to be assigned.

Implements IG.Num.IVectorFunctionResults.

Referenced by IG.Num.LinearBasis.Example().

virtual double IG.Num.VectorFunctionResults.GetParameter ( int  index)
inlinevirtual

Returns specific optimization parameter. Throws exception if not defined or index out of bounds.

Parameters
iindexIndex of parameter to be returned (counting from 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetParameter ( int  index,
double  value 
)
inlinevirtual

Sets the specified optimization parameter.

Parameters
indexIndex of parameter to be set (counting from 0).
valueParameter value.

Implements IG.Num.IVectorFunctionResults.

virtual List<double> IG.Num.VectorFunctionResults.GetValues ( )
inlinevirtual

Returns a list of function values.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetValues ( List< double >  values)
inlinevirtual

Sets the list of function values. If CopyReferences=true (false by default) then only the list reference is copied.

Parameters
valuesValues of functions.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetValuesReference ( List< double >  reference)
inlinevirtual

Sets the list of function values. Only the list reference is copied.

Parameters
valuesReference to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual double IG.Num.VectorFunctionResults.GetValue ( int  which)
inlinevirtual

Returns the specified function value.

Parameters
whichSpecifies which function to return (counting from 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetValue ( int  which,
double  value 
)
inlinevirtual

Sets the specified function value.

Parameters
whichSpecifies which function is set (counting from 0).
valueAssigned value of the function.

Implements IG.Num.IVectorFunctionResults.

virtual List<IVector> IG.Num.VectorFunctionResults.GetGradients ( )
inlinevirtual

Returns a list of function gradients.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetGradients ( List< IVector values)
inlinevirtual

Sets function gradients. If CopyReferences=true (false by default) then only the list reference is copied.

Parameters
valuesValue to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetGradientsReference ( List< IVector reference)
inlinevirtual

Sets function gradients. Only the list reference is copied.

Parameters
valuesReference to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual IVector IG.Num.VectorFunctionResults.GetGradient ( int  which)
inlinevirtual

Returns the gradient of the specified function.

Parameters
whichSpecifies which function to take (couonted from 0).

Implements IG.Num.IVectorFunctionResults.

virtual double IG.Num.VectorFunctionResults.GetGradient ( int  which,
int  index 
)
inlinevirtual

Returns the specific function gradient component.

Parameters
whichSpecifies which function to take (couonted from 0).
indexSpecifies gradient component (conted form 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetGradient ( int  which,
IVector  value 
)
inlinevirtual

Sets the specified function gradient. If CopyReferences=true (false by default) then only the reference is copied.

Parameters
whichSpecifies which function to take (couonted from 0).
valueValue of the gradient to be assigned.

Implements IG.Num.IVectorFunctionResults.

References IG.Num.IVector.GetCopy().

virtual void IG.Num.VectorFunctionResults.SetGradientReference ( int  which,
IVector  reference 
)
inlinevirtual

Sets the specified function gradient. Only the reference is copied.

Parameters
whichSpecifies which function to take (couonted from 0).
valueGradient reference to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetGradient ( int  which,
int  index,
double  value 
)
inlinevirtual

Sets the specified fuction gradient component.

Parameters
whichSpecifies which function to take (couonted from 0).
indexSpecified index of gradient coponent to be set.
valueValue to be assigned to the specified component.

Implements IG.Num.IVectorFunctionResults.

virtual List<IMatrix> IG.Num.VectorFunctionResults.GetHessians ( )
inlinevirtual

Returns the list of functions' Hessians.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetHessians ( List< IMatrix values)
inlinevirtual

Sets functios' Hessians. If CopyReferences=true (false by default) then only the list reference is copied.

Parameters
valuesList of Hessians to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetHessiansReference ( List< IMatrix reference)
inlinevirtual

Sets functios' Hessians. Only the list reference is copied.

Parameters
valuesReference to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual IMatrix IG.Num.VectorFunctionResults.GetHessian ( int  which)
inlinevirtual

Returns Hessian of the specified function.

Parameters
whichSpecifies which function it applies to (counting from 0).

Implements IG.Num.IVectorFunctionResults.

virtual double IG.Num.VectorFunctionResults.GetHessian ( int  which,
int  rowIndex,
int  columnIndex 
)
inlinevirtual

Returns the specified component of Hessian of the specified function.

Parameters
whichSpecifies which function it applies to (counting from 0).
rowIndexRow index of the component (counting from 0).
columnIndexColumn index of the component (counting from 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetHessian ( int  which,
IMatrix  value 
)
inlinevirtual

Sets the specified function's Hessian. If CopyReferences=true (false by default) then only the reference is copied.

Parameters
whichSpecifies which function it applies to (counting from 0).
valueHessian matrix to be assigned.

Implements IG.Num.IVectorFunctionResults.

References IG.Num.IMatrix.GetCopy().

virtual void IG.Num.VectorFunctionResults.SetHessianReference ( int  which,
IMatrix  reference 
)
inlinevirtual

Sets the specified function's Hessian. Only the reference is copied.

Parameters
whichSpecifies which function it applies to (counting from 0).
valueHessian matrix reference to be assigned.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.SetHessian ( int  which,
int  rowIndex,
int  columnIndex,
double  value 
)
inlinevirtual

Sets the specified component of the specified function's Hessian.

Parameters
whichSpecifies which function it applies to (counting from 0).
rowIndexRow index of the component (counting from 0).
columnIndexColumn index of the component (counting from 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.NullifyAll ( )
inlinevirtual

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

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.NullifyResults ( )
inlinevirtual

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

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateParameters ( )
inlinevirtual

Allocates space for parameters.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateRequested ( )
inlinevirtual

Allocates space for all requested result objects.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateValuesList ( )
inlinevirtual

Allocates space for list of function values.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateGradientsList ( )
inlinevirtual

Allocates space for list of function gradients.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateGradients ( )
inlinevirtual

Allocates space for function gradients (including for the list, if necessarty).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateGradient ( int  which)
inlinevirtual

Allocates space for the specified function gradient.

Parameters
whichSpecifies which function it applies to (countinf form 0).

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateHessiansList ( )
inlinevirtual

Allocates space for the list of functions' Hessians.

Implements IG.Num.IVectorFunctionResults.

virtual void IG.Num.VectorFunctionResults.AllocateHessians ( )
inlinevirtual

Allocates space for functions' Hessians (including space for the list, if necessary).

Implements IG.Num.IVectorFunctionResults.

References IG.Num.m.

virtual void IG.Num.VectorFunctionResults.AllocateHessian ( int  which)
inlinevirtual

Allocates space for the specified fucnction's Hessian.

Parameters
whichSpecifies which function it applies to (conting form 0).

Implements IG.Num.IVectorFunctionResults.

References IG.Num.m.

virtual void IG.Num.VectorFunctionResults.ResetResults ( )
inlinevirtual

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

Implements IG.Num.IVectorFunctionResults.

virtual IVectorFunctionResults IG.Num.VectorFunctionResults.GetCopy ( )
inlinevirtual

Returns an exact deep copy of the current object.

Implements IG.Num.IVectorFunctionResults.

References IG.Num.IVectorFunctionResults.Copy().

override string IG.Num.VectorFunctionResults.ToString ( )
inline

Member Data Documentation

int IG.Num.VectorFunctionResults._numParameters = 1
protected
int IG.Num.VectorFunctionResults._numFunctions = 0
protected
IVector IG.Num.VectorFunctionResults._parameters
protected
List<double> IG.Num.VectorFunctionResults._values
protected
List<IVector> IG.Num.VectorFunctionResults._gradients
protected
List<IMatrix> IG.Num.VectorFunctionResults._hessians
protected
bool IG.Num.VectorFunctionResults._copyReferences = false
protected
bool IG.Num.VectorFunctionResults._reqvalues = true
protected
bool IG.Num.VectorFunctionResults._reqGradients = false
protected
bool IG.Num.VectorFunctionResults._reqHessians = false
protected
int IG.Num.VectorFunctionResults._errorCode = 0
protected
string IG.Num.VectorFunctionResults._errorString = null
protected
bool IG.Num.VectorFunctionResults._calcValues = false
protected
bool IG.Num.VectorFunctionResults._calcGradients = false
protected
bool IG.Num.VectorFunctionResults._calcHessians = false
protected

Property Documentation

virtual int IG.Num.VectorFunctionResults.NumParameters
getset

Number of parameters.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain().

virtual int IG.Num.VectorFunctionResults.NumFunctions
getset

Number of functions.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain().

virtual bool IG.Num.VectorFunctionResults.CopyReferences
getset

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.

virtual IVector IG.Num.VectorFunctionResults.Parameters
getset

Optimization parameters. If CopyReferences=true (false by default) then only the reference is copied when assigning.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain().

virtual List<double> IG.Num.VectorFunctionResults.Values
getset

Function values. If CopyReferences=true (false by default) then only the list reference is copied in assignments.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual List<IVector> IG.Num.VectorFunctionResults.Gradients
getset

Function gradients. If CopyReferences=true (false by default) then only the list reference is copied in assignments.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual List<IMatrix> IG.Num.VectorFunctionResults.Hessians
getset

Functions' Hessians (matrices of second derivatives). If CopyReferences=true (false by default) then only the list reference is copied in assignments.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual bool IG.Num.VectorFunctionResults.ReqValues
getset

Indicates whether calculation of functions is/was requested.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain(), and IG.Num.LinearBasis.Example().

virtual bool IG.Num.VectorFunctionResults.ReqGradients
getset

Indicates whether calculation of function gradients is/was requested.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain(), and IG.Num.LinearBasis.Example().

virtual bool IG.Num.VectorFunctionResults.ReqHessians
getset

Indicates whether calculation of functions' Hessians is/was requested.

Referenced by IG.Num.VectorFunctionRequestDTO.CopyFromPlain(), and IG.Num.LinearBasis.Example().

virtual int IG.Num.VectorFunctionResults.ErrorCode
getset

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

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual String IG.Num.VectorFunctionResults.ErrorString
getset

Error string indicating what went wrong.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual bool IG.Num.VectorFunctionResults.Calculated
getset

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.

virtual bool IG.Num.VectorFunctionResults.CalculatedValues
getset

Indicates whether calculation of functions is/was requested.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual bool IG.Num.VectorFunctionResults.CalculatedGradients
getset

Indicates whether calculation of functions' gradients is/was requested.

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().

virtual bool IG.Num.VectorFunctionResults.CalculatedHessians
getset

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

Referenced by IG.Num.VectorFunctionResultsDto.CopyFromPlain().


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