KerMor
0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
|
Stores model parameters. More...
Stores model parameters.
This is a simple container for model parameters that stores a parameters name and range as well as other parameter-related values.
This class is part of the framework
Homepage
http://www.morepas.org/software/index.htmlDocumentation
http://www.morepas.org/software/kermor/index.htmlLicense
KerMor license conditions Definition at line 18 of file ModelParam.m.
Public Member Functions | |
ModelParam (char name,double default, varargin) | |
Creates a new model parameter. More... | |
Public Attributes | |
char | Name = "New Parameter" |
The Name of the Parameter. More... | |
double | Range |
The range of the values the parameter may take. More... | |
integer | Desired = 1 |
For Sampling: The desired number of samples. This field may be used differently, refer to the sampling module for its usage. More... | |
char | Spacing = "lin" |
Sets the desired sampling type for random or grid sampling. More... | |
double | Default |
The default value of this parameter. More... | |
double | MinVal |
The maximum value of the parameter's data.ModelParam.Range. More... | |
double | MaxVal |
The minimum value of the parameters Range. More... | |
boolean | HasRange |
Flag that indicates if this parameter is constant or has a range to vary within. More... | |
Public Attributes inherited from handle | |
addlistener | |
Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More... | |
notify | |
Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More... | |
delete | |
Handle object destructor method that is called when the object's lifecycle ends. More... | |
disp | |
Handle object disp method which is called by the display method. See the MATLAB disp function. More... | |
display | |
Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More... | |
findobj | |
Finds objects matching the specified conditions from the input array of handle objects. More... | |
findprop | |
Returns a meta.property objects associated with the specified property name. More... | |
fields | |
Returns a cell array of string containing the names of public properties. More... | |
fieldnames | |
Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More... | |
isvalid | |
Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More... | |
eq | |
Relational functions example. See details for more information. More... | |
transpose | |
Transposes the elements of the handle object array. More... | |
permute | |
Rearranges the dimensions of the handle object array. See the MATLAB permute function. More... | |
reshape | |
hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More... | |
sort | |
ort the handle objects in any array in ascending or descending order. More... | |
Creates a new model parameter.
If an argument is specified, all have to be specified. This is only done to enable creation of empty ModelParam-instances for cell arrays, for example.
name | Parameter name. |
default | The default value |
varargin | Extra specifications [, "Spacing", Spacing_value ] )
|
Definition at line 148 of file ModelParam.m.
data.ModelParam.Default |
The default value of this parameter.
Must be passed to constructor.
Definition at line 92 of file ModelParam.m.
Referenced by ModelParam().
data.ModelParam.Desired = 1 |
For Sampling: The desired number of samples. This field may be used differently, refer to the sampling module for its usage.
Default: 1
Definition at line 65 of file ModelParam.m.
Referenced by ModelParam().
data.ModelParam.HasRange |
Flag that indicates if this parameter is constant or has a range to vary within.
Dependent
set to true. Definition at line 132 of file ModelParam.m.
data.ModelParam.MaxVal |
The minimum value of the parameters Range.
Dependent
set to true. Definition at line 119 of file ModelParam.m.
data.ModelParam.MinVal |
The maximum value of the parameter's data.ModelParam.Range.
Dependent
set to true. Definition at line 106 of file ModelParam.m.
data.ModelParam.Name = "New Parameter" |
The Name of the Parameter.
Default: New Parameter
Definition at line 45 of file ModelParam.m.
Referenced by ModelParam().
data.ModelParam.Range |
The range of the values the parameter may take.
Double the range in case a scalar is passed.
Default: []
Definition at line 55 of file ModelParam.m.
Referenced by ModelParam().
data.ModelParam.Spacing = "lin" |
Sets the desired sampling type for random or grid sampling.
Allowed values are lin
(linear) and log
(logarithmic w.r.t base 10)
Default: lin
Definition at line 79 of file ModelParam.m.
Referenced by ModelParam().