Componentwise: Component-wise kernel approximation with fixed center set. More...

Detailed Description

Componentwise: Component-wise kernel approximation with fixed center set.

Author: Daniel Wirtz

Date: 2011-06-01

Change in 0.7:: (Daniel Wirtz, 2011-11-22) Moved Componentwise.guessGammas to kernels.config.ExpansionConfig

Change in 0.5:

(Daniel Wirtz, 2011-11-02)

New interface for approximation computation: Passing an data.ApproxTrainData instance now instead of xi,ti,mui parameters.
Re-enabled the clone method
Using the new data.ApproxTrainData for guessGammas

New in 0.5:

(Daniel Wirtz, 2011-10-14)

Added the method Componentwise.guessGammas as a helper method to determine suitable Gaussian kernel configurations.
This algorithm now also works with kernels.ParamTimeKernelExpansion's

New in 0.5:: (Daniel Wirtz, 2011-07-07) Moved the old approx.Componentwise class to this class.

New in 0.4:: (Daniel Wirtz, 2011-06-01) Added this class.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Homepage http://www.morepas.org/software/index.html
Documentation http://www.morepas.org/software/kermor/index.html
License KerMor license conditions

Todo:: think of new structure on how to combine this with the getDists in AAdaptiveBase (or extract convenience methods further, general concept of "KernelConfig")

Definition at line 19 of file Componentwise.m.

Public Member Functions
	Componentwise ()

function copy =	clone ()
	Clones the instance. More...

function pm =	plotSummary (pm)
	Overrides the approx.algorithms.ABase function. More...

function [ str , rangetab ] =	getApproximationSummary ()

function nc =	getTotalNumConfigurations ()

function mink =	collectFromExpConfigSplit (algs)

Public Member Functions inherited from approx.algorithms.ABase
	ABase ()

function copy =	clone (copy)
	The interface method with returns a copy of the current class instance. More...

function kernels.KernelExpansion kexp =	computeApproximation (data.ApproxTrainData atd, avd)

function [ str , rangetab ] =	getApproximationSummary ()
	Setup. More...

function	plotSummary (pm, context)

function nc =	getTotalNumConfigurations ()

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

Public Attributes
IClassConfig	CoeffConfig = "[]"
	The different coefficient computation algorithm configurations to try. The IClassConfig.Prototype is used as actual algorithm, and needs to implement the IKernelCoeffComp interface. More...

integer	BestCoeffConfig
	The index of the best coefficient computation configuration. More...

matrix< double >	SingleRuntimes
	The times needed for the coefficients to compute for each exp/coeffcomp configuration. More...

Public Attributes inherited from approx.algorithms.ABase
kernels.config.ExpansionConfig	ExpConfig = "[]"
	The different kernel expansion configurations to try. More...

	UsefScaling = false
	Flag that determines whether the approximation center f values should be scaled to [-1,1] before the approximation is computed. More...

function_handle	ErrorFun = @Norm.L2
	The error function to apply on each data vector. More...

double	LastCompTime = "[]"
	The computation time for the last run in seconds. More...

matrix< double >	MaxErrors = "[]"
	For each configuration, contains a row with the maximum errors on the training data. The number of columns depends on the type of algorithm implemented by the subclasses. More...

matrix< double >	MaxRelErrors = "[]"
	For each configuration, contains a row with the maximum relative errors on the training data. The number of columns depends on the type of algorithm implemented by the subclasses. More...

matrix< double >	ValidationErrors = "[]"
	For each configuration, contains a row with the maximum errors on the validation data. The number of columns depends on the type of algorithm implemented by the subclasses. More...

matrix< double >	ValidationRelErrors = "[]"
	For each configuration, contains a row with the maximum relative errors on the validation data. The number of columns depends on the type of algorithm implemented by the subclasses. More...

matrix< integer >	StopFlags = "[]"
	For each effective configuration, the stop flags are stored here. More...

integer	BestExpConfig
	Index of the best expansion config determined by the algorithm. 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...

Public Attributes inherited from IParallelizable
	ComputeParallel = false
	Flag whether the code should be run in parallel or not. More...

Protected Member Functions
function kernels.KernelExpansion kexp =	templateComputeApproximation (data.ApproxTrainData atd, avd)

Protected Member Functions inherited from approx.algorithms.ABase
function [ double val , integer idx , rowvec errs ] =	getError (kernels.KernelExpansion kexp,data.ApproxTrainData atd)
	Computes the error according to the chosen error function (see ErrorFun property) with respect to the current kernel expansion and the \(f(x_i)\) values in the training data. More...

virtual function	templateComputeApproximation (kernels.KernelExpansion kexp,data.ApproxTrainData atd, avd)
	Performs the actual approximation after scaling. 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)

