IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.
|
Base class for one parametric families of real-valued functions of single variable. Parameters that completely define the function out of parametric family of functions can be queried or set. More...
Public Member Functions | |
RealFunctionOneParametric (double parameter) | |
Cobnstructor. Creates a new one parametric function with the specified parameter. | |
RealFunctionOneParametric (IVector parameters) | |
Cobnstructor. Creates a new one parametric function with the specified parameters. | |
override double[] | GetParameters () |
Returns parameters of the current parametric function as an array. Since this class is for one parametric family of functions, an array of length 1 is always returned. | |
override void | SetParameters (double[] parameters) |
Sets parameters of the current parametric functions, where parameters are specified as array. | |
override double | GetParameter (int which) |
Returns value of the specified parameter of the parameterized function. | |
override void | SetParameter (int which, double value) |
Sets the specific parameters of the parameterized function. | |
Static Protected Attributes | |
static Vector | _parAux = new Vector(1) |
Auxiliary vector whose only function is to enable calling base constructors with parameters specified as vector. | |
Properties | |
override IVector | Parameters [get, set] |
Gets or sets parameters that define the specific function out of parametric familiy of functions. Usually a reference is set or returned. | |
virtual double | Parameter [get, set] |
Gets or sets the (only) parameter that defines the current function out of parametric family of functions. | |
override int | NumParameters [get] |
Gets number of parameters that define the current function out of parametric family of functions. Always evaluates to 1 because this is a one parametric family of functions. | |
Private Member Functions | |
RealFunctionOneParametric () | |
Default constructor is inaccessible because it has no meaning. | |
Private Attributes | |
double | _parameter |
Base class for one parametric families of real-valued functions of single variable. Parameters that completely define the function out of parametric family of functions can be queried or set.
This base class does not implement data containing parameters. This enables to derive base classes with different representations of parameters, e.g. with only one number for one parametric functions. $A Igor Dec10;
IG::Num::RealFunctionOneParametric::RealFunctionOneParametric | ( | ) | [inline, private] |
Default constructor is inaccessible because it has no meaning.
IG::Num::RealFunctionOneParametric::RealFunctionOneParametric | ( | double | parameter | ) | [inline] |
Cobnstructor. Creates a new one parametric function with the specified parameter.
parameter | Parameter that define a specific function out of a parametric family of functions. |
IG::Num::RealFunctionOneParametric::RealFunctionOneParametric | ( | IVector | parameters | ) | [inline] |
Cobnstructor. Creates a new one parametric function with the specified parameters.
parameters | Vector of parameters that define a specific function out of a parametric family of functions. |
override double [] IG::Num::RealFunctionOneParametric::GetParameters | ( | ) | [inline] |
Returns parameters of the current parametric function as an array. Since this class is for one parametric family of functions, an array of length 1 is always returned.
Implements IG::Num::IRealFunctionParametric.
override void IG::Num::RealFunctionOneParametric::SetParameters | ( | double[] | parameters | ) | [inline] |
Sets parameters of the current parametric functions, where parameters are specified as array.
parameters | Array of parameters. Array length must be 1 because this class represents a one parametric family.. |
Implements IG::Num::IRealFunctionParametric.
override double IG::Num::RealFunctionOneParametric::GetParameter | ( | int | which | ) | [inline] |
Returns value of the specified parameter of the parameterized function.
which | Specifies which parameter is returned, must be 0 because this class represents a one parametric family of functions. |
Implements IG::Num::IRealFunctionParametric.
override void IG::Num::RealFunctionOneParametric::SetParameter | ( | int | which, |
double | value | ||
) | [inline] |
Sets the specific parameters of the parameterized function.
which | Specifies which parameter is set, must be 0 because this class represents a one parametric family of functions. |
value | Value of the specified parameter. |
Implements IG::Num::IRealFunctionParametric.
Vector IG::Num::RealFunctionOneParametric::_parAux = new Vector(1) [static, protected] |
Auxiliary vector whose only function is to enable calling base constructors with parameters specified as vector.
double IG::Num::RealFunctionOneParametric::_parameter [private] |
override IVector IG::Num::RealFunctionOneParametric::Parameters [get, set] |
Gets or sets parameters that define the specific function out of parametric familiy of functions. Usually a reference is set or returned.
Implements IG::Num::IRealFunctionParametric.
virtual double IG::Num::RealFunctionOneParametric::Parameter [get, set] |
Gets or sets the (only) parameter that defines the current function out of parametric family of functions.
Implements IG::Num::IRealFunctionOneParametric.
override int IG::Num::RealFunctionOneParametric::NumParameters [get] |
Gets number of parameters that define the current function out of parametric family of functions. Always evaluates to 1 because this is a one parametric family of functions.
Implements IG::Num::IRealFunctionParametric.