Struct Prediction

pub struct Prediction { /* private fields */ }

Prediction holds an observation and its prediction

Implementations

impl Prediction

pub fn time(&self) -> f64

Get the time point of this prediction.

pub fn observation(&self) -> Option<f64>

Get the observed value.

pub fn prediction(&self) -> f64

Get the predicted value.

pub fn outeq(&self) -> usize

Get the output equation index.

pub fn errorpoly(&self) -> Option<ErrorPoly>

Get the error polynomial coefficients, if available.

pub fn prediction_error(&self) -> Option<f64>

Calculate the raw prediction error (prediction - observation).

pub fn percentage_error(&self) -> Option<f64>

Calculate the percentage error as (prediction - observation)/observation * 100.

pub fn absolute_error(&self) -> Option<f64>

Calculate the absolute error |prediction - observation|.

pub fn squared_error(&self) -> Option<f64>

Calculate the squared error (prediction - observation)².

pub fn likelihood( &self, error_models: &ErrorModels, ) -> Result<f64, PharmsolError>

Calculate the likelihood of this prediction given an error model.

Returns an error if the observation is missing or if the likelihood is either zero or non-finite.

pub fn state(&self) -> &Vec<f64>

Get the state vector at this prediction point

pub fn to_observation(&self) -> Observation

Create an Observation from this prediction

Trait Implementations

impl Clone for Prediction

fn clone(&self) -> Prediction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prediction

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

Formats the value using the given formatter.

impl Default for Prediction

fn default() -> Prediction

Returns the “default value” for a type.

impl Display for Prediction

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

Formats the value using the given formatter.