IGLib
1.7.2
The IGLib base library for development of numerical, technical and business applications.
|
Base class for various DTO (Data Transfer Objects) for scalar function controllers. Used to store a state of a scalar function. More...
Public Member Functions | |
ScalarFunctionScriptDtoBase () | |
Default constructor, sets IsNull to true. More... | |
ScalarFunctionScriptDtoBase (int spaceDimension) | |
Constructor, prepares the current DTO for storing a scalar function of the specified dimension. More... | |
abstract FunctionControllerType | CreateScalarFunctionController (int dimension) |
Creates and returns a new scalar function in the space of specific dimension. More... | |
override FunctionControllerType | CreateObject () |
Creates and returns a new vector of the specified type and dimension. More... | |
Protected Member Functions | |
override void | CopyFromPlain (ScalarFunctionScriptController functionController) |
Copies data to the current DTO from a scaalr function object. More... | |
override void | CopyToPlain (ref ScalarFunctionScriptController functionContrller) |
Copies data from the current DTO to a scalar function object. More... | |
Properties | |
virtual int | Dimension [get, set] |
Dimension of the parameter space. More... | |
virtual string | Name [get, set] |
Scalar function name. More... | |
virtual string | Description [get, set] |
Scalar function description. More... | |
virtual string[] | ParameterNames [get, set] |
Names of function parameters. More... | |
virtual bool | IsValueDefined [get, set] |
Whether function value is defined for the represented function. More... | |
virtual bool | IsGradientDefined [get, set] |
Whether function gradient is defined for the represented function. More... | |
virtual string | ValueDefinitonString [get, set] |
Definition of function value. More... | |
virtual string[] | GradientDefinitionStrings [get, set] |
Gradient definition strings (separately for each gradient component). More... | |
virtual string | ZType [get, set] |
virtual InputOutputDataDefinitonDto | ZDataDefinition [get, set] |
Base class for various DTO (Data Transfer Objects) for scalar function controllers. Used to store a state of a scalar function.
Beside as data transfer object, this class provides a variety of manipulations that are necessary when defining scalar functions from scripts (user definitions).
FunctionControllerType | Type parameter specifying the specific scalar function controller type for which concrete DTO is designed. |
$A Igor Feb16;
FunctionControllerType | : | ScalarFunctionScriptController |
|
inline |
Default constructor, sets IsNull to true.
|
inline |
Constructor, prepares the current DTO for storing a scalar function of the specified dimension.
spaceDimension | Dimension of a vector that is stored in the current DTO. |
|
pure virtual |
Creates and returns a new scalar function in the space of specific dimension.
dimension | Vector dimension. |
Implemented in IG.Num.ScalarFunctionScriptDto.
|
inline |
Creates and returns a new vector of the specified type and dimension.
|
inlineprotected |
Copies data to the current DTO from a scaalr function object.
functionController | Scalar function object from which data is copied. |
References IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.Description, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.Dimension, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.GradientDefinitionStrings, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.IsGradientDefined, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.IsValueDefined, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.Name, IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.ParameterNames, and IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.ValueDefinitonString.
|
inlineprotected |
Copies data from the current DTO to a scalar function object.
functionContrller | Scalar function object that data is copied to. |
|
getset |
Dimension of the parameter space.
|
getset |
Scalar function name.
|
getset |
Scalar function description.
|
getset |
Names of function parameters.
|
getset |
Whether function value is defined for the represented function.
|
getset |
Whether function gradient is defined for the represented function.
|
getset |
Definition of function value.
|
getset |
Gradient definition strings (separately for each gradient component).
|
getset |
|
getset |