Struct AcceptedOutputLinearization 

pub struct AcceptedOutputLinearization<'a, R, O>
where
    R: LinearizedRelation<f64> + ?Sized,
    O: LinearizedOutput<f64> + ?Sized,
{ /* private fields */ }

One accepted relation and output projection bound for a derivative action.

Forward and reverse mode take this pair, so callers cannot pass an output chosen separately from the relation. Checking that both come from the same Model and Realization is left to the provenance layer that builds the pair.

Implementations

§

impl<'a, R, O> AcceptedOutputLinearization<'a, R, O>

where R: LinearizedRelation<f64> + ?Sized, O: LinearizedOutput<f64> + ?Sized,

Signature links:AcceptedOutputLinearizationLinearizedRelationf64SizedLinearizedOutputf64Sized

pub fn new( relation: &'a R, output: &'a O, residual_tolerance: f64, ) -> Result<AcceptedOutputLinearization<'a, R, O>, Diagnostic>

Signature links:new&'a R&'a Of64ResultAcceptedOutputLinearizationDiagnostic

Pair one accepted relation with its output at the same point.

Errors

Returns EQ0704 when the residual is not accepted, the layouts differ, or the output primal is invalid.

pub fn new_with_canonical_state_jacobian( relation: &'a R, output: &'a O, state_jacobian: &'a CanonicalCsrSystemView, residual_tolerance: f64, ) -> Result<AcceptedOutputLinearization<'a, R, O>, Diagnostic>

Signature links:new_with_canonical_state_jacobian&'a R&'a OCanonicalCsrSystemViewf64ResultAcceptedOutputLinearizationDiagnostic

Pair one relation and output with a materialized source of state Jacobian coefficients.

The borrowed source carries its primal right-hand side unchanged. Forward and adjoint analysis supply their separately derived right-hand sides and independently replay the solved action through the relation. Checking that they belong to the same Model, Realization, and accepted point is left to the provenance layer.

Errors

Returns EQ0704 when the residual is not accepted, either layout is inconsistent, the output primal is invalid, or the canonical source does not match the relation’s state shape.

pub const fn relation(&self) -> &AcceptedLinearization<'a, R>

Signature links:relationAcceptedLinearization

Accepted residual relation.

pub const fn output(&self) -> &'a O

Signature links:output&'a O

Output projection paired with the accepted relation.

Trait Implementations

§

impl<'a, R, O> Debug for AcceptedOutputLinearization<'a, R, O>

where R: Debug + LinearizedRelation<f64> + ?Sized, O: Debug + LinearizedOutput<f64> + ?Sized,

Signature links:DebugAcceptedOutputLinearizationDebugLinearizedRelationf64SizedDebugLinearizedOutputf64Sized

§

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

Signature links:fmtFormatterResult()Error

Formats the value using the given formatter.