Struct Map

pub struct Map(/* private fields */);

A mapping from samples to populations.

Implementations

impl Map

pub fn from_all<I>(samples: I) -> Self

where I: IntoIterator<Item = Sample>,

Creates a new mapping by mapping all samples to the same, unnamed population.

pub fn from_path<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Creates a new mapping by reading a samples file at the provided path.

pub fn from_reader<R>(reader: R) -> Result<Self>

where R: Read,

Creates a new mapping by reading a samples file from the provided reader.

pub fn get_population_id(&self, sample: &Sample) -> Option<Id>

Returns the population id of a sample if defined, otherwise None.

pub fn get_sample(&self, id: Id) -> Option<&Sample>

Returns the sample with the provided id if defined, otherwise None.

pub fn get_sample_id(&self, sample: &Sample) -> Option<Id>

Returns the id of the provided sample if defined, otherwise None.

pub fn is_empty(&self) -> bool

Returns true if no samples are defined, false otherwise.

pub fn number_of_populations(&self) -> usize

Returns the number of populations in the mapping.

pub fn population_sizes(&self) -> HashMap<Id, usize>

Returns the number of samples defined for each population id.

pub fn samples(&self) -> impl Iterator<Item = &Sample>

Returns an iterator over the samples in the mapping.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.

impl Default for Map

fn default() -> Map

Returns the “default value” for a type.

impl<S, P> FromIterator<(S, P)> for Map

where S: Into<Sample>, P: Into<Population>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (S, P)>,

Creates a value from an iterator.

impl PartialEq for Map

fn eq(&self, other: &Map) -> 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 Eq for Map

impl StructuralPartialEq for Map