SeedNtHash

Struct SeedNtHash 

Source
pub struct SeedNtHash<'a> { /* private fields */ }
Expand description

Struct for computing spaced-seed ntHash values in a re-computational manner. Can handle multiple seeds and generates multiple hashes per k-mer.

Implementations§

Source§

impl<'a> SeedNtHash<'a>

Source

pub fn new( seq: &'a [u8], seed_masks: &[String], num_hashes_per_seed: usize, k: u16, start_pos: usize, ) -> Result<Self>

Creates a new hasher from a sequence and spaced-seed masks.

§Errors

Returns an error if k is zero, the sequence is too short, or a mask is invalid.

Source

pub fn from_care_indices( seq: &'a [u8], seeds: Vec<Vec<usize>>, num_hashes_per_seed: usize, k: u16, start_pos: usize, ) -> Result<Self>

Alternative constructor using pre-parsed care indices (skips mask parsing).

Source

pub fn pos(&self) -> usize

Returns the current position in the sequence.

Source

pub fn hashes(&self) -> &[u64]

Returns the current set of hash values.

Source

pub fn roll(&mut self) -> bool

Advances the iterator by one position. On first call, searches for the first valid k-mer (initialization).

Auto Trait Implementations§

§

impl<'a> Freeze for SeedNtHash<'a>

§

impl<'a> RefUnwindSafe for SeedNtHash<'a>

§

impl<'a> Send for SeedNtHash<'a>

§

impl<'a> Sync for SeedNtHash<'a>

§

impl<'a> Unpin for SeedNtHash<'a>

§

impl<'a> UnwindSafe for SeedNtHash<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.