Struct ODE 

pub struct ODE { /* private fields */ }

Implementations

impl ODE

pub fn new( diffeq: fn(&NalgebraVec<f64>, &NalgebraVec<f64>, f64, &mut NalgebraVec<f64>, &NalgebraVec<f64>, &NalgebraVec<f64>, &Covariates), lag: fn(&NalgebraVec<f64>, f64, &Covariates) -> HashMap<usize, f64>, fa: fn(&NalgebraVec<f64>, f64, &Covariates) -> HashMap<usize, f64>, init: fn(&NalgebraVec<f64>, f64, &Covariates, &mut NalgebraVec<f64>), out: fn(&NalgebraVec<f64>, &NalgebraVec<f64>, f64, &Covariates, &mut NalgebraVec<f64>), ) -> ODE

pub fn with_nstates(self, nstates: usize) -> ODE

Set the number of state variables (ODE compartments).

pub fn with_ndrugs(self, ndrugs: usize) -> ODE

Set the number of drug inputs (size of bolus[] and rateiv[]).

pub fn with_nout(self, nout: usize) -> ODE

Set the number of output equations.

pub fn with_solver(self, solver: OdeSolver) -> ODE

Set the ODE solver algorithm.

pub fn with_tolerances(self, rtol: f64, atol: f64) -> ODE

Set the relative and absolute tolerances for the ODE solver.

pub fn with_metadata( self, metadata: ModelMetadata, ) -> Result<ODE, OdeMetadataError>

Attach validated handwritten-model metadata to this ODE.

pub fn metadata(&self) -> Option<&ValidatedModelMetadata>

Access the validated metadata attached to this ODE, if any.

pub fn parameter_index(&self, name: &str) -> Option<usize>

pub fn covariate_index(&self, name: &str) -> Option<usize>

pub fn state_index(&self, name: &str) -> Option<usize>

Trait Implementations

impl Cache for ODE

fn with_cache_capacity(self, size: usize) -> ODE

Enable caching with the given maximum number of entries.

fn enable_cache(self) -> ODE

Enable caching with the default size (100,000 entries).

fn clear_cache(&self)

Clear all entries from this equation’s cache, if caching is enabled.

fn disable_cache(self) -> ODE

Disable caching.

impl Clone for ODE

fn clone(&self) -> ODE

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ODE

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

Formats the value using the given formatter.

impl Equation for ODE

fn estimate_likelihood( &self, subject: &Subject, parameters: &Parameters, error_models: &AssayErrorModels, ) -> Result<f64, PharmsolError>

👎Deprecated since 0.23.0:

Use estimate_log_likelihood() instead for better numerical stability

Estimate the likelihood of the subject given the parameters and error model.

fn estimate_predictions( &self, subject: &Subject, parameters: &Parameters, ) -> Result<<ODE as EquationTypes>::P, PharmsolError>

Generate predictions for a subject with given parameters.

fn estimate_log_likelihood( &self, subject: &Subject, parameters: &Parameters, error_models: &AssayErrorModels, ) -> Result<f64, PharmsolError>

Estimate the log-likelihood of the subject given the parameters and error model.

fn kind() -> EqnKind

fn simulate_subject( &self, subject: &Subject, parameters: &Parameters, error_models: Option<&AssayErrorModels>, ) -> Result<(<ODE as EquationTypes>::P, Option<f64>), PharmsolError>

Simulate a subject with given parameters and optionally calculate likelihood.

fn nouteqs(&self) -> usize

Get the number of output equations in the model.

fn nstates(&self) -> usize

Get the number of state variables in the model.

impl EquationMetadataSource for ODE

fn equation_metadata(&self) -> Option<&ValidatedModelMetadata>

impl EquationTypes for ODE

type S = NalgebraVec<f64>

The state vector type

type P = SubjectPredictions

The predictions container type