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
data.ATrajectoryData Class Referenceabstract

Data class that contains a model's large data, including subspace matrices, trajectories and approximation training data. More...

Detailed Description

Data class that contains a model's large data, including subspace matrices, trajectories and approximation training data.

Author
Daniel Wirtz
Date
2011-08-03
Change in 0.6:
(Daniel Wirtz, 2011-12-14) Now also storing the computation time ctime for a trajectory. This comes from the fact that for error estimator comparisons we need the ctime for each trajectory for every different error estimator. See the changes in models.BaseModel for more information.
New in 0.5:
(Daniel Wirtz, 2011-10-20) Added the ATrajectoryData.getBoundingBox method and implementations in MemoryTrajectoryData and FileTrajectoryData.
New in 0.5:
(Daniel Wirtz, 2011-08-03)
  • Added this class.
  • Removed the field ApproxfValues and put it into a struct with ApproxTrainData.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 18 of file ATrajectoryData.m.

Public Member Functions

function  transferFrom (data.ATrajectoryData source)
 Transfers the data from one ATrajectoryData instance to another. More...
 
function [ double t , dia ,
m ,
M ] = 
computeManifoldDiameters ()
 
function n = getNumBlocks ()
 % data.ABlockedData implementations More...
 
function B = getBlock (nr)
 
function [ n ,
m ] = 
size (dim)
 
virtual function [
colvec
< double > x , double ctime ] = 
getTrajectory (colvec< double > mu,integer inputidx)
 Gets the traejctory for the given parameter \(\mu\) and input index. More...
 
virtual function n = getNumTrajectories ()
 Gets the total number of trajectories. More...
 
virtual function lgetTotalLength ()
 Length of the stored trajectories. More...
 
virtual function [
colvec
< double > x , colvec< double > mu ,
integer
inputidx , double ctime ] = 
getTrajectoryNr (nr)
 Gets the trajectory with the number nr. More...
 
virtual function  addTrajectory (colvec< double > x,colvec< double > mu,integer inputidx,double ctime)
 Adds a trajectory to the ModelData instance. More...
 
virtual function  clearTrajectories ()
 Clears all stored trajectory data. More...
 
virtual function [
colvec
< double > x , X ] = 
getBoundingBox ()
 Gets the bounding box of the state space of all trajectories. More...
 
virtual function [
d ,
mud ] = 
getTrajectoryDoFs ()
 Returns the degrees of freedom for the trajectories and parameter size. More...
 
- Public Member Functions inherited from data.ABlockedData
function [ matrix< double > U ,
matrix
< double > S , matrix< double > V ] = 
getSVD (integer k,matrix< double > Vexclude,colvec< integer > targetdims)
 Computes an SVD on this blockwise matrix \(A = USV^T\). More...
 
function prod = mtimes ()
 Need left-sided matrix multiplication if RHS singular vectors V should be returned. More...
 
function A = toMemoryMatrix ()
 Converts this FileMatrix to a full double matrix. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from data.ABlockedData
static function res = test_BlockSVD_vs_SVD ()
 
- Public Attributes inherited from data.ABlockedData
double MinRelSingularValueSize = 1e-20
 The minimum relative value of singular values that triggers selection of the compared to the largest one. 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...
 

Member Function Documentation

function data.ATrajectoryData.addTrajectory ( colvec< double x,
colvec< double mu,
integer  inputidx,
double  ctime 
)
pure virtual

Adds a trajectory to the ModelData instance.

Parameters
xThe state variable vector \(\vx(t)\)
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidxThe index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.
ctimeThe computation time

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by models.BaseFullModel.off2_genTrainingData(), and transferFrom().

Here is the caller graph for this function:

function data.ATrajectoryData.clearTrajectories ( )
pure virtual

Clears all stored trajectory data.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by models.BaseFullModel.off2_genTrainingData(), and transferFrom().

Here is the caller graph for this function:

function [ double t , dia , m , M ] = data.ATrajectoryData.computeManifoldDiameters ( )
Todo:
implement!

Definition at line 68 of file ATrajectoryData.m.

function B = data.ATrajectoryData.getBlock (   nr)
virtual

Implements data.ABlockedData.

Reimplemented in data.MemoryTrajectoryData.

Definition at line 87 of file ATrajectoryData.m.

References getTrajectoryNr().

Here is the call graph for this function:

function [ colvec< double > x , X ] = data.ATrajectoryData.getBoundingBox ( )
pure virtual

Gets the bounding box of the state space of all trajectories.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

function n = data.ATrajectoryData.getNumBlocks ( )
virtual

% data.ABlockedData implementations

Implements data.ABlockedData.

Reimplemented in data.MemoryTrajectoryData.

Definition at line 77 of file ATrajectoryData.m.

References getNumTrajectories().

Referenced by data.FileTrajectoryData.getTotalLength().

Here is the call graph for this function:

Here is the caller graph for this function:

function n = data.ATrajectoryData.getNumTrajectories ( )
pure virtual
function l = data.ATrajectoryData.getTotalLength ( )
pure virtual

Length of the stored trajectories.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by size().

Here is the caller graph for this function:

function [ colvec< double > x , double ctime ] = data.ATrajectoryData.getTrajectory ( colvec< double mu,
integer  inputidx 
)
pure virtual

Gets the traejctory for the given parameter \(\mu\) and input index.

Parameters
muThe currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidxThe index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by models.BaseFullModel.computeTrajectory().

Here is the caller graph for this function:

function [ d , mud ] = data.ATrajectoryData.getTrajectoryDoFs ( )
pure virtual

Returns the degrees of freedom for the trajectories and parameter size.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by size().

Here is the caller graph for this function:

function [ colvec< double > x , colvec< double > mu , integer inputidx , double ctime ] = data.ATrajectoryData.getTrajectoryNr (   nr)
pure virtual

Gets the trajectory with the number nr.

Implemented in data.FileTrajectoryData, and data.MemoryTrajectoryData.

Referenced by getBlock(), models.BaseFullModel.plotTrajectoryNr(), and transferFrom().

Here is the caller graph for this function:

function [n , m ] = data.ATrajectoryData.size (   dim)
virtual

Implements data.ABlockedData.

Reimplemented in data.MemoryTrajectoryData.

Definition at line 92 of file ATrajectoryData.m.

References getTotalLength(), and getTrajectoryDoFs().

Referenced by data.FileTrajectoryData.addTrajectory(), data.FileTrajectoryData.consolidate(), and data.FileTrajectoryData.getTrajectoryDoFs().

Here is the call graph for this function:

Here is the caller graph for this function:

function data.ATrajectoryData.transferFrom ( data.ATrajectoryData  source)

Transfers the data from one ATrajectoryData instance to another.

Parameters
sourceThe source of data
Required fields of source:

Definition at line 50 of file ATrajectoryData.m.

References addTrajectory(), clearTrajectories(), getNumTrajectories(), and getTrajectoryNr().

Referenced by models.BaseFullModel.off2_genTrainingData(), and data.ModelData.useFileTrajectoryData().

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: