Struct umgap::tree::mix::MixCalculator

pub struct MixCalculator { /* private fields */ }

Expand description

Struct capable of aggregating of a list of nodes in a TaxonTree, using a hybrid approach between MRL and LCA. It can either prefer MRL or LCA more, depending on a given ratio.

Implementations§

impl MixCalculator

pub fn new(root: TaxonId, taxonomy: &TaxonList, factor: f32) -> Self

Constructs a MixCalculator for a given taxon tree.

§Arguments:

root, the root of the taxon tree.
taxonomy, the taxons, indexed by their id.
factor, A ratio (i.e. a number in [0.0, 1.0] which decides the ratio that MRL or LCA will be chosen as aggregation. If factor is 1, LCA will always be chosen; If factor is 0, MRL.

Trait Implementations§

impl Aggregator for MixCalculator

fn aggregate(&self, taxons: &HashMap<TaxonId, f32>) -> Result<TaxonId>

Aggregates a set of scored taxons into a resulting taxon id.

fn counting_aggregate(&self, taxons: &[TaxonId]) -> Result<TaxonId>

Aggregates a list of taxons into a resulting taxon id.

impl MultiThreadSafeAggregator for MixCalculator

Auto Trait Implementations§

impl RefUnwindSafe for MixCalculator

impl Send for MixCalculator

impl Sync for MixCalculator

impl Unpin for MixCalculator

impl UnwindSafe for MixCalculator

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.