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.selection.TimeSelector Class Reference

TimeSelector: Approximation training data selection utilizing time information. More...

Detailed Description

TimeSelector: Approximation training data selection utilizing time information.

This algorithm searches for unique values of times in the training data and determines how many samples for each time should be taken according to it's apperance in the training data. Due to rounding off numbers usually this process yields less than MaxSize elements, so additionally linspaced elements are selected to fill up the MaxSize selection.

Author
Daniel Wirtz
Date
2011-04-12
Change in 0.5:
(Daniel Wirtz, 2011-11-09) Re-enabled the use of this selector after adopting to new data.ApproxTrainData structure.
Change in 0.5:
(Daniel Wirtz, 2011-08-04) Disabled the use of this selector, as the new data.ATrajectoryData structure does not cater sensefully for this type of approximation training data selection.
New in 0.4:
(Daniel Wirtz, 2011-05-06)
Change in 0.3:
(Syed Ammar, 2011-04-20) Implemented Setters for the class properties.
New in 0.3:
(Daniel Wirtz, 2011-04-12) Added this class for a selection of training samples that utilizes time information.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 19 of file TimeSelector.m.

Public Member Functions

 TimeSelector ()
 
function copy = clone ()
 
- Public Member Functions inherited from data.selection.ASelector
 ASelector ()
 
function data.ApproxTrainData atd = selectTrainingData (model)
 Performs the selection procedure. More...
 
- Public Member Functions inherited from KerMorObject
 KerMorObject ()
 Constructs a new KerMor object. More...
 
function  display ()
 disp(object2str(this)); More...
 
function bool = eq (B)
 Checks equality of two KerMor objects. More...
 
function bool = ne (B)
 Checks if two KerMorObjects are different. More...
 
function cn = getClassName ()
 Returns the simple class name of this object without packages. More...
 
- Public Member Functions inherited from DPCMObject
 DPCMObject ()
 Creates a new DPCM object. More...
 
 DPCMObject ()
 
- Public Member Functions inherited from ICloneable
virtual function copy = clone (target)
 The interface method with returns a copy of the current class instance. More...
 

Public Attributes

 Size = 10000
 The (maximum) size of training samples to take. More...
 
 Seed = 1
 The seed for the per-time-random selection (to enable reproduction of results) More...
 
- Public Attributes inherited from data.selection.ASelector
logical EnsureUniqueData = true
 Flag to enable automatic "uniqueification" if selected training data. Uniqueness is determined by the state space samples xi; if any xi is included twice or more, it is discarded along with the fxi, ti, mui data of the replicates (independent of whether they are equal, too) More...
 
- Public Attributes inherited from DPCMObject
 WorkspaceVariableName = ""
 The workspace variable name of this class. Optional. More...
 
 ID = "[]"
 An ID that allows to uniquely identify this DPCMObject (at least within the current MatLab session/context). More...
 
 PropertiesChanged = "[]"
 The Dictionary containing all the property settings as key/value pairs. 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...
 

Protected Member Functions

function [ matrix xi , rowvec ti , matrix mui ,
fxi ] = 
select (models.BaseFullModel model)
 Performs selection of samples adjusted to the apperances of different times. More...
 
- Protected Member Functions inherited from KerMorObject
function  checkType (obj, type)
 Object typechecker. More...
 
- Protected Member Functions inherited from DPCMObject
function  registerProps (varargin)
 Call this method at any class that defines DPCM observed properties. More...
 
function  registerProps (varargin)
 

Additional Inherited Members

- Static Protected Member Functions inherited from DPCMObject
static function obj = loadobj (obj, from)
 Re-register any registered change listeners! More...
 
static function obj = loadobj (obj, from)
 

Constructor & Destructor Documentation

data.selection.TimeSelector.TimeSelector ( )

Definition at line 93 of file TimeSelector.m.

References DPCMObject.registerProps().

Here is the call graph for this function:

Member Function Documentation

function copy = data.selection.TimeSelector.clone ( )

Definition at line 99 of file TimeSelector.m.

References Seed, and Size.

function [ matrix xi , rowvec ti , matrix mui , fxi ] = data.selection.TimeSelector.select ( models.BaseFullModel  model)
protectedvirtual

Performs selection of samples adjusted to the apperances of different times.

Todo:
Adopt to current KerMor model data structure.
Parameters
modelThe full model with the training data
Return values
xiThe selected \(x_i = x(t_i)\) training data
tiThe selected training times \(t_i\)
muiThe selected parameter samples \(\mu_i\) with which the states \(x_i\) have been reached
Required fields of model:
Note
This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.
matlab documentation of method attributes.

Implements data.selection.ASelector.

Definition at line 109 of file TimeSelector.m.

References models.BaseFullModel.Data, data.ATrajectoryData.getNumTrajectories(), Seed, Size, models.BaseModel.Times, and data.ModelData.TrajectoryData.

Here is the call graph for this function:

Member Data Documentation

data.selection.TimeSelector.Seed = 1

The seed for the per-time-random selection (to enable reproduction of results)

Property class optional:
The seed for the random number generator.

Default: 1

Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
This property has custom functionality when its value is changed.

Definition at line 76 of file TimeSelector.m.

Referenced by clone(), and select().

data.selection.TimeSelector.Size = 10000

The (maximum) size of training samples to take.

Property class critical:
Determines the (maximum) size of the approximation training data samples to take.

Default: 10000

Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
This property has custom functionality when its value is changed.

Definition at line 60 of file TimeSelector.m.

Referenced by clone(), and select().


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