Struct Covariate

pub struct Covariate { /* private fields */ }

A time-varying covariate consisting of computed segments

The covariate holds interpolated segments that are rebuilt whenever observations are modified. Original observation data is stored within the segments themselves.

Implementations

impl Covariate

pub fn new(name: String, fixed: bool) -> Covariate

Create a new covariate with the given name

Arguments

• name - The name of the covariate
• fixed - Whether this covariate should use carry-forward interpolation

pub fn add_observation(&mut self, time: f64, value: f64)

Add an observation to this covariate

If an observation already exists at this time, it will update that value instead of adding a new one.

pub fn update_observation(&mut self, time: f64, new_value: f64)

Update an observation at a specific time

pub fn remove_observation(&mut self, time: f64) -> bool

Remove an observation at a specific time

pub fn observations(&self) -> Vec<(f64, f64)>

Get all raw observations as time-value pairs

pub fn interpolate(&self, time: f64) -> Result<f64, CovariateError>

Interpolate the covariate value at a specific time

Returns the interpolated value if the time falls within any segment’s range, otherwise returns the last known observation value.

This method is optimized for sequential access patterns common in ODE solvers by caching the last used segment index.

pub fn name(&self) -> &str

Get the name of the covariate

pub fn set_fixed(&mut self, fixed: bool)

Set the covariate as fixed (use carry-forward interpolation)

This is useful when you want to treat a time-varying covariate as constant using carry-forward interpolation, which is common in pharmacokinetic modeling.

pub fn fixed(&self) -> bool

Check if this covariate is set to use carry-forward interpolation

Trait Implementations

impl Clone for Covariate

fn clone(&self) -> Covariate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Covariate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Covariate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Covariate

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

Formats the value using the given formatter.

impl Serialize for Covariate

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.