Struct tskit::types::Bookmark

pub struct Bookmark {
    pub offsets: tsk_bookmark_t,
}

A “bookmark” is used to adjust the ranges over which some table algorithms function.

For example, when sorting tables, a bookmark can be used to indicate the first row from which to begin. The names of the fields are the same names as tables in a TableCollection.

Fields

offsets: tsk_bookmark_t

Implementations

impl Bookmark

pub const fn new() -> Self

pub fn individuals(&self) -> SizeType

Get the current value

pub fn nodes(&self) -> SizeType

Get the current value

pub fn edges(&self) -> SizeType

Get the current value

pub fn migrations(&self) -> SizeType

Get the current value

pub fn sites(&self) -> SizeType

Get the current value

pub fn mutations(&self) -> SizeType

Get the current value

pub fn populations(&self) -> SizeType

Get the current value

pub fn provenances(&self) -> SizeType

Get the current value

pub fn set_individuals<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_nodes<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_edges<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_migrations<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_sites<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_mutations<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_populations<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

pub fn set_provenances<I: Into<tsk_size_t>>(&mut self, value: I)

Set the current value

Trait Implementations

impl Default for Bookmark

fn default() -> Self

Returns the “default value” for a type.