Struct mzpeaks::feature_map::FeatureMap

pub struct FeatureMap<X, Y, T: FeatureLike<X, Y>> { /* private fields */ }

Represents a sorted list of mass spectral features that is a concrete implementation of FeatureMapLike and FeatureMapLikeMut

Implementations

impl<'a, X, Y, T: FeatureLike<X, Y>> FeatureMap<X, Y, T>

pub fn new(features: Vec<T>) -> Self

Create a new FeatureMap from an existing Vec<T> and sorts the newly created structure to ensure it is ordered by coordinate X

pub fn empty() -> Self

pub fn wrap(features: Vec<T>) -> Self

Create a new FeatureMap from an existing Vec<T>, but does not actively sort the collection. It is up to the caller to ensure that the provided Vec is sorted or that it will be sorted prior to any of its search functionality is used.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> Iter<'_, T>

Iterate over references to features

pub fn iter_mut(&'a mut self) -> IterMut<'a, T>

Iterate over mutable reference to features

pub fn search_by(&self, query: f64) -> Result<usize, usize>

pub fn spanning(&'a self, y: f64) -> FeatureMap<X, Y, &T>

Extract a subset of this FeatureMap that overlap the specified y coordinate

pub fn from_iter<I: Iterator<Item = T>>(iter: I, sort: bool) -> Self

Trait Implementations

impl<X: Clone, Y: Clone, T: Clone + FeatureLike<X, Y>> Clone for FeatureMap<X, Y, T>

fn clone(&self) -> FeatureMap<X, Y, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X: Debug, Y: Debug, T: Debug + FeatureLike<X, Y>> Debug for FeatureMap<X, Y, T>

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

Formats the value using the given formatter.

impl<X: Default, Y: Default, T: Default + FeatureLike<X, Y>> Default for FeatureMap<X, Y, T>

fn default() -> FeatureMap<X, Y, T>

Returns the “default value” for a type.

impl<X, Y, T: FeatureLike<X, Y>> FeatureMapLike<X, Y, T> for FeatureMap<X, Y, T>

fn search_by(&self, query: f64) -> Result<usize, usize>

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn get_item(&self, i: usize) -> &T

Implement index access

fn get_slice(&self, i: Range<usize>) -> &[T]

fn _closest_feature( &self, query: f64, error_tolerance: Tolerance, i: usize ) -> Option<usize>

fn search(&self, query: f64, error_tolerance: Tolerance) -> Option<usize>

Find the nearest index for query within error_tolerance in this feature collection, or None.

fn has_feature(&self, query: f64, error_tolerance: Tolerance) -> Option<&T>

Return the feature nearest to query within error_tolerance in this feature collection, or None.

fn between(&self, low: f64, high: f64, error_tolerance: Tolerance) -> &[T]

Return a slice containing all features between low and high coordinates within error_tolerance.

fn all_features_for(&self, query: f64, error_tolerance: Tolerance) -> &[T]

Find all features which could match query within error_tolerance units

impl<X, Y, T: FeatureLike<X, Y>> FeatureMapLikeMut<X, Y, T> for FeatureMap<X, Y, T>

fn push(&mut self, feature: T)

Add feature to the collection, maintaining sort order and feature indexing.

fn sort(&mut self)

Sort the collection, updating the feature indexing.

impl<X, Y, T: FeatureLike<X, Y>> FromIterator<T> for FeatureMap<X, Y, T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<X, Y, T: FeatureLike<X, Y>> Index<Range<usize>> for FeatureMap<X, Y, T>

type Output = [<FeatureMap<X, Y, T> as Index<usize>>::Output]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X, Y, T: FeatureLike<X, Y>> Index<RangeFrom<usize>> for FeatureMap<X, Y, T>

type Output = [<FeatureMap<X, Y, T> as Index<usize>>::Output]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X, Y, T: FeatureLike<X, Y>> Index<RangeFull> for FeatureMap<X, Y, T>

type Output = [<FeatureMap<X, Y, T> as Index<usize>>::Output]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X, Y, T: FeatureLike<X, Y>> Index<RangeTo<usize>> for FeatureMap<X, Y, T>

type Output = [<FeatureMap<X, Y, T> as Index<usize>>::Output]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X, Y, T: FeatureLike<X, Y>> Index<usize> for FeatureMap<X, Y, T>

type Output = T

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X, Y, T: FeatureLike<X, Y>> IndexMut<usize> for FeatureMap<X, Y, T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.