Trait LinearizedRelation 

pub trait LinearizedRelation<S>: Debug + Sync {
    // Required methods
    fn unknown_dimension(&self) -> usize;
    fn parameter_dimension(&self) -> usize;
    fn residual_dimension(&self) -> usize;
    fn primal(&self, residual: &mut [S]) -> Result<(), Diagnostic>;
    fn jvp(
        &self,
        tangent: RelationTangent<'_, S>,
        residual_tangent: &mut [S],
    ) -> Result<(), Diagnostic>;
    fn vjp(
        &self,
        residual_cotangent: &[S],
        cotangent: RelationCotangent<'_, S>,
    ) -> Result<(), Diagnostic>;
}

One immutable linearization of a residual relation.

The contract is scalar-representation-parametric. Implementations expose the primal residual, a Jacobian-vector product (JVP), and the paired vector-Jacobian product (VJP) without prescribing symbolic, automatic, or handwritten differentiation.

Required Methods

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 [S]) -> Result<(), Diagnostic>

Signature links:primal[S]Result()Diagnostic

Evaluate the primal residual at the fixed linearization point.

Errors

Returns a structured diagnostic for an output-shape mismatch or an invalid/non-finite evaluation.

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

Signature links:jvpRelationTangent[S]Result()Diagnostic

Evaluate a selected tangent action, including R_w * unknown_tangent + R_p * parameter_tangent.

Errors

Returns a structured diagnostic for a shape mismatch or an invalid/non-finite evaluation.

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

Signature links:vjp[S]RelationCotangentResult()Diagnostic

Evaluate (R_w^T * c, R_p^T * c) for one residual cotangent c.

Errors

Returns a structured diagnostic for a shape mismatch or an invalid/non-finite evaluation.

Implementations on Foreign Types

§

impl LinearizedRelation<f64> for AssembledLinearizedRelation

Signature links:LinearizedRelationf64

fn unknown_dimension(&self) -> usize

fn parameter_dimension(&self) -> usize

fn residual_dimension(&self) -> usize

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

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

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

Implementors

impl LinearizedRelation<f64> for ImplicitEulerStepLinearization<'_>

impl LinearizedRelation<f64> for ScalarLinearization<'_>