Struct TimeRootOutcome
pub struct TimeRootOutcome { /* private fields */ }Description
Requested native samples and complete smooth history through the first root or horizon. Optional forward sensitivities share the same accepted intervals and sample layout.
Implementations§
§impl TimeRootOutcome
impl TimeRootOutcome
pub fn with_sensitivities(
self,
parameter_dimension: usize,
sensitivity_history: AcceptedTimeHistory,
sensitivities: Vec<f64>,
) -> Result<TimeRootOutcome, Diagnostic>
pub fn with_sensitivities( self, parameter_dimension: usize, sensitivity_history: AcceptedTimeHistory, sensitivities: Vec<f64>, ) -> Result<TimeRootOutcome, Diagnostic>
Accept sensitivity stencils on exactly the same smooth primal intervals.
§Errors
Rejects zero parameter dimension, inconsistent sample/step shape, nonfinite products, events, or step times. Samples use parameter-major order.
pub fn parameter_dimension(&self) -> usize
pub fn parameter_dimension(&self) -> usize
Number of real parameter coordinates, or zero when sensitivities were not requested.
pub fn sensitivity(&self, parameter: usize, sample: usize) -> Option<&[f64]>
pub fn sensitivity(&self, parameter: usize, sample: usize) -> Option<&[f64]>
Fixed-time sensitivity for one Parameter and one retained primal sample. No sample at the uncommitted root is implied by this lookup.
pub fn sensitivity_history(&self) -> Option<&AcceptedTimeHistory>
pub fn sensitivity_history(&self) -> Option<&AcceptedTimeHistory>
Requested fixed-time sensitivities, including interpolation at a localized root.
§impl TimeRootOutcome
impl TimeRootOutcome
pub fn horizon(solution: TimeSolution) -> Result<TimeRootOutcome, Diagnostic>
pub fn horizon(solution: TimeSolution) -> Result<TimeRootOutcome, Diagnostic>
Accept a completed smooth solve retaining native history.
§Errors
Rejects an output-only solution or history containing committed resets.
pub fn localized(
proposal: RootProposal,
history: AcceptedTimeHistory,
samples: Option<TimeSolution>,
) -> Result<TimeRootOutcome, Diagnostic>
pub fn localized( proposal: RootProposal, history: AcceptedTimeHistory, samples: Option<TimeSolution>, ) -> Result<TimeRootOutcome, Diagnostic>
Accept a native prefix ending exactly at a localized, uncommitted root.
Samples contain only requested times strictly before the root. A requested output at the root belongs to the hybrid owner’s post-reset state.
§Errors
Rejects inconsistent root time/state/report or samples outside the prefix.
pub const fn proposal(&self) -> Option<&RootProposal>
pub const fn proposal(&self) -> Option<&RootProposal>
Uncommitted localized root, absent when the requested horizon was reached.
pub fn history(&self) -> &AcceptedTimeHistory
pub fn history(&self) -> &AcceptedTimeHistory
Complete smooth native history, including a native stencil cut at the root.
pub const fn samples(&self) -> Option<&TimeSolution>
pub const fn samples(&self) -> Option<&TimeSolution>
Requested samples before a root, or all requested samples at the horizon.
Absent when a root precedes the first requested output.
pub fn into_solution(self) -> Result<TimeSolution, Diagnostic>
pub fn into_solution(self) -> Result<TimeSolution, Diagnostic>
Consume a completed smooth outcome without copying its samples or history.
§Errors
Rejects an unfinished prefix ending at an uncommitted root.
Trait Implementations§
§impl Clone for TimeRootOutcome
impl Clone for TimeRootOutcome
§impl Debug for TimeRootOutcome
impl Debug for TimeRootOutcome
§impl PartialEq for TimeRootOutcome
impl PartialEq for TimeRootOutcome
§fn eq(&self, other: &TimeRootOutcome) -> bool
fn eq(&self, other: &TimeRootOutcome) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for TimeRootOutcome
Auto Trait Implementations§
impl Freeze for TimeRootOutcome
impl RefUnwindSafe for TimeRootOutcome
impl Send for TimeRootOutcome
impl Sync for TimeRootOutcome
impl Unpin for TimeRootOutcome
impl UnsafeUnpin for TimeRootOutcome
impl UnwindSafe for TimeRootOutcome
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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.