Struct AcceptedOutputLinearization
pub struct AcceptedOutputLinearization<'a, R, O>{ /* private fields */ }Description
One accepted relation and output projection bound for a derivative action.
Constructing this value is the numerical composition boundary: callers no longer pass an independently selected output to forward or reverse mode. Exact Model/Realization identity remains the responsibility of the application provenance layer that constructs the pair.
Implementations§
§impl<'a, R, O> AcceptedOutputLinearization<'a, R, O>where
R: LinearizedRelation<f64> + ?Sized,
O: LinearizedOutput<f64> + ?Sized,
impl<'a, R, O> AcceptedOutputLinearization<'a, R, O>where
R: LinearizedRelation<f64> + ?Sized,
O: LinearizedOutput<f64> + ?Sized,
pub fn new(
relation: &'a R,
output: &'a O,
residual_tolerance: f64,
) -> Result<AcceptedOutputLinearization<'a, R, O>, Diagnostic>
pub fn new( relation: &'a R, output: &'a O, residual_tolerance: f64, ) -> Result<AcceptedOutputLinearization<'a, R, O>, Diagnostic>
Accept one relation and its output at the same provenance-bound 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>
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>
Accept one relation/output pair with its exact materialized state Jacobian coefficient source.
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. Exact Model/Realization/accepted-point association remains the responsibility of the application provenance owner.
§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>
pub const fn relation(&self) -> &AcceptedLinearization<'a, R>
Accepted residual relation.
Trait Implementations§
§impl<'a, R, O> Debug for AcceptedOutputLinearization<'a, R, O>where
R: Debug + LinearizedRelation<f64> + ?Sized,
O: Debug + LinearizedOutput<f64> + ?Sized,
impl<'a, R, O> Debug for AcceptedOutputLinearization<'a, R, O>where
R: Debug + LinearizedRelation<f64> + ?Sized,
O: Debug + LinearizedOutput<f64> + ?Sized,
Auto Trait Implementations§
impl<'a, R, O> Freeze for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> RefUnwindSafe for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> Send for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> Sync for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> Unpin for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> UnsafeUnpin for AcceptedOutputLinearization<'a, R, O>
impl<'a, R, O> UnwindSafe for AcceptedOutputLinearization<'a, R, O>
Blanket Implementations§
Source§impl<T> Any for Twhere
T: 'static + ?Sized,
impl<T> Any for Twhere
T: 'static + ?Sized,
§impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
§fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
§impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
§type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
§fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
Source§impl<T> Borrow<T> for Twhere
T: ?Sized,
impl<T> Borrow<T> for Twhere
T: ?Sized,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T, Dst> ConvAsUtil<Dst> for T
impl<T, Dst> ConvAsUtil<Dst> for T
§fn approx(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
§impl<T> ConvUtil for T
impl<T> ConvUtil for T
§fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
§fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
§fn into_as<Dst>(self) -> Dstwhere
Self: Sized + Into<Dst>,
fn into_as<Dst>(self) -> Dstwhere
Self: Sized + Into<Dst>,
§fn try_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + TryInto<Dst>,
fn try_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + TryInto<Dst>,
§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> Twhere
Self: Distribution<T>,
Source§impl<T> From<T> for T
impl<T> From<T> for T
Source§impl<T, U> Into<U> for Twhere
U: From<T>,
impl<T, U> Into<U> for Twhere
U: From<T>,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where
F: FnOnce(&Self) -> bool,
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where
F: FnOnce(&Self) -> bool,
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
impl<T> Pointable for T
Source§impl<T> Same for T
impl<T> Same for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.