Back to Eqiora docs Skip to main content

ImplicitEulerStepLinearization

eqiora::runtime

Struct ImplicitEulerStepLinearization 

pub struct ImplicitEulerStepLinearization<'a> { /* private fields */ }
Description

Linearized discrete residual for one accepted implicit-Euler step.

This is a projection of the canonical residual linearization, not a derivative of the Newton iterations used to find the step. Unknown cotangents are projected to y_next; parameter cotangents are ordered as [y_previous, canonical model Parameters].

Implementations§

§

impl ImplicitEulerStepLinearization<'_>

Signature links:§ImplicitEulerStepLinearization

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

Signature links:state_fieldsIdField

Canonical state order used by both step state blocks.

pub const fn previous_state_parameter_dimension(&self) -> usize

Signature links:previous_state_parameter_dimensionusize

Number of leading parameter coordinates occupied by y_previous.

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

Signature links:model_parameter_fieldsIdParameter

Canonical model Parameters following y_previous in first-occurrence order.

pub const fn previous_time(&self) -> f64

Signature links:previous_timef64

Frozen model time at the accepted start of the step.

pub const fn next_time(&self) -> f64

Signature links:next_timef64

Frozen model time at the accepted end of the step.

pub const fn step(&self) -> f64

Signature links:stepf64

Frozen implicit-Euler step size.

Trait Implementations§

§

impl<'a> Debug for ImplicitEulerStepLinearization<'a>

Signature links:§DebugImplicitEulerStepLinearization
§

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

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

impl DiscreteStepLinearization for ImplicitEulerStepLinearization<'_>

Signature links:§DiscreteStepLinearizationImplicitEulerStepLinearization
§

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

Signature links:§state_fieldsIdField
Canonical state coordinate order shared by previous and next states.
§

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

Signature links:§model_parameter_fieldsIdParameter
Canonical model Parameter order following the previous-state block.
§

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

Signature links:§model_parameter_valuesf64
Revision-local model Parameter point.
§

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

Signature links:§previous_statef64
Accepted previous state at this step boundary.
§

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

Signature links:§next_statef64
Accepted next state at this step boundary.
§

fn start_time(&self) -> f64

Signature links:§start_timef64
Frozen start time of this discrete relation.
§

fn end_time(&self) -> f64

Signature links:§end_timef64
Frozen end time of this discrete relation.
§

fn previous_state_parameter_dimension(&self) -> usize

Signature links:§previous_state_parameter_dimensionusize
Number of leading Parameter coordinates occupied by previous state.
§

impl LinearizedRelation<f64> for ImplicitEulerStepLinearization<'_>

Signature links:§LinearizedRelationf64ImplicitEulerStepLinearization
§

fn unknown_dimension(&self) -> usize

Signature links:§unknown_dimensionusize
Number of implicitly solved coordinates.
§

fn parameter_dimension(&self) -> usize

Signature links:§parameter_dimensionusize
Number of selected design coordinates.
§

fn residual_dimension(&self) -> usize

Signature links:§residual_dimensionusize
Number of residual equations.
§

fn primal(&self, residual: &mut [f64]) -> Result<(), Diagnostic>

Signature links:§primalf64Result()Diagnostic
Evaluate the primal residual at the fixed linearization point. Read more
§

fn jvp( &self, tangent: RelationTangent<'_, f64>, residual_tangent: &mut [f64], ) -> Result<(), Diagnostic>

Signature links:§jvpRelationTangentf64f64Result()Diagnostic
Evaluate a selected tangent action, including R_w * unknown_tangent + R_p * parameter_tangent. Read more
§

fn vjp( &self, residual_cotangent: &[f64], cotangent: RelationCotangent<'_, f64>, ) -> Result<(), Diagnostic>

Signature links:§vjpf64RelationCotangentf64Result()Diagnostic
Evaluate (R_w^T * c, R_p^T * c) for one residual cotangent c. Read more

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

§

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.
§

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,