IClassConfig: Abstract interface for a set of configurations that can be applied to a given algorithm. More...

Detailed Description

IClassConfig: Abstract interface for a set of configurations that can be applied to a given algorithm.

See Also: kernels.RBFConfig general.regression.EpsSVRConfig

Author: Daniel Wirtz

Date: 2012-11-22

New in 0.7:: (Daniel Wirtz, 2012-11-22) 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

Definition at line 17 of file IClassConfig.m.

Public Member Functions
function lbl =	getAxisLabels (nrs)

function double t =	getValueRanges ()

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

virtual function integer n =	getNumConfigurations ()
	Returns the number of configurations that can be applied. More...

virtual function ICloneable object =	configureInstance (integer nr)
	Creates a new instance with given configuration. More...

virtual function integer str =	getConfigurationString (integer nr,logical asCell)
	Returns the number of configurations that can be applied. More...

virtual function char str =	getConfiguredPropertiesString ()
	Returns a string of the changed properties by this IClassConfig instance. More...

virtual function IClassConfig conf =	getSubPart (integer partNr,integer totalParts)
	Returns a sub-part of this configuration as a new instance. 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	test_ClassConfigPlots ()

Public Attributes
ICloneable	Prototype
	The prototype class that is to be used as base class before configuring a new instance. 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 ptype =	getProtoClass ()

function idx =	getPartIndices (partNr, totalParts)

function	addRange (ptable, proppath, minval, maxval)

virtual function	collectRanges (ptable, proppath)

function obj =	loadobj (from)

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)

Protected Attributes
char	RequiredPrototypeClass = "[]"
	Determines the class that is allowed to be configured. More...

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)

Member Function Documentation

function IClassConfig.addRange	(	ptable,
		proppath,
		minval,
		maxval
	)

protected

Definition at line 136 of file IClassConfig.m.

References Utils.implode().

Referenced by general.regression.EpsSVRConfig.collectRanges(), general.regression.NuSVRConfig.collectRanges(), kernels.config.PolyConfig.collectRanges(), kernels.config.RBFConfig.collectRanges(), kernels.config.WendlandConfig.collectRanges(), and general.regression.KernelLSConfig.collectRanges().

Here is the call graph for this function:

Here is the caller graph for this function:

function copy = IClassConfig.clone ( target )

virtual

The interface method with returns a copy of the current class instance.

Parameters

target If clone was called for a subclass of this class, target must contain the new instance of the subclass that is to be the cloned result.

Implements ICloneable.

Definition at line 109 of file IClassConfig.m.

References Prototype, and RequiredPrototypeClass.

Referenced by kernels.config.ExpansionConfig.clone(), approx.algorithms.Componentwise.clone(), and kernels.config.ParamTimeExpansionConfig.clone().

Here is the caller graph for this function:

virtual function IClassConfig.collectRanges	(	ptable,
		proppath
	)

protectedpure virtual

Implemented in kernels.config.ExpansionConfig, kernels.config.ParamTimeExpansionConfig, general.regression.KernelLSConfig, kernels.config.WendlandConfig, kernels.config.RBFConfig, kernels.config.PolyConfig, general.regression.EpsSVRConfig, general.regression.NuSVRConfig, and general.interpolation.InterpolConfig.

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

Here is the caller graph for this function:

function ICloneable object = IClassConfig.configureInstance ( integer nr )

pure virtual

Creates a new instance with given configuration.

Parameters

nr	The configuration number

Return values

object The configured object

Implemented in general.regression.KernelLSConfig.

Referenced by kernels.config.ExpansionConfig.configureInstance(), and kernels.config.ParamTimeExpansionConfig.configureInstance().

Here is the caller graph for this function:

function lbl = IClassConfig.getAxisLabels ( nrs )

Definition at line 67 of file IClassConfig.m.

References getConfigurationString(), getNumConfigurations(), and Utils.implode().

Here is the call graph for this function:

function integer str = IClassConfig.getConfigurationString	(	integer	nr,
		logical	asCell
	)

pure virtual

Returns the number of configurations that can be applied.

Parameters

nr	The configuration number
asCell	Flag to indicate that each setting that can be done should be placed in a cell of a cell array.

Return values

str

Referenced by getAxisLabels(), kernels.config.ExpansionConfig.getConfigurationString(), and kernels.config.ParamTimeExpansionConfig.getConfigurationString().

Here is the caller graph for this function:

function char str = IClassConfig.getConfiguredPropertiesString ( )

pure virtual

Returns a string of the changed properties by this IClassConfig instance.

Return values

str	The string

Implemented in kernels.config.ParamTimeExpansionConfig, general.regression.KernelLSConfig, kernels.config.RBFConfig, kernels.config.WendlandConfig, kernels.config.ExpansionConfig, kernels.config.PolyConfig, general.interpolation.InterpolConfig, general.regression.EpsSVRConfig, and general.regression.NuSVRConfig.

Referenced by kernels.config.ExpansionConfig.getConfiguredPropertiesString(), and kernels.config.ParamTimeExpansionConfig.getConfiguredPropertiesString().

