Detailed Description

Data Tree element which can be filtered by time instants.

The children branches of this data tree node are all tagged with a time interval, either discrete (time steps) or continuous (time instants).

The branches can then be accessed via the nt argument of the get_index() method.

Definition at line 18 of file TpartNode.m.

Inheritance diagram for DataTree.TpartNode:

[legend]

Collaboration diagram for DataTree.TpartNode:

[legend]

Public Member Functions
	TpartNode (tpart_map, initvalues, overlap)
	refiner = [];DefaultRefiner; constructor of initializing a TpartNode More...

function tstop =	index_valid_till (index)
	returns the last valid time instance of a given entity in the tpart_map. More...

function index =	get_index (id, mu, nt)
	Obtains the leaf index vector that best fits the child description given by the three arguments. More...

function indices =	get_indices_in_region (ids, mu_geo, tslice)
	needs to be implemented... More...

function tree =	create_tree (creator, ids, mu_cube, tslice, basepath)
	Creates a new tree from a subtree specified by ids, parameter and time index regions. More...

function	refine (indices, midpoints)
	% Other methods refines the T-Partitioning by refining the tpart_map. More...

Public Member Functions inherited from DataTree.DefaultNode
function data =	get (index)
	Access to a child of the current node. More...

function children =	length ()
	Returns the number of children of the node. More...

function this =	set (index, value)
	Sets a child at the given path in the tree hierarchy. More...

Public Member Functions inherited from DataTree.INode
virtual function DataTree.INode tree =	create_tree (DataTree.ICreator creator, ids, mu_cube, tslice, basepath)
	Creates a new tree from a subtree specified by ids, parameter and time index regions. More...

function	leaf_func (funcptr, ids, mu_cube, tslice)
	applies a function to all leafs of a DataTree More...

function tree =	create_scalar_tree (funcptr, ids, mu_cube, tslice)
	copies the current trees with different leafs. These leafs are computes by a function returning scalar values. More...

function start_index =	traverse_start ()
	Start iterator for a full traverse of the DataTree. More...

function next_index =	traverse_next (this_index)
	iterator for a full traverse of the DataTree. More...

function description =	get_active_leaf_description (IModel model, ids)
	returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...

function description =	get_leaf_description (ids, mu_cube, tslice)
	returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...

function tstop =	index_valid_till (index)
	Returns the last valid time step index of a time slice. More...

function INode data =	get_by_description (id, mu, nt)
	A combination of get_index() and get() More...

function active_leaf_index =	get_active_leaf_index (IModel model, id)
	retuns the leaf element index for the current IDetailedModel configuration. More...

function DataTree.LeafNode active_leaf =	get_active_leaf (IModel model, id)
	retuns the leaf element for the current IDetailedModel configuration. More...

function	display (fn, basepath, name)
	overwrites the standard display method for DataTree objects More...

function lines =	disp_node (basepath, fn)
	returns a cell array of strings with information on the node. More...

Public Attributes
XPartMap	tpart_map
	an object holding the time intervals. More...

Public Attributes inherited from DataTree.DefaultNode
	values = "[]"
	cell array of DataTree.INode elements, holding the childrens of this DataTree.INode. More...

Static Public Attributes
static const	data_node_type = "TPart"
	Data node type identifier. More...

Protected Attributes
	invmap
	struct mapping between time instants and indices of children. (?)

	overlap = 0
	an optional argument specifying whether the time slices overlap, and how much they do... More...

Constructor & Destructor Documentation

DataTree.TpartNode.TpartNode	(	tpart_map,
		initvalues,
		overlap
	)

refiner = [];DefaultRefiner; constructor of initializing a TpartNode

Paramters: tpart_map: the T-partitioning map of type XPartMap. initivalues: a cell array of DataTree.INode objects for the initial values of the children. overlap: initial value for overlap property.

Parameters

tpart_map	tpart map
initvalues	initvalues
overlap	overlap

Required fields of tpart_map:

siz — siz

Definition at line 81 of file TpartNode.m.

Here is the call graph for this function:

Member Function Documentation

function tree = DataTree.TpartNode.create_tree	(	creator,
		ids,
		mu_cube,
		tslice,
		basepath
	)

Creates a new tree from a subtree specified by ids, parameter and time index regions.

The method creates a new DataTree for all nodes tagged by an id in ids, lying in the time slice given by tslice and inside the parameter space region given by mu_rect. At each of these nodes a method from a creator is called to build the tree.

Parameters

creator	an object creating the new tree.
ids	a cell array of ids which shall be filtered. An empty cell array means that all ids are accepted. (default = [])
mu_cube	a `1x2`-cell array of vectors `{ lower_left, upper_right }` specifying the lower left and the upper right corner of a cube in the parameter space for filtering parameter vectors. An empty array disables the filtering (default = []).
tslice	a 2D vector specifying an interval of time step indices for time slicing. An empty vector disables the filtering (default = [])
basepath	a vector specifying the relation of the current node to the parent node at which the merge began.

Return values

tree	the newly created tree

Calls DataTree.Creator.create_tpart_node() to build new elements.

Definition at line 179 of file TpartNode.m.

Here is the call graph for this function:

function index = DataTree.TpartNode.get_index	(	id,
		mu,
		nt
	)

virtual

Obtains the leaf index vector that best fits the child description given by the three arguments.

Todo:: add get_indices method returning indices in a range

The leaf child description consists of an

id string,
a parameter vector and
a time step number.

Parameters

id	a string id filtered through an DataTree.IdMapNode in the tree hierarchy.
mu	a parameter vector filtered through a DataTree.PpartNode instance in the tree hierarchy.
nt	an integer corresponding to a time step index filtered through a DataTree.TpartNode instance in the tree hierarchy.

Return values

index the most-specific (longest possible) index vector leading to a DataTree.ILeafNode element matching the child description.

Reimplemented from DataTree.DefaultNode.

Definition at line 146 of file TpartNode.m.

function indices = DataTree.TpartNode.get_indices_in_region	(	ids,
		mu_geo,
		tslice
	)

needs to be implemented...

Todo:: implement

Parameters

ids	ids
mu_geo	mu geo
tslice	tslice

Return values

indices indices

Definition at line 165 of file TpartNode.m.

function tstop = DataTree.TpartNode.index_valid_till ( index )

returns the last valid time instance of a given entity in the tpart_map.

Parameters

index index of the T-Partitioning interval.

Return values

tstop time instance when the requested time interval ends.

Definition at line 122 of file TpartNode.m.

function DataTree.TpartNode.refine	(	indices,
		midpoints
	)

% Other methods refines the T-Partitioning by refining the tpart_map.

Parameters

indices	indices of partitioning intervals to be refined.
midpoints	optional parameter for the refinement method XPartMap.refine() specifying how the geometries shall be split. (default = `[]`)

Definition at line 227 of file TpartNode.m.

Here is the call graph for this function:

Member Data Documentation

DataTree.TpartNode.data_node_type = "TPart"

static

Data node type identifier.

Default: "TPart"

Definition at line 50 of file TpartNode.m.

DataTree.TpartNode.overlap = 0

protected

an optional argument specifying whether the time slices overlap, and how much they do...

Default: 0

Definition at line 69 of file TpartNode.m.

DataTree.TpartNode.tpart_map

an object holding the time intervals.

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

Definition at line 37 of file TpartNode.m.

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

general/+DataTree/TpartNode.m

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation