Struct PairSet 

pub struct PairSet { /* private fields */ }

A collection of base pairs represented as compact integer keys.

Implementations

impl PairSet

pub fn new(length: usize) -> Self

Create an empty pair set for a given sequence length.

pub fn len(&self) -> usize

Number of pairs contained in the set.

pub fn is_empty(&self) -> bool

Returns true if there are no pairs.

pub fn insert(&mut self, pair: Pair) -> bool

Insert a new pair; returns true if it was newly inserted.

pub fn contains(&self, pair: &Pair) -> bool

Check if a pair exists in the set.

pub fn iter(&self) -> impl Iterator<Item = Pair> + '_

Iterator over all pairs in arbitrary order.

pub fn to_vec(&self) -> Vec<Pair>

Return all pairs as a Vec (for deterministic inspection).

pub fn length(&self) -> usize

Underlying sequence length (from the originating PairTable).

Trait Implementations

impl Clone for PairSet

fn clone(&self) -> PairSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PairSet

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

Formats the value using the given formatter.

impl Display for PairSet

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

Formats the value using the given formatter.

impl From<&PairTable> for PairSet

fn from(pt: &PairTable) -> Self

Converts to this type from the input type.

impl PartialEq for PairSet

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

impl StructuralPartialEq for PairSet