Back to Eqiora docs Skip to main content

FirstOrderProgram

eqiora::runtime

Struct FirstOrderProgram 

pub struct FirstOrderProgram { /* private fields */ }
Description

Canonical continuous Relation proven to have first-order form M y_dot = f(t,y).

State order follows first occurrence of current-value or derivative Field symbols in scalar Operator IR. A full constant monomial derivative Jacobian is normalized to an explicit ODE. Every other non-zero-rank constant matrix remains a full or rank-deficient mass matrix. State-dependent and derivative-nonlinear systems fail closed; equation class is never inferred from sample evaluations or a floating-point rank threshold.

Implementations§

§

impl FirstOrderProgram

Signature links:§FirstOrderProgram

pub fn lower( program: &CpuProgram, relation: Id<Relation>, ) -> Result<FirstOrderProgram, Diagnostic>

Signature links:lowerCpuProgramIdRelationResultFirstOrderProgramDiagnostic

Lower one continuously activated Relation from an already lowered CPU program and prove an admitted first-order equation class.

§Errors

Returns EQ0705 if activation, symbols, initial values, shapes, or derivative structure cannot enter the first-order seam. Existing Operator IR diagnostics are retained when scalar evaluation fails.

pub const fn relation(&self) -> Id<Relation>

Signature links:relationIdRelation

Canonical Relation represented by this projection.

pub fn state_fields(&self) -> &[Id<Field>]

Signature links:state_fieldsIdField

Deterministic state coordinate order.

pub fn initial_state(&self) -> &[f64]

Signature links:initial_statef64

Revision-captured initial state or consistency-solve guess.

pub fn parameter_fields(&self) -> &[Id<Parameter>]

Signature links:parameter_fieldsIdParameter

Deterministic first-occurrence order of bound Parameter symbols.

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

Signature links:parametersf64

Revision-captured Parameter values in Self::parameter_fields order.

pub const fn lowering_proof(&self) -> &TimeLoweringProof

Signature links:lowering_proofTimeLoweringProof

Exact Operator-IR witness behind equation-class admission.

pub const fn equation_class(&self) -> TimeEquationClass

Signature links:equation_classTimeEquationClass

Structurally proven equation class.

pub const fn initial_condition_policy(&self) -> InitialConditionPolicy

Signature links:initial_condition_policyInitialConditionPolicy

Initial-condition meaning required by the proven equation class.

pub fn time_problem(&self) -> Result<TimeProblem<'_>, Diagnostic>

Signature links:time_problemResultTimeProblemDiagnostic

Construct the sole backend-neutral time problem from this projection.

§Errors

Retains TimeProblem validation diagnostics if its invariants change.

pub fn forward_sensitivity_problem( &self, ) -> Result<ForwardSensitivityProblem<'_>, Diagnostic>

Signature links:forward_sensitivity_problemResultForwardSensitivityProblemDiagnostic

Construct the parameter-JVP problem from the same proven projection.

§Errors

Retains ForwardSensitivityProblem validation diagnostics when the Relation has no Parameter symbols or its invariants change.

Trait Implementations§

§

impl Clone for FirstOrderProgram

Signature links:§CloneFirstOrderProgram
§

fn clone(&self) -> FirstOrderProgram

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

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

Signature links:unstableSource§clone_from
Performs copy-assignment from source. Read more
§

impl Debug for FirstOrderProgram

Signature links:§DebugFirstOrderProgram
§

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

Signature links:§fmtFormatterResult()Error
Formats the value using the given formatter. Read more
§

impl ParametricTimeSystem for FirstOrderProgram

Signature links:§ParametricTimeSystemFirstOrderProgram
§

fn parameter_dimension(&self) -> usize

Signature links:§parameter_dimensionusize
Number of scalar model parameters at this linearization point.
§

fn parameters(&self) -> &[f64]

Signature links:§parametersf64
Finite parameter values defining the primal linearization point.
§

fn mass_parameter_dependence(&self) -> MassParameterDependence

Signature links:§mass_parameter_dependenceMassParameterDependence
State whether the mass action is proven independent of parameters. Read more
§

