Skip to main content

ValidatedModelMetadata

Struct ValidatedModelMetadata 

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

Validated metadata view used by the execution layer.

This type is what handwritten equation builders store after metadata has passed validation. It provides stable lookup helpers from public names to the dense indices used during execution.

Route lookups expose two different indices:

Implementations§

§

impl ValidatedModelMetadata

pub fn name(&self) -> &str

Get the public model name.

pub fn kind(&self) -> ModelKind

Get the validated model family.

pub fn parameters(&self) -> &[Parameter]

pub fn parameter_names(&self) -> Vec<&str>

Ordered parameter names, matching the support-point vector layout.

pub fn covariates(&self) -> &[Covariate]

pub fn states(&self) -> &[State]

pub fn routes(&self) -> &[ValidatedRoute]

pub fn route_labels(&self) -> Vec<&str>

Declared route (input) labels, e.g. for error messages.

A label shared by a bolus and an infusion appears once.

pub fn route_input_count(&self) -> usize

Get the number of dense execution input slots needed for routes.

This is the maximum of the bolus-route count and infusion-route count.

pub fn outputs(&self) -> &[Output]

pub fn output_labels(&self) -> Vec<&str>

Declared output labels, e.g. for error messages.

pub fn particles(&self) -> Option<usize>

pub fn analytical_kernel(&self) -> Option<AnalyticalKernel>

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>

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

Look up a route by public name and return its declaration-order index.

Legacy name-only lookup: when a bolus and an infusion share a label, this returns the first matching declaration. Prefer Self::route_declaration_index_by_kind when the route kind is known.

pub fn route_declaration_index_by_kind( &self, name: &str, kind: RouteKind, ) -> Option<usize>

Look up a route by public name and kind, returning its declaration-order index.

pub fn route_for_label( &self, label: &str, kind: RouteKind, ) -> Option<&ValidatedRoute>

Resolve a public route label from data to a declared route of the given kind.

A bolus and an infusion may share a label (one drug given by either route), so the kind is part of the match: bolus events resolve bolus routes and infusion events resolve infusion routes.

Resolution order:

  1. exact route name of the given kind,
  2. canonical numeric alias (input_<n>) for a bare numeric label, matching Pmetrics INPUT numbering.

A bare numeric label never falls back to a declaration position, so "10" does not resolve unless an input_10 route is declared.

Use ValidatedRoute::input_index on the result for the dense execution input slot.

pub fn output_for_label(&self, label: &str) -> Option<usize>

Resolve a public output label from data to its dense output index.

Uses the same resolution order as Self::route_for_label: exact output name, then the outeq_<n> alias matching Pmetrics OUTEQ numbering, with no positional fallback.

pub fn parameter(&self, name: &str) -> Option<&Parameter>

pub fn covariate(&self, name: &str) -> Option<&Covariate>

pub fn state(&self, name: &str) -> Option<&State>

pub fn route(&self, name: &str) -> Option<&ValidatedRoute>

Look up a route by public name.

Legacy name-only lookup: when a bolus and an infusion share a label, this returns the first matching declaration. Prefer Self::route_by_kind when the route kind is known.

pub fn route_by_kind( &self, name: &str, kind: RouteKind, ) -> Option<&ValidatedRoute>

Look up a route by public name and kind.

pub fn output(&self, name: &str) -> Option<&Output>

Trait Implementations§

§

impl Clone for ValidatedModelMetadata

§

fn clone(&self) -> ValidatedModelMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ValidatedModelMetadata

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for ValidatedModelMetadata

§

fn eq(&self, other: &ValidatedModelMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl Eq for ValidatedModelMetadata

§

impl StructuralPartialEq for ValidatedModelMetadata

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

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<T> SendAlias for T

§

impl<T> SyncAlias for T