Header menu logo BioFSharp

PhylogeneticTree Module

Functions and values

Function or value Description

countBranches tree

Full Usage: countBranches tree

Parameters:
Returns: int

Returns the count of branches

tree : PhylogeneticTree<'T>
Returns: int

countLeafs tree

Full Usage: countLeafs tree

Parameters:
Returns: int

Returns the count of leaves

tree : PhylogeneticTree<'T>
Returns: int

fold folder acc tree

Full Usage: fold folder acc tree

Parameters:
Returns: 'State

Iterates through a tree and accumulates a value by applying the folder to it and every branch and leaf.

folder : 'State -> 'T -> 'State
acc : 'State
tree : PhylogeneticTree<'T>
Returns: 'State

iter branchAction leafAction tree

Full Usage: iter branchAction leafAction tree

Parameters:

Iterates trough a tree and performs an action on every branch and leaf

branchAction : 'T -> unit
leafAction : 'T -> unit
tree : PhylogeneticTree<'T>

map branchTagMapping leafTagMapping tree

Full Usage: map branchTagMapping leafTagMapping tree

Parameters:
    branchTagMapping : 'T -> 'U
    leafTagMapping : 'T -> 'U
    tree : PhylogeneticTree<'T>

Returns: PhylogeneticTree<'U>

Iterates trough a tree and transforms all branch and leaf values by applying a mapping function on them

branchTagMapping : 'T -> 'U
leafTagMapping : 'T -> 'U
tree : PhylogeneticTree<'T>
Returns: PhylogeneticTree<'U>

Type something to start searching.