Struct AlignmentRegulator

pub struct AlignmentRegulator { /* private fields */ }

Definition for the alignment results.

Implementations

impl AlignmentRegulator

pub fn new( mismatch_penalty: u32, gap_open_penalty: u32, gap_extend_penalty: u32, minimum_alignment_length: u32, maximum_penalty_per_alignment_length: f32, ) -> Result<Self, RegulatorError>

Generate new aligner.

pub fn get_mismatch_penalty(&self) -> u32

Get mismatch penalty

pub fn get_gap_open_penalty(&self) -> u32

Get gap-open penalty

pub fn get_gap_extend_penalty(&self) -> u32

Get gap-extend penalty

pub fn get_minimum_length(&self) -> u32

Get minimum length

pub fn get_maximum_penalty_per_length(&self) -> f32

Get maximum penalty per length

pub fn get_pattern_size(&self) -> u32

Get size of pattern

Trait Implementations

impl Clone for AlignmentRegulator

fn clone(&self) -> AlignmentRegulator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlignmentRegulator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for AlignmentRegulator

fn cmp(&self, other: &AlignmentRegulator) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AlignmentRegulator

fn eq(&self, other: &AlignmentRegulator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AlignmentRegulator

fn partial_cmp(&self, other: &AlignmentRegulator) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for AlignmentRegulator

impl StructuralPartialEq for AlignmentRegulator