Struct ErrorModels

pub struct ErrorModels { /* private fields */ }
Expand description

Collection of error models for all possible outputs in the model/dataset This struct holds a vector of error models, each corresponding to a specific output in the pharmacometric analysis.

This is a wrapper around a vector of ErrorModels, its size is determined by the number of outputs in the model/dataset.

Implementations§

§

impl ErrorModels

pub fn new() -> ErrorModels

pub fn add( self, outeq: usize, model: ErrorModel, ) -> Result<ErrorModels, ErrorModelError>

pub fn iter(&self) -> impl Iterator<Item = (usize, &ErrorModel)>

pub fn into_iter(self) -> impl Iterator<Item = (usize, ErrorModel)>

pub fn iter_mut(&mut self) -> impl Iterator<Item = (usize, &mut ErrorModel)>

pub fn hash(&self) -> u64

pub fn len(&self) -> usize

Returns the number of error models in the collection.

pub fn errorpoly(&self, outeq: usize) -> Result<ErrorPoly, ErrorModelError>

Returns the error polynomial associated with the specified output equation.

§Arguments
  • outeq - The index of the output equation.
§Returns

The ErrorPoly for the given output equation.

pub fn scalar(&self, outeq: usize) -> Result<f64, ErrorModelError>

Returns the scalar value associated with the specified output equation.

§Arguments
  • outeq - The index of the output equation.
§Returns

The scalar value for the given output equation.

pub fn set_errorpoly( &mut self, outeq: usize, poly: ErrorPoly, ) -> Result<(), ErrorModelError>

Sets the error polynomial for the specified output equation.

§Arguments
  • outeq - The index of the output equation.
  • poly - The new ErrorPoly to set.

pub fn set_scalar( &mut self, outeq: usize, scalar: f64, ) -> Result<(), ErrorModelError>

Sets the scalar value for the specified output equation.

§Arguments
  • outeq - The index of the output equation.
  • scalar - The new scalar value to set.

pub fn sigma(&self, prediction: &Prediction) -> Result<f64, ErrorModelError>

Computes the standard deviation (sigma) for the specified output equation and prediction.

§Arguments
  • outeq - The index of the output equation.
  • prediction - The Prediction to use for the calculation.
§Returns

A Result containing the computed sigma value or an ErrorModelError if the calculation fails.

pub fn variance(&self, prediction: &Prediction) -> Result<f64, ErrorModelError>

Computes the variance for the specified output equation and prediction.

§Arguments
  • outeq - The index of the output equation.
  • prediction - The Prediction to use for the calculation.
§Returns

A Result containing the computed variance or an ErrorModelError if the calculation fails.

pub fn sigma_from_value( &self, outeq: usize, value: f64, ) -> Result<f64, ErrorModelError>

Computes the standard deviation (sigma) for the specified output equation and value.

§Arguments
  • outeq - The index of the output equation.
  • value - The value to use for the calculation.
§Returns

A Result containing the computed sigma value or an ErrorModelError if the calculation fails.

pub fn variance_from_value( &self, outeq: usize, value: f64, ) -> Result<f64, ErrorModelError>

Computes the variance for the specified output equation and value.

§Arguments
  • outeq - The index of the output equation.
  • value - The value to use for the calculation.
§Returns

A Result containing the computed variance or an ErrorModelError if the calculation fails.

Trait Implementations§

§

impl Clone for ErrorModels

§

fn clone(&self) -> ErrorModels

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ErrorModels

§

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

Formats the value using the given formatter. Read more
§

impl Default for ErrorModels

§

fn default() -> ErrorModels

Returns the “default value” for a type. Read more
§

impl<'de> Deserialize<'de> for ErrorModels

§

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

Deserialize this value from the given Serde deserializer. Read more
§

impl From<Vec<ErrorModel>> for ErrorModels

§

fn from(models: Vec<ErrorModel>) -> ErrorModels

Converts to this type from the input type.
§

impl Serialize for ErrorModels

§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> SendAlias for T

§

impl<T> SyncAlias for T