pmcore::prelude::data

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

Create a new instance of ErrorModels

§Returns

A new instance of ErrorModels.

pub fn error_model(&self, outeq: usize) -> Result<&ErrorModel, ErrorModelError>

Get the error model for a specific output equation

§Arguments

outeq - The index of the output equation for which to retrieve the error model.

§Returns

A reference to the ErrorModel for the specified output equation.

§Errors

If the output equation index is invalid, an ErrorModelError::InvalidOutputEquation is returned.

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

Add a new error model for a specific output equation

§Arguments

outeq - The index of the output equation for which to add the error model.
model - The ErrorModel to add for the specified output equation.

§Returns

A new instance of ErrorModels with the added model.

§Errors

If the output equation index is invalid or if a model already exists for that output equation, an ErrorModelError::ExistingOutputEquation is returned.

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

Returns an iterator over the error models in the collection.

§Returns

An iterator that yields tuples containing the index and a reference to each ErrorModel.

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

Returns an iterator that yields mutable references to the error models in the collection.

§Returns

An iterator that yields tuples containing the index and a mutable reference to each ErrorModel.

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

Returns a mutable iterator that yields mutable references to the error models in the collection.

§Returns

An iterator that yields tuples containing the index and a mutable reference to each ErrorModel.

pub fn hash(&self) -> u64

Computes a hash for the error models collection. This hash is based on the output equations and their associated error models.

§Returns

A u64 hash value representing the error models collection.

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 factor(&self, outeq: usize) -> Result<f64, ErrorModelError>

Returns the factor value associated with the specified output equation.

§Arguments

outeq - The index of the output equation.

§Returns

The factor 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_factor( &mut self, outeq: usize, factor: f64, ) -> Result<(), ErrorModelError>

Sets the factor value for the specified output equation.

§Arguments

outeq - The index of the output equation.
factor - The new factor value to set.

pub fn factor_param(&self, outeq: usize) -> Result<Factor, ErrorModelError>

Gets the factor parameter (including fixed/variable state) for the specified output equation.

§Arguments

outeq - The index of the output equation.

§Returns

The Factor for the given output equation.

pub fn set_factor_param( &mut self, outeq: usize, param: Factor, ) -> Result<(), ErrorModelError>

Sets the factor parameter (including fixed/variable state) for the specified output equation.

§Arguments

outeq - The index of the output equation.
param - The new Factor to set.

pub fn is_factor_fixed(&self, outeq: usize) -> Result<bool, ErrorModelError>

Checks if the factor parameter is fixed for the specified output equation.

§Arguments

outeq - The index of the output equation.

§Returns

true if the factor parameter is fixed, false if it’s variable.

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

Makes the factor parameter fixed at its current value for the specified output equation.

§Arguments

outeq - The index of the output equation.

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

Makes the factor parameter variable at its current value for the specified output equation.

§Arguments

outeq - The index of the output equation.

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 duplicate 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<'a> IntoIterator for &'a ErrorModels

type Item = (usize, &'a ErrorModel)

The type of the elements being iterated over.

type IntoIter = Enumerate<Iter<'a, ErrorModel>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a ErrorModels as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl<'a> IntoIterator for &'a mut ErrorModels

type Item = (usize, &'a mut ErrorModel)

The type of the elements being iterated over.

type IntoIter = Enumerate<IterMut<'a, ErrorModel>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut ErrorModels as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl IntoIterator for ErrorModels

type Item = (usize, ErrorModel)

The type of the elements being iterated over.

type IntoIter = IntoIter<<ErrorModels as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ErrorModels as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

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§

impl Freeze for ErrorModels

impl RefUnwindSafe for ErrorModels

impl Send for ErrorModels

impl Sync for ErrorModels

impl Unpin for ErrorModels

impl UnwindSafe for ErrorModels

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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> CloneToUninit for T
where T: Clone,

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> Context for T
where T: Clone + Default,

fn vector_from_element<V>(&self, len: usize, value: <V as VectorCommon>::T) -> V
where V: Vector<C = Self>,

fn vector_from_vec<V>(&self, vec: Vec<<V as VectorCommon>::T>) -> V
where V: Vector<C = Self>,

fn vector_zeros<V>(&self, len: usize) -> V
where V: Vector<C = Self>,

fn dense_mat_zeros<V>( &self, rows: usize, cols: usize, ) -> <V as DefaultDenseMatrix>::M
where V: Vector<C = Self> + DefaultDenseMatrix,

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

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

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Same for T

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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

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

impl<T> SendAlias for T

impl<T> SyncAlias for T