Struct AlignmentSummary 

pub struct AlignmentSummary { /* private fields */ }

Summary metadata for an alignment.

Implementations

impl AlignmentSummary

pub const fn new(kind: AlignmentKind) -> AlignmentSummary

Creates an alignment summary with no score or sequences.

pub const fn with_score(self, score: AlignmentScore) -> AlignmentSummary

Sets the alignment score.

pub fn with_sequence(self, sequence: AlignedSequence) -> AlignmentSummary

Adds an aligned sequence to the summary.

pub const fn kind(&self) -> &AlignmentKind

Returns the alignment kind.

pub const fn score(&self) -> Option<AlignmentScore>

Returns the optional alignment score.

pub fn sequences(&self) -> &[AlignedSequence]

Returns the aligned sequences.

pub const fn sequence_count(&self) -> usize

Returns the number of aligned sequences.

Trait Implementations

impl Clone for AlignmentSummary

fn clone(&self) -> AlignmentSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlignmentSummary

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

Formats the value using the given formatter.

impl PartialEq for AlignmentSummary

fn eq(&self, other: &AlignmentSummary) -> 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 StructuralPartialEq for AlignmentSummary