mkbush

Create bushy tree

Syntax

[Tree,NumStates = mkbush(NumLevels,NumChild,NumPos)

[Tree,NumStates = mkbush(___,Trim,NodeVal)

Description

[Tree,NumStates = mkbush(NumLevels,NumChild,NumPos) creates a bushy tree Tree with initial values NodeVal at each node.

[Tree,NumStates = mkbush(___,Trim,NodeVal) adds optional arguments for Trim and NodeVal.

Examples

Create Bushy Tree

This example shows how to create a tree with four time levels, two branches per node, and a vector of three elements in each node with each element initialized to NaN.

Tree = mkbush(4, 2, 3);
treeviewer(Tree) 

Input Arguments

NumLevels — Number of time levels of the tree

numeric

Number of time levels of the tree, specified as a scalar numeric.

Data Types: double

NumChild — Number of branches (children) of the nodes in each level

vector

Number of branches (children) of the nodes in each level, specified as a 1-by- number of levels (NUMLEVELS) vector.

Data Types: double

NumPos — Length of the state vectors in each time level

vector

Length of the state vectors in each time level, specified as a 1-by-NUMLEVELS vector.

Data Types: double

Trim — Indicates movement between nodes

0 (default) | logical

(Optional) Indicates movement between nodes, specified as a scalar 0 or 1. If Trim = 1, NumPos decreases by 1 when moving from one time level to the next. Otherwise, if Trim = 0, NumPos does not decrease.

Data Types: logical

NodeVal — Initial value at each node of the tree

NaN (default) | numeric

(Optional) Initial value at each node of the tree, specified as a scalar numeric.

Data Types: double

Output Arguments

Tree — Bushy tree

struct

Bushy tree, returned as a tree struct with initial values NodeVal at each node.

NumStates — Number of state vectors in each level

vector

Number of state vectors in each level, returned as a 1-by-NUMLEVELS vector.

Version History

Introduced before R2006a