Module prelude

Module prelude 

Source
Expand description

A collection of commonly used items to simplify imports.

Re-exports§

pub use crate::algorithms;
pub use crate::algorithms::dispatch_algorithm;
pub use crate::algorithms::Algorithm;
pub use crate::routines;
pub use crate::routines::logger;
pub use crate::routines::initialization::Prior;
pub use pharmsol;
pub use crate::routines::settings::*;
pub use crate::structs::*;

Modules§

analytical
auc
Trapezoidal AUC/AUMC calculation on &[f64] slices.
builder
cache
Cache mechanisms for [Equation]s
covariate
data
equation
error_model
event
meta
models
observation_error
Error types for observation data processing
ode
parser
residual_error
Residual error models for parametric algorithms (SAEM, FOCE, etc.)
row
Row representation of Data for flexible parsing
sde
simulator
structs

Macros§

fa
fetch_cov
fetch_params
lag
ode
Build an equation::ODE while inferring nstates, ndrugs and nout from the maximum literal bracket-indices used in the closures.

Structs§

Analytical
Model equation using analytical solutions.
AssayErrorModels
Collection of assay/measurement error models for all outputs.
Bolus
Represents an instantaneous input of drug
Covariate
A time-varying covariate consisting of computed segments
Covariates
A collection of Covariates
Data
The main data container for pharmacokinetic/pharmacodynamic data
ErrorPoly
Error polynomial coefficients for the error model
HashMap
A hash map implemented with quadratic probing and SIMD lookup.
Infusion
Represents a continuous dose of drug over time
Meta
Model metadata container.
NCAOptions
Complete NCA configuration
Neqs
The dimensions of the model: number of states, drug inputs, and output equations.
ODE
Observation
Represents an observation of drug concentration or other measured value
Occasion
An occasion within a subject’s dataset
Prediction
Prediction holds an observation and its prediction at a single time point.
PredictionCache
Thread-safe LRU cache for subject predictions.
ResidualErrorModels
Collection of residual error models for multiple output equations
SDE
Stochastic Differential Equation solver for pharmacometric models.
SdeLikelihoodCache
Cache for SDE likelihood values.
Subject
A subject in a pharmacometric dataset
SubjectNCAResult
Structured NCA result for a single subject
SubjectPredictions
Container for predictions associated with a single subject.

Enums§

AUCMethod
AUC calculation method
AssayErrorModel
Model for calculating observation errors in pharmacometric analyses
BLQRule
BLQ (Below Limit of Quantification) handling rule
Censor
CovariateError
Error type for covariate operations
EqnKind
ErrorModelError
Event
Represents a pharmacokinetic/pharmacodynamic event
ExplicitRkTableau
Tableau for OdeSolver::ExplicitRk.
Factor
Parameter that can be either fixed or variable for estimation
Interpolation
Method used to interpolate covariate values between observations
MetricsError
Error type for observation metric computations
ObservationError
Errors arising from observation data processing
OdeSolver
ODE solver selection.
PharmsolError
ResidualErrorModel
Residual error model for parametric estimation algorithms.
Route
Administration route for a dosing event
SdirkTableau
Tableau for OdeSolver::Sdirk.

Constants§

DEFAULT_CACHE_SIZE
Default maximum number of entries per cache.

Traits§

Cache
Trait for enabling prediction caching on equation types.
Equation
Trait for model equations that can be simulated.
EquationTypes
Trait defining the associated types for equations.
NCA
Extension trait for Non-Compartmental Analysis
NCAPopulation
Extension trait for structured population-level NCA
ObservationMetrics
Observation-level pharmacokinetic metrics (AUC, Cmax, Tmax, etc.)
Predictions
Trait for prediction containers.
State
Trait for state vectors that can receive bolus doses.
SubjectBuilderExt
Extension trait for creating Subject instances using the builder pattern

Functions§

auc
∫ C(t) dt from first to last time point. Tmax is auto-detected for LinLog.
auc_interval
Partial AUC over [start, end], interpolating at boundaries.
aumc
∫ t·C(t) dt from first to last time point (for MRT = AUMC / AUC).
get_e2
Computes the effect metric for a dual-site pharmacodynamic model.
interpolate_linear
Linearly interpolate a value at time. Clamps to boundary values.
one_compartment
Analytical solution for one compartment model.
one_compartment_cl
Analytical solution for one compartment model parameterized by clearance.
one_compartment_cl_with_absorption
Analytical solution for one compartment model with first-order absorption, parameterized by clearance.
one_compartment_with_absorption
Analytical solution for one compartment model with first-order absorption.
three_compartments
Analytical for three compartments Assumptions:
three_compartments_cl
Analytical solution for three compartment model parameterized by clearances.
three_compartments_cl_with_absorption
Analytical solution for three compartment model with first-order absorption, parameterized by clearances.
three_compartments_with_absorption
Analytical solution for three compartment model with first-order absorption. Assumptions:
two_compartments
Analytical solution for two compartment model.
two_compartments_cl
Analytical solution for two compartment model parameterized by clearances.
two_compartments_cl_with_absorption
Analytical solution for two compartment model with first-order absorption, parameterized by clearances.
two_compartments_with_absorption
Analytical solution for two compartment model with first-order absorption.

Type Aliases§

AnalyticalEq
This closure represents an Analytical solution of the model. See equation::analytical module for examples.
DiffEq
This closure represents the differential equation of the model.
Diffusion
This closure represents the diffusion term of a stochastic differential equation model.
Drift
This closure represents the drift term of a stochastic differential equation model.
ErrorModelDeprecated
Deprecated alias for AssayErrorModel.
ErrorModelsDeprecated
Deprecated alias for AssayErrorModels.
Fa
This closure represents the fraction absorbed (also called bioavailability or protein binding) of the model.
Init
This closure represents the initial state of the system.
Lag
This closure represents the lag time of the model.
M
Type alias for matrix type used in simulations
Out
This closure represents the output equation of the model.
Result
Result<T, Error>
SecEq
This closure represents the secondary equation of the model.
T
Type alias for floating point values used in simulations
V
Type alias for state vector type used in simulations