Average-tree diversity (stub)#

Average displayed-tree diversity stubs.

class phypanda.measure.average_tree.AverageTreeDiversity#

Bases: object

Average displayed-tree diversity measure stub.

Examples

>>> import phypanda as pp
>>> # pp.average_tree.compute_diversity(network, {"a"})
compute_diversity(network: DirectedPhyNetwork, taxa: Set[str], **kwargs: Any) → float#

Compute average displayed-tree diversity.

Parameters:

  • network (DirectedPhyNetwork) – Input phylogenetic network.

  • taxa (Set[str]) – Selected taxa.

  • **kwargs (Any) – Unused measure-specific options.

Returns:

Average displayed-tree diversity value.

Return type:

float

solve_maximization(network: DirectedPhyNetwork, budget: int, costs: Mapping[str, int] | None = None, **kwargs: Any) → tuple[float, Set[str]]#

Solve average displayed-tree diversity maximization.

Parameters:

  • network (DirectedPhyNetwork) – Input phylogenetic network.

  • budget (int) – Integer budget.

  • costs (Mapping[str, int] | None, optional) – Optional taxon costs.

  • **kwargs (Any) – Unused optimization options.

Returns:

Objective value and selected taxa.

Return type:

tuple[float, Set[str]]