phylo 5.1.0

An extensible Phylogenetics library written in rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Ancestral Sequence Reconstruction (ASR).
//!
//! Reconstructs ancestral states at internal nodes of a phylogenetic tree given
//! observed sequences at the leaves.
//!
//! This is a thin layer over [`crate::tree::likelihood`], which holds the
//! substance: Felsenstein's pruning and the Viterbi recursion, generalized over
//! a model's rate categories. Reconstruction is the argmax (and, for the
//! marginal case, the posteriors) taken from that computation.

use crate::alignment::Alignment;
use crate::alphabet::Alphabet;
use crate::error::AsrError;
use crate::models::GtrModel;

pub use crate::tree::likelihood::Reconstruction;

/// Trait for performing marginal ancestral sequence reconstruction.
pub trait MarginalAsr {
    /// Performs marginal ML reconstruction of ancestral sequences.
    fn marginal_asr<A: Alphabet>(
        &self,
        model: &GtrModel<A>,
        aln: &Alignment,
        want_posteriors: bool,
    ) -> Result<Reconstruction<A>, AsrError>;
}

/// Trait for performing joint ancestral sequence reconstruction.
pub trait JointAsr {
    /// Performs joint ML reconstruction of ancestral sequences (Viterbi).
    fn joint_asr<A: Alphabet>(
        &self,
        model: &GtrModel<A>,
        aln: &Alignment,
    ) -> Result<Reconstruction<A>, AsrError>;
}