phylo2vec.sample_vector

Contents

phylo2vec.sample_vector#

phylo2vec.sample_vector(n_leaves: int, ordered: bool = False) → ndarray[source]#

Sample a random tree via Phylo2Vec, in vector form.

Parameters:

  • n_leaves (int) – Number of leaves (>= 2)

  • ordered (bool, optional) –

    If True, sample an ordered tree, by default False

    True: v_i in {0, 1, …, i} for i in (0, n_leaves-1)

    False: v_i in {0, 1, …, 2*i} for i in (0, n_leaves-1)

Returns:

Phylo2Vec vector

Return type:

numpy.ndarray

Contents