Skip to main content

StepOutcome

Struct StepOutcome 

Source
pub struct StepOutcome {
    pub done: bool,
    pub stage_complete: bool,
    pub steps_taken: u32,
    pub load_factor: f64,
    pub error: Option<AnalysisErrorDetail>,
    pub continuation: Option<ContinuationDetail>,
    pub recorder_batches: Vec<RecorderBatch>,
}
Expand description

advance’s result — { done, stageComplete, stepsTaken, progressSnapshot, recorderBatch? }, minus the parts that are the worker/JS boundary’s job (progressSnapshot’s throttling, recorderBatch’s response_blocks byte layout): load_factor here is the raw signal those would be built from — for a Static stage the integrator’s load factor, for a Transient stage the elapsed time (TransientAnalysis::time), and for a Modal stage always 0.0 (a single eigensolve has no comparable incremental progress scalar; read Mode::frequency from a ModeShape recorder’s batch instead). error, once set, is sticky — later stages are not attempted, matching “a stage’s AnalysisError stops the sequence”.

Fields§

§done: bool§stage_complete: bool§steps_taken: u32§load_factor: f64§error: Option<AnalysisErrorDetail>§continuation: Option<ContinuationDetail>

Diagnostics of the last accepted arc-length step this call took (radius, retries, solves, chord length, determinant sign, stop criterion), or None when it took none. With arc length the load factor can decrease and repeat, so samples are ordered by their sample index, never by load factor.

§recorder_batches: Vec<RecorderBatch>

Only the samples this advance() call produced, one entry per recorder that recorded at least one sample this call (every recorder samples every step today, so in practice this is either empty — no step taken — or has one entry per recorder). This is the results-storage plan’s (docs/results-storage-indexeddb.md) recorderBatch, restated in field names that match pysees’s frozen ResultBlock protocol type (src/app/types/resultsStorage.ts); the caller assigns blockIndex and packs data, since neither concept exists on this side of the wasm boundary.

Trait Implementations§

Source§

impl Clone for StepOutcome

Source§

fn clone(&self) -> StepOutcome

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
Source§

impl Debug for StepOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for StepOutcome

Source§

fn eq(&self, other: &StepOutcome) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for StepOutcome

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StepOutcome

Source§

impl Tsify for StepOutcome

Source§

const DECL: &'static str = "/**\n * `advance`\'s result \u{2014} `{ done, stageComplete, stepsTaken,\n * progressSnapshot, recorderBatch? }`, minus the parts that\n * are the worker/JS boundary\'s job (`progressSnapshot`\'s throttling,\n * `recorderBatch`\'s `response_blocks` byte layout): `load_factor` here is\n * the raw signal those would be built from \u{2014} for a `Static` stage the\n * integrator\'s load factor, for a `Transient` stage the elapsed time\n * (`TransientAnalysis::time`), and for a `Modal` stage always `0.0` (a\n * single eigensolve has no comparable incremental progress scalar; read\n * `Mode::frequency` from a `ModeShape` recorder\'s batch instead). `error`,\n * once set, is sticky \u{2014} later stages are not attempted, matching \"a\n * stage\'s `AnalysisError` stops the sequence\".\n */\nexport interface StepOutcome {\n done: boolean;\n stageComplete: boolean;\n stepsTaken: number;\n loadFactor: number;\n error: AnalysisErrorDetail | undefined;\n /**\n * Diagnostics of the last accepted arc-length step this call took\n * (radius, retries, solves, chord length, determinant sign, stop\n * criterion), or `None` when it took none. With arc length the load\n * factor can decrease and repeat, so samples are ordered by their\n * sample index, never by load factor.\n */\n continuation: ContinuationDetail | undefined;\n /**\n * Only the samples *this* `advance()` call produced, one entry per recorder that recorded\n * at least one sample this call (every recorder samples every step today, so in practice\n * this is either empty \u{2014} no step taken \u{2014} or has one entry per recorder). This is the\n * results-storage plan\'s (docs/results-storage-indexeddb.md) `recorderBatch`, restated in\n * field names that match pysees\'s frozen `ResultBlock` protocol type\n * (`src/app/types/resultsStorage.ts`); the caller assigns `blockIndex` and packs `data`,\n * since neither concept exists on this side of the wasm boundary.\n */\n recorderBatches: RecorderBatch[];\n}"

Source§

const SERIALIZATION_CONFIG: SerializationConfig

Source§

type JsType = JsType

Must be a type imported through #[wasm_bindgen] extern "C" { .. }. [Ts<T>] is #[repr(transparent)] over this and passes it across the ABI as a plain JS handle, which any other representation would break.
§

fn into_js(&self) -> Result<Self::JsType, Error>
where Self: Serialize,

§

fn into_ts(&self) -> Result<Ts<Self>, Error>
where Self: Sized + Serialize,

Calls Ts::from_rust on self, returning a Result<Ts<Self>, crate::Error>. 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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more