Here is the caller graph for this function:

function integer n = IClassConfig.getNumConfigurations ( )

pure virtual

Returns the number of configurations that can be applied.

Return values

n	The number of configurations

Implemented in kernels.config.ParamTimeExpansionConfig, kernels.config.PolyConfig, kernels.config.RBFConfig, general.regression.EpsSVRConfig, general.regression.NuSVRConfig, kernels.config.ExpansionConfig, general.regression.KernelLSConfig, and general.interpolation.InterpolConfig.

Referenced by getAxisLabels(), kernels.config.ExpansionConfig.getNumConfigurations(), kernels.config.ParamTimeExpansionConfig.getNumConfigurations(), getPartIndices(), approx.algorithms.Componentwise.getTotalNumConfigurations(), approx.algorithms.ABase.getTotalNumConfigurations(), approx.algorithms.Componentwise.plotSummary(), and approx.algorithms.Componentwise.templateComputeApproximation().

Here is the caller graph for this function:

function idx = IClassConfig.getPartIndices	(	partNr,
		totalParts
	)

protected

Definition at line 130 of file IClassConfig.m.

References getNumConfigurations().

Referenced by general.regression.EpsSVRConfig.getSubPart(), general.regression.NuSVRConfig.getSubPart(), kernels.config.GaussConfig.getSubPart(), kernels.config.PolyConfig.getSubPart(), kernels.config.RBFConfig.getSubPart(), kernels.config.WendlandConfig.getSubPart(), and general.regression.KernelLSConfig.getSubPart().

Here is the call graph for this function:

Here is the caller graph for this function:

function ptype = IClassConfig.getProtoClass ( )

protected

Definition at line 122 of file IClassConfig.m.

References ICloneable.clone(), and Prototype.

Referenced by general.interpolation.InterpolConfig.configureInstance(), general.regression.EpsSVRConfig.configureInstance(), general.regression.NuSVRConfig.configureInstance(), kernels.config.ExpansionConfig.configureInstance(), kernels.config.RBFConfig.configureInstance(), general.regression.KernelLSConfig.configureInstance(), and kernels.config.PolyConfig.configureInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

function IClassConfig conf = IClassConfig.getSubPart	(	integer	partNr,
		integer	totalParts
	)

pure virtual

Returns a sub-part of this configuration as a new instance.

Use the helper method getPartIndices to obtain the correct indices of the configurations that belong to a specific part.

Parameters

partNr	The part number
totalParts	The total number of parts

Return values

conf	A copy containing the configurations of the specified part

Referenced by kernels.config.ExpansionConfig.getSubPart(), and kernels.config.ParamTimeExpansionConfig.getSubPart().

Here is the caller graph for this function:

function double t = IClassConfig.getValueRanges ( )

Definition at line 80 of file IClassConfig.m.

References collectRanges(), KerMorObject.getClassName(), and t.

Referenced by approx.algorithms.ABase.getApproximationSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

function obj = IClassConfig.loadobj ( from )

protected

Definition at line 209 of file IClassConfig.m.

References KerMorObject.KerMorObject().

Here is the call graph for this function:

static function IClassConfig.test_ClassConfigPlots ( )

static

Definition at line 221 of file IClassConfig.m.

References handle.disp.

Member Data Documentation

IClassConfig.Prototype

The prototype class that is to be used as base class before configuring a new instance.

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

Definition at line 42 of file IClassConfig.m.

Referenced by clone(), general.regression.EpsSVRConfig.EpsSVRConfig(), kernels.config.ExpansionConfig.ExpansionConfig(), kernels.config.GaussConfig.GaussConfig(), getProtoClass(), general.interpolation.InterpolConfig.InterpolConfig(), general.regression.KernelLSConfig.KernelLSConfig(), general.regression.NuSVRConfig.NuSVRConfig(), kernels.config.ParamTimeExpansionConfig.ParamTimeExpansionConfig(), kernels.config.PolyConfig.PolyConfig(), approx.algorithms.Componentwise.templateComputeApproximation(), and kernels.config.WendlandConfig.WendlandConfig().

IClassConfig.RequiredPrototypeClass = "[]"

protected

Determines the class that is allowed to be configured.

Default: []

Definition at line 55 of file IClassConfig.m.

Referenced by clone(), general.regression.EpsSVRConfig.EpsSVRConfig(), kernels.config.ExpansionConfig.ExpansionConfig(), kernels.config.GaussConfig.GaussConfig(), general.interpolation.InterpolConfig.InterpolConfig(), general.regression.KernelLSConfig.KernelLSConfig(), general.regression.NuSVRConfig.NuSVRConfig(), kernels.config.ParamTimeExpansionConfig.ParamTimeExpansionConfig(), kernels.config.PolyConfig.PolyConfig(), kernels.config.RBFConfig.RBFConfig(), and kernels.config.WendlandConfig.WendlandConfig().

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

core/interfaces/IClassConfig.m

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation