Struct demes::Deme

source · [−]

pub struct Deme(_);

Expand description

A resolved deme.

Implementations

source

impl Deme

source

pub fn time_interval(&self) -> TimeInterval

The resolved time interval

source

pub fn start_time(&self) -> Time

The resolved start time

source

pub fn name(&self) -> Ref<'_, String>

Deme name

source

pub fn num_ancestors(&self) -> usize

Number of ancestors

source

pub fn ancestor_names(&self) -> Ref<'_, [String]>

Names of ancestor demes.

Empty of no ancestors.

source

pub fn description(&self) -> String

Description string

source

pub fn num_epochs(&self) -> usize

Obtain the number of Epoch instances.

Examples

See here.

source

pub fn epochs(&self) -> Ref<'_, [Epoch]>

Resolved epochs

source

pub fn get_epoch(&self, epoch: usize) -> Option<Epoch>

Returns a copy of the Epoch at index epoch.

Examples

See here for examples.

source

pub fn proportions(&self) -> Ref<'_, [Proportion]>

Resolved proportions

source

pub fn ancestors(&self) -> Ref<'_, HashMap<String, Deme>>

Hash map of ancestor name to ancestor deme

source

pub fn start_size(&self) -> DemeSize

Resolved start size

source

pub fn end_size(&self) -> DemeSize

Resolved end size

source

pub fn start_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Vector of resolved start sizes.

The values are obtained by traversing all epochs.

source

pub fn end_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Vector of resolved start sizes

The values are obtained by traversing all epochs.

source

pub fn end_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Vector of resolved end times

The values are obtained by traversing all epochs.

source

pub fn start_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Vector of resolved start times

The values are obtained by traversing all epochs.

source

pub fn end_time(&self) -> Time

End time of the deme.

Obtained from the value stored in the most recent epoch.

Trait Implementations

source

impl Clone for Deme

source

fn clone(&self) -> Deme

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Deme

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for Deme

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl PartialEq<Deme> for Deme

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

source

impl Serialize for Deme

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Eq for Deme

Auto Trait Implementations

impl !RefUnwindSafe for Deme

impl !Send for Deme

impl !Sync for Deme

impl Unpin for Deme

impl !UnwindSafe for Deme

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

Struct demes::Deme

Implementations

impl Deme

pub fn time_interval(&self) -> TimeInterval

pub fn start_time(&self) -> Time

pub fn name(&self) -> Ref<'_, String>

pub fn num_ancestors(&self) -> usize

pub fn ancestor_names(&self) -> Ref<'_, [String]>

pub fn description(&self) -> String

pub fn num_epochs(&self) -> usize

pub fn epochs(&self) -> Ref<'_, [Epoch]>

pub fn get_epoch(&self, epoch: usize) -> Option<Epoch>

pub fn proportions(&self) -> Ref<'_, [Proportion]>

pub fn ancestors(&self) -> Ref<'_, HashMap<String, Deme>>

pub fn start_size(&self) -> DemeSize

pub fn end_size(&self) -> DemeSize

pub fn start_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn end_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn end_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn start_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn end_time(&self) -> Time

Trait Implementations

impl Clone for Deme

fn clone(&self) -> Deme

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

impl Debug for Deme

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

impl<'de> Deserialize<'de> for Deme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl PartialEq<Deme> for Deme

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Serialize for Deme

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

impl Eq for Deme

Auto Trait Implementations

impl !RefUnwindSafe for Deme

impl !Send for Deme

impl !Sync for Deme

impl Unpin for Deme

impl !UnwindSafe for Deme

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

pub fn start_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn end_sizes(&self) -> Vec<DemeSize>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn end_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn start_times(&self) -> Vec<Time>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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

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

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

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,