Skip to main content

DiagnosticRecorder

Struct DiagnosticRecorder 

Source
pub struct DiagnosticRecorder { /* private fields */ }
Expand description

A cloneable callback whose recorded output remains accessible after a run.

Pass a clone to a runner and retain the original handle:

let recorder = DiagnosticRecorder::new(DiagnosticRecorderConfig::default());
let callback = Box::new(recorder.clone());
// Run with `callback`, then read `recorder.diagnostics()`.

Clones share one recorder state and may be read from another thread while a run is active, but they must not be installed in multiple concurrent runs: each run resets the shared state at its start. Recorder state is best-effort diagnostics, so a poisoned mutex is recovered and reset on the next run rather than preventing later diagnostic reads or reuse.

Implementations§

Source§

impl DiagnosticRecorder

Source

pub fn new(config: DiagnosticRecorderConfig) -> Self

Source

pub fn diagnostics(&self) -> ReconstructionDiagnostics

Source

pub fn into_diagnostics(self) -> ReconstructionDiagnostics

Source

pub fn object_snapshots(&self) -> Vec<(usize, Array2<f64>, Array2<f64>)>

Source

pub fn pupil_snapshots(&self) -> Vec<(usize, Array2<f64>, Array2<f64>)>

Source

pub fn reset(&self)

Clears all values collected by this recorder and its clones.

Trait Implementations§

Source§

impl Callback for DiagnosticRecorder

Source§

fn requires_for( &self, hook: CallbackHook, iteration: usize, ) -> Vec<DiagnosticRequest>

Requests diagnostics for a specific hook. Built-in periodic callbacks override this to avoid computing snapshots on inactive iterations.
Source§

fn on_start(&mut self, context: &StepContext<'_>) -> Result<CallbackAction>

Source§

fn on_iteration_end( &mut self, context: &StepContext<'_>, ) -> Result<CallbackAction>

Source§

fn on_finish(&mut self, _result: &ReconstructionResult) -> Result<()>

Source§

fn requires(&self) -> Vec<DiagnosticRequest>

Source§

fn on_frame_end(&mut self, _context: &StepContext<'_>) -> Result<CallbackAction>

Runs once for every completed frame when frame callbacks are enabled. For multi-frame algorithms, all frames in a batch observe the same post-batch state while frame_index and natural loss remain per-frame.
Source§

impl Clone for DiagnosticRecorder

Source§

fn clone(&self) -> DiagnosticRecorder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,