Struct Covariates

pub struct Covariates { /* private fields */ }

A collection of Covariates

This struct provides methods to manage multiple covariates and retrieve interpolated values for all covariates at specific time points.

Implementations

impl Covariates

pub fn new() -> Covariates

Create a new empty collection of covariates

pub fn covariates(&self) -> HashMap<String, &Covariate>

Get all covariates in this collection

pub fn add_covariate(&mut self, name: String, covariate: Covariate)

Add a covariate to the collection

This method allows you to add a new covariate with a specific name and its associated data.

pub fn get_covariate(&self, name: &str) -> Option<&Covariate>

Get access to a specific covariate by name

pub fn get_covariate_mut(&mut self, name: &str) -> Option<&mut Covariate>

Get access to a specific covariate by name

pub fn remove_covariate(&mut self, name: &str) -> Option<Covariate>

Remove a covariate by name

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

Add an observation to a covariate, creating the covariate if it doesn’t exist

If a value already exists at the specified time, it will update that value silently

pub fn update_observation( &mut self, name: &str, time: f64, new_value: f64, ) -> bool

Update an observation for a specific covariate

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

Remove an observation from a specific covariate

pub fn set_covariate_fixed(&mut self, name: &str, fixed: bool) -> bool

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

This is a common operation in pharmacokinetic modeling where you want to treat a covariate as constant.

pub fn to_hashmap( &mut self, time: f64, ) -> Result<HashMap<String, f64>, CovariateError>

Convert all covariates to a HashMap of values at a specific time

Arguments

• time - The time at which to interpolate all covariate values

Returns

A HashMap mapping covariate names to their interpolated values at the specified time

Trait Implementations

impl Clone for Covariates

fn clone(&self) -> Covariates

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Covariates

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

Formats the value using the given formatter.

impl Default for Covariates

fn default() -> Covariates

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Covariates

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Covariates

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

Formats the value using the given formatter.

impl Serialize for Covariates

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.