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
kernels.SigmoidKernel Class Reference

SIGMOIDKERNEL The sigmoid kernel. More...

Detailed Description

SIGMOIDKERNEL The sigmoid kernel.

This kernel is defined via \(K(x,y) = \tanh(\kappa<x,y> + \nu)\)

See Also
BaseKernel LinearKernel PolyKernel GaussKernel CombinationKernel
Author
Daniel Wirtz 23.03.2010

Definition at line 18 of file SigmoidKernel.m.

Public Member Functions

 SigmoidKernel (kappa, nu)
 
function copy = clone ()
 
function c = getGlobalLipschitz ()
 
function Nabla = getNabla (colvec< double > x,matrix< double > y)
 
function K = evaluate (colvec< double > x,matrix< double > y)
 
- Public Member Functions inherited from kernels.BaseKernel
 BaseKernel ()
 
function fcn = getLipschitzFunction ()
 Method that allows error estimators to obtain a lipschitz constant estimation function from this kernel. More...
 
function bool = eq (B)
 Checks if a kernel equals another kernel. More...
 
function copy = clone (copy)
 The interface method with returns a copy of the current class instance. More...
 
virtual function K = evaluate (matrix< double > x,matrix< double > y)
 Evaluation method for the current kernel. More...
 
virtual function Nabla = getNabla (x, y)
 Computes the partial derivatives with respect to each component of the first argument. 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 Attributes

 kappa = 1
 The factor for the scalar product inside tanh. More...
 
 nu = -1
 The constant inside tanh. More...
 
- Public Attributes inherited from kernels.BaseKernel
matrix< doubleG = 1
 The matrix \(\vG\) that induces the state space scalar product \(\spG{x}{y}\) and norm \(\noG{x-y}\) to use. More...
 
matrix< doubleP = "[]"
 Projection/selection matrix \(\vP\) for argument components. More...
 
logical IsRBF = false
 Flag that determines if the current kernel is a radial basis function, i.e. its evaluation is of the form \(\K(x,y) = \phi(\noG{x-y})\) for some scalar function \(\phi\). More...
 
logical IsScProd = false
 Flag that determines if the current kernel bases on scalar product evaluations, i.e. are of the form \(\K(x,y) = \phi(\spG{x}{y})\) for some scalar function \(\phi\). 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...
 

Additional Inherited Members

- 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)
 
- 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)
 
- Protected Attributes inherited from kernels.BaseKernel
 fG = 1
 
 fP = "[]"
 

Constructor & Destructor Documentation

kernels.SigmoidKernel.SigmoidKernel (   kappa,
  nu 
)

Definition at line 60 of file SigmoidKernel.m.

References kernels.BaseKernel.IsScProd, kappa, nu, and DPCMObject.registerProps().

Here is the call graph for this function:

Member Function Documentation

function copy = kernels.SigmoidKernel.clone ( )

Definition at line 72 of file SigmoidKernel.m.

References kappa, and nu.

function K = kernels.SigmoidKernel.evaluate ( colvec< double x,
matrix< double y 
)

Definition at line 102 of file SigmoidKernel.m.

References kernels.BaseKernel.G, kappa, nu, kernels.BaseKernel.P, and t.

function c = kernels.SigmoidKernel.getGlobalLipschitz ( )
virtual
Todo:
implement

Implements kernels.BaseKernel.

Definition at line 79 of file SigmoidKernel.m.

function Nabla = kernels.SigmoidKernel.getNabla ( colvec< double x,
matrix< double y 
)
Todo:
implement
Parameters
xThe state variable vector \(\vx(t)\)
yThe output variable vector \(\vy(t) = \vC(t,\vmu)\vx(t),~t=0\ldots T\) (general notation)

Definition at line 89 of file SigmoidKernel.m.

Member Data Documentation

kernels.SigmoidKernel.kappa = 1

The factor for the scalar product inside tanh.

Property class critical:
Greatly influences the kernels behaviour.


Default: 1

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

Definition at line 35 of file SigmoidKernel.m.

Referenced by clone(), evaluate(), and SigmoidKernel().

kernels.SigmoidKernel.nu = -1

The constant inside tanh.

Property class critical:
Greatly influences the kernels behaviour.


Default: -1

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

Definition at line 46 of file SigmoidKernel.m.

Referenced by clone(), evaluate(), and SigmoidKernel().


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