Struct Occasion

pub struct Occasion { /* private fields */ }

An occasion within a subject’s dataset

An Occasion represents a distinct period of data collection for a subject, such as a hospital visit or dosing regimen. It contains events (doses, observations) and time-varying covariates.

Implementations

impl Occasion

pub fn events(&self) -> Vec<&Event>

Get a vector of references to all events in this occasion

Returns

Vector of references to all events

pub fn index(&self) -> usize

Get the index of the occasion

Returns

The occasion index (0-based)

pub fn get_events( &self, reorder: Option<(&fn(&NalgebraVec<f64>, f64, &Covariates) -> HashMap<usize, f64>, &fn(&NalgebraVec<f64>, f64, &Covariates) -> HashMap<usize, f64>, &Vec<f64>, &Covariates)>, ignore: bool, ) -> Vec<Event>

Get events with modifications for lag time and bioavailability

Arguments

• lagtime - Optional map of compartment-specific lag times
• bioavailability - Optional map of compartment-specific bioavailability factors
• ignore - Whether to exclude events marked as “ignore”

Returns

Vector of events, potentially filtered and with times adjusted for lag and bioavailability

pub fn covariates(&self) -> &Covariates

Get the covariates for this occasion

Returns

Reference to the occasion’s covariates, if any

pub fn add_observation( &mut self, time: f64, value: f64, outeq: usize, errorpoly: Option<ErrorPoly>, )

Add an Observation event to the Occasion

pub fn add_missing_observation(&mut self, time: f64, outeq: usize)

Add a missing Observation event to the Occasion

pub fn add_observation_with_error( &mut self, time: f64, value: f64, outeq: usize, errorpoly: ErrorPoly, )

Add a missing Observation with a custom ErrorPoly to the Occasion

This is useful if you want a different weight for the observation

pub fn add_bolus(&mut self, time: f64, amount: f64, input: usize)

Add a Bolus event to the Occasion

pub fn add_infusion( &mut self, time: f64, amount: f64, input: usize, duration: f64, )

Add an Infusion event to the Occasion

pub fn events_mut(&mut self) -> &mut Vec<Event>

Get a mutable reference to the events

pub fn events_iter_mut(&mut self) -> IterMut<'_, Event>

Get a mutable iterator to the events

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

Get an iterator over all events

Returns

An iterator yielding references to events

pub fn iter_mut(&mut self) -> IterMut<'_, Event>

Get a mutable iterator over all events

Returns

A mutable iterator yielding references to events

pub fn len(&self) -> usize

Get the number of events in this occasion

Returns

The number of events

pub fn is_empty(&self) -> bool

Check if the occasion has any events

Returns

true if there are no events, false otherwise

Trait Implementations

impl Clone for Occasion

fn clone(&self) -> Occasion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Occasion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Occasion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Occasion

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Occasion

fn into_iter(self) -> <&'a Occasion as IntoIterator>::IntoIter

Iterate immutably over all events in the occasion

type Item = &'a Event

The type of the elements being iterated over.

type IntoIter = Iter<'a, Event>

Which kind of iterator are we turning this into?

impl<'a> IntoIterator for &'a mut Occasion

fn into_iter(self) -> <&'a mut Occasion as IntoIterator>::IntoIter

Iterate mutably over all events in the occasion

type Item = &'a mut Event

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Event>

Which kind of iterator are we turning this into?

impl IntoIterator for Occasion

fn into_iter(self) -> <Occasion as IntoIterator>::IntoIter

Consumes the occasion and yields owned events

type Item = Event

The type of the elements being iterated over.

type IntoIter = IntoIter<Event>

Which kind of iterator are we turning this into?

impl Serialize for Occasion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.