Skip to main content

SimpleErrorUmiAssigner

Struct SimpleErrorUmiAssigner 

Source
pub struct SimpleErrorUmiAssigner { /* private fields */ }
Expand description

Simple error-tolerant UMI assigner

Groups UMIs that are within a specified edit distance using a simple clustering algorithm. When a new UMI is encountered, it is compared against existing groups. If it matches any UMI in a group, it is added to that group. If it matches multiple groups, those groups are merged. This can lead to transitive clustering where UMIs are grouped together even if they differ by more than the threshold.

§Algorithm

  1. For each UMI, find all existing groups that contain at least one UMI within threshold
  2. If no matches, create a new group
  3. If one match, add to that group
  4. If multiple matches, merge all matching groups

§Thread Safety

Uses atomic counter for ID generation, making it safe to use across threads.

Implementations§

Source§

impl SimpleErrorUmiAssigner

Source

pub fn new(max_mismatches: u32) -> SimpleErrorUmiAssigner

Create a new simple error-tolerant UMI assigner

§Arguments
  • max_mismatches - Maximum number of mismatches allowed between UMIs in the same group
§Returns

A new SimpleErrorUmiAssigner instance

Trait Implementations§

Source§

impl UmiAssigner for SimpleErrorUmiAssigner

Source§

fn assign(&self, raw_umis: &[String]) -> Vec<MoleculeId>

Assign molecule IDs to UMIs Read more
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to concrete type (for pattern matching) Read more
Source§

fn is_same_umi(&self, a: &str, b: &str) -> bool

Check if two UMIs are the same Read more
Source§

fn canonicalize(&self, umi: &str) -> String

Get canonical form of UMI Read more
Source§

fn split_templates_by_pair_orientation(&self) -> bool

Whether to split templates by pair orientation Read more

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.