sigalign_core/aligner/
mod.rs

1/*!
2Alignment executors.
3
4- `Regulator` is definition for the alignment results, guiding the alignment process.
5- Aligners are built from `Regulator`.
6
7Usage:
8```rust
9use sigalign_core::aligner::AlignmentRegulator;
10use sigalign_core::aligner::local::LocalAligner;
11
12let regulator = AlignmentRegulator::new(
13    4,   // Mismatch penalty
14    6,   // Gap open penalty
15    2,   // Gap extend penalty
16    50,  // Minimum length
17    0.1, // Maximum penalty per length
18).unwrap(); // Can occur `RegulatorError` when input is invalid
19
20let aligner = LocalAligner::new(regulator); // Never fails
21```
22*/
23
24// Common components
25//  - To make workspace
26mod workspace;
27//  - To define input parameters
28mod regulator;
29pub use regulator::{AlignmentRegulator, RegulatorError};
30
31/// Executing "local" alignment algorithm.
32pub mod local;
33// Executing "semi-global" alignment algorithm.
34pub mod semi_global;