Back to Eqiora docs Skip to main content

RelationDef

eqiora::kernel

Struct RelationDef 

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

Ordered mathematical conditions together with their authored operands. How the conditions are enforced numerically is not part of the Model definition.

Implementations§

§

impl RelationDef

Signature links:§RelationDef

pub const fn is_probability_law(&self) -> bool

Signature links:is_probability_lawbool

Whether this Relation defines an immutable probability measure rather than an activated equation or evolution law.

pub fn probability_mass( id: Id<Relation>, expression: ExprDag, outcomes: Id<Enum>, weights: ExprId, ) -> Result<RelationDef, Diagnostic>

Signature links:probability_massIdRelationExprDagIdEnumExprIdResultRelationDefDiagnostic

Define normalized mass on an exact ordered declaration of named outcomes.

The retained weights are proportional masses: normalization is part of this law’s meaning, not a clipping or repair step. Whole-Model admission requires one dimensionless nonnegative real weight per outcome and positive total mass.

pub fn probability_density( id: Id<Relation>, expression: ExprDag, domain: Id<Domain>, measure: ObservableMeasure, density: ExprId, ) -> Result<RelationDef, Diagnostic>

Signature links:probability_densityIdRelationExprDagIdDomainObservableMeasureExprIdResultRelationDefDiagnostic

Define normalized probability relative to one explicit continuous measure.

The retained density has inverse-measure units. Its finite positive normalizing integral belongs to the law. Admission must prove this integral and nonnegativity; a quadrature sample alone is not that proof.

§

impl RelationDef

Signature links:§RelationDef

pub fn new( id: Id<Relation>, expression: ExprDag, ) -> Result<RelationDef, Diagnostic>

Signature links:newIdRelationExprDagResultRelationDefDiagnostic

Define equalities from consecutive left/right expression root pairs.

§Errors

Rejects an odd number of roots.

pub fn with_conditions( id: Id<Relation>, expression: ExprDag, conditions: Vec<RelationConditionKind>, ) -> Result<RelationDef, Diagnostic>

Signature links:with_conditionsIdRelationExprDagVecRelationConditionKindResultRelationDefDiagnostic

Define typed mathematical conditions with one descriptor per root pair. Complementarity implies that both operands are nonnegative. Units, real order, and support are checked by semantic admission.

§Errors

Rejects unpaired roots or a mismatched descriptor count.

pub fn initial( id: Id<Relation>, expression: ExprDag, ) -> Result<RelationDef, Diagnostic>

Signature links:initialIdRelationExprDagResultRelationDefDiagnostic

Define simultaneous equalities used only for fresh initialization.

§Errors

Rejects an odd number of roots.

pub const fn is_initial(&self) -> bool

Signature links:is_initialbool

Whether these conditions apply only to fresh initialization.

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

Signature links:idIdRelation

Relation identity.

pub const fn expression(&self) -> &ExprDag

Signature links:expressionExprDag

Expression arena holding all condition operands.

pub fn conditions(&self) -> Option<&[RelationConditionKind]>

Signature links:conditionsOptionRelationConditionKind

Mathematical condition descriptors in authored order, when this is a condition Relation.

pub const fn meaning(&self) -> &RelationMeaning

Signature links:meaningRelationMeaning

Mathematical meaning, including the terms of a physical Law.

pub fn conservation( id: Id<Relation>, expression: ExprDag, terms: ConservationTerms, ) -> Result<RelationDef, Diagnostic>

Signature links:conservationIdRelationExprDagConservationTermsResultRelationDefDiagnostic

Define a physical conservation Law from its balance operands.

§Errors

Rejects a term descriptor that does not name exactly the balance roots.

pub fn noise( id: Id<Relation>, expression: ExprDag, process: NoiseProcess, parameter: ExprId, independent: bool, ) -> Result<RelationDef, Diagnostic>

Signature links:noiseIdRelationExprDagNoiseProcessExprIdboolResultRelationDefDiagnostic

Define a nominal process Law from its exact parameter root.

pub fn stochastic( id: Id<Relation>, expression: ExprDag, target: Id<Field>, calculus: Option<StochasticCalculus>, drift: Option<ExprId>, diffusions: Vec<(Id<Relation>, ExprId)>, jumps: Vec<(Id<Relation>, ExprId)>, ) -> Result<RelationDef, Diagnostic>

Signature links:stochasticIdRelationExprDagIdFieldOptionStochasticCalculusOptionExprIdVecIdRelationExprIdVecIdRelationExprIdResultRelationDefDiagnostic

Define stochastic evolution; coefficients are values, never equation sides.

pub fn has_constraints(&self) -> bool

Signature links:has_constraintsbool

Whether a numerical realization must explicitly enforce constraints.

pub fn equation_sides(&self) -> Result<impl ExactSizeIterator, Diagnostic>

Signature links:equation_sidesResultExactSizeIteratorDiagnostic

Operand pairs in order. Check conditions() before forming residuals: an inequality or complementarity pair is not an equality to subtract.

§Errors

Process and stochastic evolution Laws have no equality residual projection.

§

impl RelationDef

Signature links:§RelationDef

pub fn validate_conditions<I>( &self, typed: &TypedResidual<I>, support: Option<&SpatialSupport<I>>, ) -> Result<(), TypeViolation<I>>
where I: Clone + Eq,

Signature links:validate_conditionsTypedResidualOptionSpatialSupportResult()TypeViolationCloneEq

Check the conditions against independently inferred operand types. The caller must infer the complete DAG first.

§Errors

Rejects incompatible equality/inequality types, non-real ordered values, unsupported frames, and distinct complementarity supports.

Trait Implementations§

§

impl Clone for RelationDef

Signature links:§CloneRelationDef
§

fn clone(&self) -> RelationDef

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

Signature links:§DebugRelationDef
§

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

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

impl From<RelationDef> for KernelNode

Signature links:§FromRelationDefKernelNode
§

fn from(value: RelationDef) -> KernelNode

Signature links:§fromRelationDefKernelNode
Converts to this type from the input type.
§

impl PartialEq for RelationDef

Signature links:§PartialEqRelationDef
§

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

Signature links:§eqRelationDefbool
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 StructuralPartialEq for RelationDef

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.

§

impl<T> Instrument for T

Signature links:§
§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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<T> WithSubscriber for T

Signature links:§
§

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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