lib_ts_chainalign 4.0.1

A chaining-based sequence-to-sequence aligner that accounts for template switches
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use clap::ValueEnum;

/// Performance parameters for chainalign.
///
/// Use the `default()` method for a reasonable choice of parameters that works well in many cases.
pub struct AlignmentPerformanceParameters<Cost> {
    /// The step width for generating successors during chaining.
    ///
    /// At most `max_successors` will be generated at a time, but at least all with minimum chaining cost.
    pub max_successors: usize,

    /// The cost until which the cost function is initialised exactly.
    ///
    /// Anchor chainings with a higher exact cost are initialised based on the lower bound.
    pub max_exact_cost_function_cost: Cost,

    /// The closed list type to use for chaining.
    pub closed_list: ChainingClosedList,

    /// The open list type to use for chaining.
    pub open_list: ChainingOpenList,
}

/// The closed list type to use for chaining.
#[derive(Debug, Clone, ValueEnum)]
pub enum ChainingClosedList {
    /// Use [`HashMap`](std::collections::HashMap) as closed list with [`FxHasher`](rustc_hash::FxHasher) as hasher.
    FxHashMap,
    /// Use a special-purpose closed list.
    Special,
}

/// The open list type to use for chaining.
#[derive(Debug, Clone, ValueEnum)]
pub enum ChainingOpenList {
    /// Use [`BinaryHeap`](std::collections::BinaryHeap) as open list.
    StdHeap,
    /// Use [`LinearHeap`](generic_a_star::open_lists::linear_heap::LinearHeap) as open list.
    LinearHeap,
}

impl<Cost: From<u8>> Default for AlignmentPerformanceParameters<Cost> {
    fn default() -> Self {
        Self {
            max_successors: 1,
            max_exact_cost_function_cost: 1u8.into(),
            closed_list: ChainingClosedList::Special,
            open_list: ChainingOpenList::LinearHeap,
        }
    }
}