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
general.Orthonormalizer Class Reference

Class that supports orthonormalization of vectors. More...

Detailed Description

Class that supports orthonormalization of vectors.

At the orthonormalization process a matrix G can be defined that defines the scalar product with respect to which the vectors are orthonormalized.

Original algorithm code from Bernard Haasdonk, rbmatlab. See rbmatlabroot/general/vecmat/orthonormalize*.m

Author
Daniel Wirtz
Date
24.08.2010
Change in 0.3:
(Syed Ammar, 2011-05-07) Implemented Setter for the properties G and Epsilon

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 18 of file Orthonormalizer.m.

Public Member Functions

function onvec = orthonormalize (vec)
 Performs orthogonalization using the given column vectors vec and the scalar product induced by the matrix G. 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 ()
 

Static Public Member Functions

static function res = test_Orthogonalization ()
 

Public Attributes

 G = 1
 The scalar product matrix \(<x,x> := x^tGx\). More...
 
 Epsilon = 1e-7
 Tolerance for zero columns at orthogonalization. More...
 
 Algorithm = "gs"
 The orthogonalization algorithm used. 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)
 

Member Function Documentation

function onvec = general.Orthonormalizer.orthonormalize (   vec)

Performs orthogonalization using the given column vectors vec and the scalar product induced by the matrix G.

Parameters
vecA matrix containing the column vectors to orthogonalize.

Definition at line 86 of file Orthonormalizer.m.

References Algorithm.

static function res = general.Orthonormalizer.test_Orthogonalization ( )
static

Definition at line 256 of file Orthonormalizer.m.

References k, and t.

Member Data Documentation

general.Orthonormalizer.Algorithm = "gs"

The orthogonalization algorithm used.

Possible choices are
"gs": Gram-Schmidt "ch": Cholesky-Decomposition "qr": QR-Decomposition
Note
Currently only "gs" is working properly.

Default: "gs"


Default: "gs"

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

Definition at line 66 of file Orthonormalizer.m.

Referenced by orthonormalize().

general.Orthonormalizer.Epsilon = 1e-7

Tolerance for zero columns at orthogonalization.


Default: 1e-7

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

Definition at line 57 of file Orthonormalizer.m.

general.Orthonormalizer.G = 1

The scalar product matrix \(<x,x> := x^tGx\).

Defaults to \(I_d\)


Default: 1

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

Definition at line 46 of file Orthonormalizer.m.


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