Struct PopulationTable 

pub struct PopulationTable { /* private fields */ }

A population table

Examples

use tskit::PopulationTable;

let mut populations = PopulationTable::default();
let rowid = populations.add_row().unwrap();
assert_eq!(rowid, 0);
assert_eq!(populations.num_rows(), 1);

An example with metadata. This requires the cargo feature "derive" for tskit.

use tskit::PopulationTable;

#[derive(serde::Serialize,
         serde::Deserialize,
         tskit::metadata::PopulationMetadata)]
#[serializer("serde_json")]
struct PopulationMetadata {
    name: String,
}

let metadata = PopulationMetadata{name: "YRB".to_string()};

let mut populations = PopulationTable::default();

let rowid = populations.add_row_with_metadata(&metadata).unwrap();
assert_eq!(rowid, 0);

match populations.metadata::<PopulationMetadata>(rowid) {
    // rowid is in range, decoding succeeded
    Some(Ok(decoded)) => assert_eq!(&decoded.name, "YRB"),
    // rowid is in range, decoding failed
    Some(Err(e)) => panic!("error decoding metadata: {:?}", e),
    None => panic!("row id out of range")
}

Implementations

impl PopulationTable

pub fn num_rows(&self) -> SizeType

Return the number of rows.

pub fn metadata<T: PopulationMetadata>( &self, row: impl Into<PopulationId>, ) -> Option<Result<T, TskitError>>

Retrieve decoded metadata for a row.

Returns

• Some(Ok(T)) if row is valid and decoding succeeded.
• Some(Err(_)) if row is valid and decoding failed.
• None if row is not valid or the row has no metadata.

Errors

• TskitError::MetadataError if decoding fails.

Examples.

The big-picture semantics are the same for all table types. See crate::IndividualTable::metadata for examples.

pub fn iter(&self) -> impl Iterator<Item = Population<'_>>

Return an iterator over rows of the table. The value of the iterator is crate::Population.

pub fn row<P: Into<PopulationId> + Copy>(&self, r: P) -> Option<Population<'_>>

Parameters

• r: the row id.

Returns

• Some(row) if r is valid
• None otherwise

pub fn add_row(&mut self) -> Result<PopulationId, TskitError>

pub fn add_row_with_metadata<M: PopulationMetadata>( &mut self, metadata: &M, ) -> Result<PopulationId, TskitError>

pub fn clear(&mut self) -> Result<i32, TskitError>

Clear all data from the table

Trait Implementations

impl Debug for PopulationTable

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

Formats the value using the given formatter.

impl Default for PopulationTable

fn default() -> PopulationTable

Returns the “default value” for a type.