Struct SubjectBuilder

pub struct SubjectBuilder { /* private fields */ }

Builder for creating Subject instances with a fluent API

The SubjectBuilder allows for constructing complex subject data with a chainable, readable syntax. Events like doses and observations can be added sequentially, and the builder handles organizing them into occasions.

Implementations

impl SubjectBuilder

pub fn event(self, event: Event) -> SubjectBuilder

Add an event to the current occasion

Arguments

• event - The event to add

pub fn bolus(self, time: f64, amount: f64, input: usize) -> SubjectBuilder

Add a bolus dosing event

Arguments

• time - Time of the bolus dose
• amount - Amount of drug administered
• input - The compartment number (zero-indexed) receiving the dose

pub fn infusion( self, time: f64, amount: f64, input: usize, duration: f64, ) -> SubjectBuilder

Add an infusion event

Arguments

• time - Start time of the infusion
• amount - Total amount of drug to be administered
• input - The compartment number (zero-indexed) receiving the dose
• duration - Duration of the infusion in time units

pub fn observation(self, time: f64, value: f64, outeq: usize) -> SubjectBuilder

Add an observation event

Arguments

• time - Time of the observation
• value - Observed value (e.g., drug concentration)
• outeq - Output equation number (zero-indexed) corresponding to this observation

pub fn observation_with_error( self, time: f64, value: f64, outeq: usize, errorpoly: Option<ErrorPoly>, ignore: bool, ) -> SubjectBuilder

Add an observation with error model parameters and ignore flag

Arguments

• time - Time of the observation
• value - Observed value (e.g., drug concentration)
• outeq - Output equation number (zero-indexed) corresponding to this observation
• errorpoly - Error polynomial coefficients (c0, c1, c2, c3)
• ignore - Whether to ignore this observation in calculations

pub fn repeat(self, n: usize, delta: f64) -> SubjectBuilder

Repeat the last event n times, separated by some interval delta

Arguments

• n - Number of repetitions
• delta - Time increment between repetitions

Example

use pharmsol::*;


let subject = Subject::builder("patient_001")
    .bolus(0.0, 100.0, 0)  // First dose at time 0
    .repeat(3, 24.0)       // Repeat the dose at times 24, 48, and 72
    .build();

pub fn reset(self) -> SubjectBuilder

Complete the current occasion and start a new one

This finalizes the current occasion, adds it to the subject, and creates a new occasion for subsequent events. This is useful if a patient has new observations at some other occasion. Note that all states are reset!

pub fn covariate( self, name: impl Into<String>, time: f64, value: f64, ) -> SubjectBuilder

Add a covariate value at a specific time

Multiple calls for the same covariate at different times will create linear interpolation between the time points.

Arguments

• name - Name of the covariate
• time - Time point for this covariate value
• value - Value of the covariate at this time

Example

use pharmsol::*;

let subject = Subject::builder("patient_001")
    .covariate("weight", 0.0, 70.0)   // Weight at baseline
    .covariate("weight", 30.0, 68.5)  // Weight at day 30
    .build();

pub fn build(self) -> Subject

Finalize and build the Subject

This completes the current occasion and returns a new Subject with all the accumulated data.

Trait Implementations

impl Clone for SubjectBuilder

fn clone(&self) -> SubjectBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubjectBuilder

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

Formats the value using the given formatter.