Struct VarLenKmer 

pub struct VarLenKmer<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> {
    pub storage: [T; LEN],
    pub phantom: PhantomData<KS>,
}

A fixed-length Kmer sequence that may not fill the bits of T

side: L R bases: 0 0 0 A C G T T bits: H …….. L bit : 14 12 10 8 6 4 2 0

sorting the integer will give a lexicographic sorting of the corresponding string. kmers that don’t fill storage are always aligned to the least significant bits

Fields

storage: [T; LEN]

phantom: PhantomData<KS>

Implementations

impl<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> VarLenKmer<T, LEN, KS>

pub fn unused_bits_mask(n_bases: usize) -> T

mask the unused bits at the top, plus the requested number of bases

Trait Implementations

impl<T: Clone + IntHelp + DeserializeOwned, const LEN: usize, KS: Clone + KmerSize> Clone for VarLenKmer<T, LEN, KS>

fn clone(&self) -> VarLenKmer<T, LEN, KS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + IntHelp + DeserializeOwned, const LEN: usize, KS: Copy + KmerSize> Copy for VarLenKmer<T, LEN, KS>

impl<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> Debug for VarLenKmer<T, LEN, KS>

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

Formats the value using the given formatter.

impl<'de, T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> Deserialize<'de> for VarLenKmer<T, LEN, KS>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq + IntHelp + DeserializeOwned, const LEN: usize, KS: Eq + KmerSize> Eq for VarLenKmer<T, LEN, KS>

impl<T: Hash + IntHelp + DeserializeOwned, const LEN: usize, KS: Hash + KmerSize> Hash for VarLenKmer<T, LEN, KS>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> Kmer for VarLenKmer<T, LEN, KS>

fn extend_left(&self, v: u8) -> Self

Shift the base v into the left end of the kmer

fn extend_right(&self, v: u8) -> Self

shift the base v into the right end of the k-mer

fn empty() -> Self

Create a Kmer initialized to all A’s

fn k() -> usize

K value for this concrete type.

fn to_u64(&self) -> u64

Return the rank of this kmer in an lexicographic ordering of all kmers E.g. ‘AAAA’ -> 0, ‘AAAT’ -> 1, etc. This will panic if K > 32.

fn from_u64(_v: u64) -> Self

Construct a kmer from the given lexicographic rank of the kmer. If K > 32, the leads bases will be A’s.

fn hamming_dist(&self, other: Self) -> u32

fn extend(&self, v: u8, dir: Dir) -> Self

Add the base v to the side of sequence given by dir, and remove a base at the opposite side

fn get_extensions(&self, exts: Exts, dir: Dir) -> Vec<Self>

Generate all the extension of this sequence given by exts in direction Dir

fn min_rc_flip(&self) -> (Self, bool)

Return the minimum of the kmer and it’s reverse complement, and a flag indicating if sequence was flipped

fn min_rc(&self) -> Self

Return the minimum of the kmer and it’s reverse complement

fn is_palindrome(&self) -> bool

Test if this Kmer and it’s reverse complement are the same

fn from_bytes(bytes: &[u8]) -> Self

Create a Kmer from the first K bytes of bytes, which must be encoded as the integers 0-4.

fn from_ascii(bytes: &[u8]) -> Self

Create a Kmer from the first K bytes of bytes, which must be encoded as ASCII letters A,C,G, or T.

fn to_string(&self) -> String

Return String containing Kmer sequence

fn kmers_from_bytes(str: &[u8]) -> Vec<Self>

Generate vector of all kmers contained in str encoded as 0-4.

fn kmers_from_ascii(str: &[u8]) -> Vec<Self>

Generate vector of all kmers contained in str, encoded as ASCII ACGT.

fn has_low_complexity(&self) -> bool

impl<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> Mer for VarLenKmer<T, LEN, KS>

fn get(&self, pos: usize) -> u8

Get the letter at the given position.

fn set_slice_mut(&mut self, pos: usize, n_bases: usize, value: u64)

Set a slice of bases in the kmer, using the packed representation in value. Sets n_bases, starting at pos. Incoming bases must always be packed into the front bits of the value.

fn rc(&self) -> Self

Return the reverse complement of this kmer

fn len(&self) -> usize

Length of DNA sequence

fn is_empty(&self) -> bool

True if the sequence is empty.

fn set_mut(&mut self, pos: usize, v: u8)

Set base at pos to 2-bit encoded base val

fn at_count(&self) -> u32

Count the number of A/T bases in the kmer

fn gc_count(&self) -> u32

Count the number of G/C bases in the kmer

fn iter(&self) -> MerIter<'_, Self>

Iterate over the bases in the sequence

impl<T: Ord + IntHelp + DeserializeOwned, const LEN: usize, KS: Ord + KmerSize> Ord for VarLenKmer<T, LEN, KS>

fn cmp(&self, other: &VarLenKmer<T, LEN, KS>) -> 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<T: PartialEq + IntHelp + DeserializeOwned, const LEN: usize, KS: PartialEq + KmerSize> PartialEq for VarLenKmer<T, LEN, KS>

fn eq(&self, other: &VarLenKmer<T, LEN, KS>) -> 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<T: PartialOrd + IntHelp + DeserializeOwned, const LEN: usize, KS: PartialOrd + KmerSize> PartialOrd for VarLenKmer<T, LEN, KS>

fn partial_cmp(&self, other: &VarLenKmer<T, LEN, KS>) -> 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<T: IntHelp + DeserializeOwned, const LEN: usize, KS: KmerSize> Serialize for VarLenKmer<T, LEN, KS>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq + IntHelp + DeserializeOwned, const LEN: usize, KS: PartialEq + KmerSize> StructuralPartialEq for VarLenKmer<T, LEN, KS>