KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
data.ModelParam Class Reference

Stores model parameters. More...

Detailed Description

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.

Author
Daniel Wirtz
Date
2010-05-01
New in 1.0:
(Daniel Wirtz, 2014-09-10) Added spacing to constructor arguments
Change in 0.5:
(Daniel Wirtz, 2011-09-15) Added some documentation
Change in 0.3:
(Syed Ammar, 2011-05-10) Implemented setters for the properties

This class is part of the framework

KerMor - Model Order Reduction using Kernels

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...
 

Constructor & Destructor Documentation

data.ModelParam.ModelParam ( char  name,
double  default,
  varargin 
)

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.

Parameters
nameParameter name.
defaultThe default value
vararginExtra specifications
ModelParam ( ..., [ "Range", Range_value ] [, "Desired", Desired_value ]
[, "Spacing", Spacing_value ] )
Named Parameters for varargin:
  • Range Can be either a scalar or a 1x2 double vector.

    ( Default: [default * .9 default*1.1] )

  • Desired The desired number for GridSampling ( Default: 1 )
  • Spacing The intended sample spacing over the range Default: lin

Definition at line 148 of file ModelParam.m.

References Default, Desired, Name, Range, and Spacing.

Member Data Documentation

data.ModelParam.Default

The default value of this parameter.

Must be passed to constructor.

Note
This property has custom functionality when its value is changed.

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

See Also
sampling
Note
This property has custom functionality when its value is changed.

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.

Note
This property has the MATLAB attribute Dependent set to true.
Matlab documentation of property attributes.
[readonly]

Definition at line 132 of file ModelParam.m.

data.ModelParam.MaxVal

The minimum value of the parameters Range.

Note
This property has the MATLAB attribute Dependent set to true.
Matlab documentation of property attributes.
[readonly]

Definition at line 119 of file ModelParam.m.

data.ModelParam.MinVal

The maximum value of the parameter's data.ModelParam.Range.

Note
This property has the MATLAB attribute Dependent set to true.
Matlab documentation of property attributes.
[readonly]

Definition at line 106 of file ModelParam.m.

data.ModelParam.Name = "New Parameter"

The Name of the Parameter.

Default: New Parameter

Note
This property has custom functionality when its value is changed.

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: []

Note
This property has custom functionality when its value is changed.

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

Note
This property has custom functionality when its value is changed.

Definition at line 79 of file ModelParam.m.

Referenced by ModelParam().


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