Static Protected Member Functions
static function this =	loadobj ()

Static Protected Member Functions inherited from approx.algorithms.ABase
static function this =	loadobj (this, initfrom)

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)

Additional Inherited Members
Protected Attributes inherited from approx.algorithms.ABase
	ScalingG
	If UsefScaling is set to true, this matrix contains the scaling matrix which has to be used in sub-algorithms in order to compute the correct approximation error on training data. More...

Constructor & Destructor Documentation

approx.algorithms.Componentwise.Componentwise ( )

Definition at line 122 of file Componentwise.m.

References CoeffConfig, and DPCMObject.registerProps().

Here is the call graph for this function:

Member Function Documentation

function copy = approx.algorithms.Componentwise.clone ( )

Clones the instance.

Generated fields of copy:

Definition at line 132 of file Componentwise.m.

References BestCoeffConfig, IClassConfig.clone(), CoeffConfig, and SingleRuntimes.

Here is the call graph for this function:

function mink = approx.algorithms.Componentwise.collectFromExpConfigSplit ( algs )

Definition at line 215 of file Componentwise.m.

References BestCoeffConfig, approx.algorithms.ABase.BestExpConfig, approx.algorithms.ABase.ExpConfig, kernels.config.ExpansionConfig.getNumConfigurations(), k, approx.algorithms.ABase.LastCompTime, approx.algorithms.ABase.MaxErrors, approx.algorithms.ABase.MaxRelErrors, SingleRuntimes, approx.algorithms.ABase.StopFlags, approx.algorithms.ABase.ValidationErrors, and approx.algorithms.ABase.ValidationRelErrors.

Here is the call graph for this function:

function [str , rangetab ] = approx.algorithms.Componentwise.getApproximationSummary ( )

Definition at line 191 of file Componentwise.m.

References BestCoeffConfig, CoeffConfig, and handle.disp.

function nc = approx.algorithms.Componentwise.getTotalNumConfigurations ( )

Definition at line 207 of file Componentwise.m.

References CoeffConfig, and IClassConfig.getNumConfigurations().

Here is the call graph for this function:

static function this = approx.algorithms.Componentwise.loadobj ( )

staticprotected

Definition at line 468 of file Componentwise.m.

References SingleRuntimes.

function pm = approx.algorithms.Componentwise.plotSummary ( pm )

Overrides the approx.algorithms.ABase function.

Required fields of pm:

Generated fields of pm:

Definition at line 156 of file Componentwise.m.

References CoeffConfig, approx.algorithms.ABase.ExpConfig, kernels.config.ExpansionConfig.getNumConfigurations(), IClassConfig.getNumConfigurations(), LogPlot.logsurf(), approx.algorithms.ABase.MaxErrors, approx.algorithms.ABase.MaxRelErrors, t, approx.algorithms.ABase.ValidationErrors, approx.algorithms.ABase.ValidationRelErrors, X, and Y.

Here is the call graph for this function:

function kernels.KernelExpansionkexp = approx.algorithms.Componentwise.templateComputeApproximation	(	data.ApproxTrainData	atd,
			avd
	)

protected

static function res = approx.algorithms.Componentwise.test_Componentwise ( )

static

Definition at line 483 of file Componentwise.m.

Member Data Documentation

approx.algorithms.Componentwise.BestCoeffConfig

The index of the best coefficient computation configuration.

Property class data:: This property is the result if algorithm execution.

Default: []

See Also: CoeffConfig

Note: This property has the MATLAB attribute SetObservable set to true.; Matlab documentation of property attributes.

Definition at line 77 of file Componentwise.m.

Referenced by clone(), collectFromExpConfigSplit(), getApproximationSummary(), and templateComputeApproximation().

approx.algorithms.Componentwise.CoeffConfig = "[]"

The different coefficient computation algorithm configurations to try. The IClassConfig.Prototype is used as actual algorithm, and needs to implement the IKernelCoeffComp interface.

Property class critical:: Without this setting this algorithm makes little sense.

Default: general.interpolation.InterpolConfig

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 59 of file Componentwise.m.

Referenced by clone(), Componentwise(), getApproximationSummary(), getTotalNumConfigurations(), plotSummary(), and templateComputeApproximation().

approx.algorithms.Componentwise.SingleRuntimes

The times needed for the coefficients to compute for each exp/coeffcomp configuration.

Default: []

Note: This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public; Matlab documentation of property attributes.

Definition at line 97 of file Componentwise.m.

Referenced by clone(), collectFromExpConfigSplit(), loadobj(), and templateComputeApproximation().

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

core/+approx/+algorithms/Componentwise.m

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation