Functions and Formulas

Hierarchical

hDistribute

Splits up a given total top-down in a hierarchy, distributing each parent's value between its children relative to the children's input weights.

Collection hDistribute(Collection x, Object total, boolean useArity=false, Collection tree=nothing, Collection subsystemmatrix=nothing, boolean usearity-1=false, Collection tree-1=nothing, Collection subsystemmatrix-1=nothing)

Parameters

x :	is the Vector of raw weights
total :	is the given total
useArity :
tree :
subsystemmatrix :
usearity-1 :
tree-1 :
subsystemmatrix-1 :

hGet

maps the argument to a lower hierarchy level.

Collection hGet(Collection x)

Parameters

x :

the argument

hMax

Calculates the maximum of all values defined for the children of a tree node.

Collection hMax(Collection container, Object tree=nothing, Object tree-1=nothing, boolean ignoreempty=false)

Parameters

container :	A vector with the values of all child items
tree :
tree-1 :
ignoreempty :

hMean

Calculates the geometric mean of all values defined for the children of a tree node.

Collection hMean(Collection container, Object tree=nothing, Object tree-1=nothing, boolean ignoreempty=false)

Parameters

container :	A vector with the values of all child items
tree :
tree-1 :
ignoreempty :

hMin

Calculates the minimum of all values defined for the children of a tree node.

Collection hMin(Collection container, Object tree=nothing, Object tree-1=nothing, boolean ignoreempty=false)

Parameters

container :	A vector with the values of all child items
tree :
tree-1 :
ignoreempty :

hNorm

Normalizes the numbers belonging to one group in a container to a given total.

Collection hNorm(Collection x, Numeric total=1.0)

Parameters

x :	detects empty rows or columns in a matrix or tensor.\|is the matrix or tensor to be checked\|is the row dimension index or tree\|is the column dimension index or tree
total :	Normalizes the numbers in a container to a total of 1.0.\|is the container which contains the values you want to normalize.\|is the level of details to operate on\|specifies the dimension for the operation if the source is a multi-dimensional collection

hPercentage

Normalizes the numbers of a container belonging to one group to 100%.

Collection hPercentage(Collection x)

Parameters

x :

detects empty rows or columns in a matrix or tensor.|is the matrix or tensor to be checked|is the row dimension index or tree|is the column dimension index or tree

hProd

Calculates the product of all values defined for the children of a tree node.

Collection hProd(Collection container, Object tree=nothing, Object tree-1=nothing, boolean ignoreempty=false)

Parameters

container :	A vector with the values of all child items
tree :
tree-1 :
ignoreempty :

hProduct

Multiplies the cells of a matrix with the (hidden) group level cells.

Collection hProduct(Collection matrix, Collection tree)

Parameters

matrix :	A matrix defined on at least one tree with a depth > 1
tree :	one of the two matrix trees whose hierarchy is used for the accumulation

hRSS

Collection hRSS(Collection x, Object tree=nothing)

Parameters

x :
tree :

hSum

Sums up the values of the given argument hierarchically.

Collection hSum(Collection x, Object tree=nothing, Collection x-1, Object tree-1=nothing, boolean ignoreempty=false)

Parameters

x :	is the vector containing the values.
tree :
x-1 :	is the vector containing the values.
tree-1 :
ignoreempty :	is the vector containing the values.

numChildren

Calculates the number of children for each node in a tree.

Collection numChildren(Collection x, boolean constraints=false)

Parameters

x :	Calculates the number of children for each node in a tree.\|is the tree
constraints :

numInputs

Counts the number of relations on the input side of each node. Relations are taken from the tree structure (child-to-parent) or a connected dsm matrix.

Collection numInputs(Collection x, boolean constraints=false, boolean dsm=true)

Parameters

x :	is the list or tree containing the nodes.
constraints :	set to true, if nodes marked as constraint shall be visited.
dsm :	manages the use of dsm matrices: - "false": use only the tree structure - "true": use the tree structure and the connected dsm matrix (if there is any) - link to a dedicated dsm matrix: use only this matrix, ignore the tree structure

Result

A column compatible to input x containing the counts.

Remarks

Relations taken from the tree structure are counted as "1". Relations from the dsm matrix are counted using the relation value, e.g. 1, 3, 9.

numOutputs

Counts the number of relations on the output side of each node. Relations are taken from the tree structure (parent-to-child) or a connected dsm matrix.

Collection numOutputs(Collection x, boolean constraints=false, boolean dsm=true)

Parameters

x :	is the list or tree containing the nodes.
constraints :	set to true, if nodes marked as constraint shall be visited.
dsm :	manages the use of dsm matrices: - "false": use only the tree structure - "true": use the tree structure and the connected dsm matrix (if there is any) - link to a dedicated dsm matrix: use only this matrix, ignore the tree structure

Result

A column compatible to input x containing the counts.

Remarks

Relations taken from the tree structure are counted as "1". Relations from the dsm matrix are counted using the relation value, e.g. 1, 3, 9.

Feedback

Did you find what you needed?

If you have any further questions or suggestions to improve this page, please let us know: