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
KerMorObject Class Reference

Base class for any KerMor class. More...

Detailed Description

Base class for any KerMor class.

Every KerMor object is identifiable by a unique ID.

Moreover, a messaging system is about to be implemented in KerMor to obtain different modes of output and logging. Every class should have access to that system, therefore a protected method will be available within any subclass. (Current skeleton: logMessage)

Author
Daniel Wirtz
Date
2011-04-05
New in 0.3:
(Daniel Wirtz, 2011-04-21) Implemented the property default changed supervision system as described in Property classes and levels. Those changes affect most KerMor classes.
Change in 0.3:
(Daniel Wirtz, 2011-04-07)
  • Moved the checkType method from models.BaseModel to this class.
  • Removed the ALoadable class and moved the ID property here.
New in 0.3:
(Daniel Wirtz, 2011-04-05) Added this class to give any object a common base class and some shared functionality. For this version it will be loading and message logging, possibly cloning as well.

This class is part of the framework

KerMor - Model Order Reduction using Kernels
Todo:
Extract DPCS into single class and put onto matlab file exchange!

Definition at line 17 of file KerMorObject.m.

Public Member Functions

 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 ()
 

Protected Member Functions

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

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

KerMorObject.KerMorObject ( )

Constructs a new KerMor object.

Important notice at this stage: Due to possible multiple inheritance any object's constructor should check if any custom properties that are assigned during construction are already present / different from the default value given at property declaration. If so, chances are that the constructor is called again for the same object; in this case, assigning a new ID and property changed dictionary caused any old registered properties to be overwritten!

Definition at line 55 of file KerMorObject.m.

References DPCMObject.DPCMObject().

Referenced by approx.algorithms.ABase.ABase(), dscomponents.ACoreFun.ACoreFun(), dscomponents.AMassMatrix.AMassMatrix(), dscomponents.AOutputConv.AOutputConv(), data.selection.ASelector.ASelector(), error.lipfun.Base.Base(), kernels.BaseKernel.BaseKernel(), models.BaseModel.BaseModel(), general.regression.BaseScalarSVR.BaseScalarSVR(), solvers.BaseSolver.BaseSolver(), kernels.BaseKernel.eq(), kernels.KernelExpansion.KernelExpansion(), general.interpolation.KernelInterpol.KernelInterpol(), general.regression.KernelLS.KernelLS(), sampling.BaseSampler.loadobj(), dscomponents.AInputConv.loadobj(), dscomponents.AMassMatrix.loadobj(), dscomponents.AOutputConv.loadobj(), IClassConfig.loadobj(), kernels.BellFunction.loadobj(), approx.algorithms.ABase.loadobj(), general.DEIM.loadobj(), kernels.KernelExpansion.loadobj(), dscomponents.ACoreFun.loadobj(), and general.POD.POD().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

function KerMorObject.checkType (   obj,
  type 
)
protected

Object typechecker.

Checks if a given object is of the specified type and throws an error if not. Convenience method that can bu used in subclasses at any setter method that ensures the correct value type.

Note
This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.
matlab documentation of method attributes.

Definition at line 122 of file KerMorObject.m.

function KerMorObject.display ( )

disp(object2str(this));

Definition at line 72 of file KerMorObject.m.

References handle.disp.

function bool = KerMorObject.eq (   B)

Checks equality of two KerMor objects.

Override (with superclass method call) in subclasses for specific comparison.

Definition at line 81 of file KerMorObject.m.

Referenced by ne().

Here is the caller graph for this function:

function cn = KerMorObject.getClassName ( )

Returns the simple class name of this object without packages.

Definition at line 108 of file KerMorObject.m.

Referenced by kernels.config.ParamTimeExpansionConfig.collectRanges(), kernels.config.ExpansionConfig.collectRanges(), and IClassConfig.getValueRanges().

Here is the caller graph for this function:

function bool = KerMorObject.ne (   B)

Checks if two KerMorObjects are different.

Negates the result of eq(A,B) for KerMorObject.

Definition at line 95 of file KerMorObject.m.

References eq().

Referenced by models.muscle.System.configUpdated().

Here is the call graph for this function:

Here is the caller graph for this function:


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