fn rhs_parameter_jvp( &self, time: f64, state: &[f64], parameter_direction: &[f64], output: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§rhs_parameter_jvpf64f64f64f64Result()Diagnostic
Evaluate f_p(t, y) parameter_direction. Read more
§

fn initial_parameter_jvp( &self, time: f64, parameter_direction: &[f64], output: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§initial_parameter_jvpf64f64f64Result()Diagnostic
Evaluate y0_p parameter_direction. Read more
§

impl PartialEq for FirstOrderProgram

Signature links:§PartialEqFirstOrderProgram
§

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

Signature links:§eqFirstOrderProgrambool
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

Signature links:unstableSource§ne&Rhsbool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl TimeSystem for FirstOrderProgram

Signature links:§TimeSystemFirstOrderProgram
§

fn dimension(&self) -> usize

Signature links:§dimensionusize
Number of scalar state unknowns.
§

fn rhs( &self, time: f64, state: &[f64], output: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§rhsf64f64f64Result()Diagnostic
Evaluate f(t, y). Read more
§

fn rhs_jvp( &self, time: f64, state: &[f64], direction: &[f64], output: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§rhs_jvpf64f64f64f64Result()Diagnostic
Evaluate the state Jacobian action f_y(t, y) direction. Read more
§

fn mass_action( &self, time: f64, direction: &[f64], output: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§mass_actionf64f64f64Result()Diagnostic
Evaluate M(t) direction for a mass-matrix system. Read more
§

impl StructuralPartialEq for FirstOrderProgram

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Signature links:Source§AnySized
Source§

fn type_id(&self) -> TypeId

Signature links:Source§type_idTypeId
Gets the TypeId of self. Read more
§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Signature links:§Result
Convert the given value into an approximately equivalent representation.
§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Signature links:§
§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Signature links:§Result
Convert the subject into an approximately equivalent representation.
Source§

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

Signature links:Source§BorrowSized
Source§

fn borrow(&self) -> &T

Signature links:Source§borrow&T
Immutably borrows from an owned value. Read more
Source§

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

Signature links:Source§BorrowMutSized
Source§

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

Signature links:Source§borrow_mut&mut T
Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

Signature links:§
§

fn by_ref(&self) -> &T

Source§

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

Signature links:Source§CloneToUninitClone
Source§

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

Signature links:Source§clone_to_uninit*mut u8
🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, Dst> ConvAsUtil<Dst> for T

Signature links:§
§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject with the default scheme.
§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject with a specific scheme.
§

impl<T> ConvUtil for T

Signature links:§
§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject to a given type with the default scheme.
§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject to a given type with a specific scheme.
§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Signature links:§SizedInto
Convert the subject to a given type.
§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Signature links:§ResultSized
Attempt to convert the subject to a given type.
§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Signature links:§ResultSized
Attempt a value conversion of the subject to a given type.
§

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

Signature links:§Sized
§

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

Source§

impl<T> From<T> for T

Signature links:Source§From
Source§

fn from(t: T) -> T

Signature links:Source§from

Returns the argument unchanged.

Source§

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

Signature links:Source§IntoFrom
Source§

fn into(self) -> U

Signature links:Source§into

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

Signature links:Source§IntoEither
Source§

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

Signature links:Source§into_eitherboolEither
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,

Signature links:Source§into_either_withEitherFnOncebool
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

Signature links:§
§

const ALIGN: usize

Signature links:§usize
The alignment of pointer.
§

type Init = T

Signature links:§
The type for initializers.
§

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

Signature links:§usize
Initializes a with the given initializer. Read more
§

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

Signature links:§usize&'a T
Dereferences the given pointer. Read more
§

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

Signature links:§usize&'a mut T
Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Signature links:§usize
Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Signature links:Source§Same
Source§

type Output = T

Signature links:Source§Output
Should always be Self
§

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

Signature links:§
§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Signature links:Source§ToOwnedClone
Source§

type Owned = T

Signature links:Source§Owned
The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Signature links:Source§to_owned
Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Signature links:Source§clone_into&mut T
Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<Src> TryFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Signature links:§Result
Convert the given value into the subject type.
Source§

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

Signature links:Source§TryFromInto
Source§

type Error = Infallible

Signature links:Source§ErrorInfallible
The type returned in the event of a conversion error.
Source§

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

Signature links:Source§try_fromResultTryFromError
Performs the conversion.
§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Signature links:§
§

type Err = <Dst as TryFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Signature links:§Result
Convert the subject into the destination type.
Source§

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

Signature links:Source§TryIntoTryFrom
Source§

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

Signature links:Source§ErrorTryFromError
The type returned in the event of a conversion error.
Source§

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

Signature links:Source§try_intoResultTryFromError
Performs the conversion.
§

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

Signature links:§
§

fn vzip(self) -> V

§

impl<Src> ValueFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Signature links:§Result
Convert the given value into an exactly equivalent representation.
§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Signature links:§
§

type Err = <Dst as ValueFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Signature links:§Result
Convert the subject into an exactly equivalent representation.
§

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,