PhyloTree.TreeBuilding.CoalescentTree Class Reference

Contains methods to simulate coalescent trees. More...

Static Public Member Functions
static TreeNode	UnlabelledTree (int leafCount)
	Simulate an unlabelled coalescent tree. More...
static TreeNode	LabelledTree (IReadOnlyList< string > leafNames, TreeNode constraint=null)
	Simulate a labelled coalescent tree with the supplied tip labels. More...
static TreeNode	LabelledTree (int leafCount, TreeNode constraint=null)
	Simulate a labelled coalescent tree with the specified number of terminal nodes. More...

Detailed Description

Contains methods to simulate coalescent trees.

Definition at line 12 of file CoalescentTree.cs.

Member Function Documentation

LabelledTree() [1/2]

static TreeNode PhyloTree.TreeBuilding.CoalescentTree.LabelledTree ( int  leafCount, TreeNode  constraint = null  )

static

Simulate a labelled coalescent tree with the specified number of terminal nodes.

Parameters

leafCount	The number of terminal nodes in the tree. Their names will be in the form t1, t2, ..., tN, where N is leafCount .
constraint	A tree to constrain the sampling. The tree produced by this method will be compatible with this tree. The constraint tree can be multifurcating. Please note that, as the constraint is applied at every step while growing the tree, this will bias the sampled topology distribution.

Returns

A TreeNode object containing the labelled coalescent tree.

Definition at line 212 of file CoalescentTree.cs.

LabelledTree() [2/2]

static TreeNode PhyloTree.TreeBuilding.CoalescentTree.LabelledTree ( IReadOnlyList< string >  leafNames, TreeNode  constraint = null  )

static

Simulate a labelled coalescent tree with the supplied tip labels.

Parameters

leafNames	The labels for the terminal nodes of the tree.
constraint	A tree to constrain the sampling. The tree produced by this method will be compatible with this tree. The constraint tree can be multifurcating. Please note that, as the constraint is applied at every step while growing the tree, this will bias the sampled topology distribution.

Returns

A TreeNode object containing the labelled coalescent tree.

Definition at line 38 of file CoalescentTree.cs.

UnlabelledTree()

static TreeNode PhyloTree.TreeBuilding.CoalescentTree.UnlabelledTree ( int  leafCount )

static

Simulate an unlabelled coalescent tree.

Parameters

leafCount

The number of terminal nodes in the tree.

Returns

A TreeNode object containing the unlabelled coalescent tree.

Definition at line 19 of file CoalescentTree.cs.

---

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

• TreeBuilding/CoalescentTree.cs