Skip to main content

EnvelopeUpdateResult

Struct EnvelopeUpdateResult 

Source
pub struct EnvelopeUpdateResult {
    pub rho_eff: f32,
    pub mode: EnvelopeMode,
    pub grammar_trust: GrammarTrustScalar,
    pub in_boundary_band: bool,
    pub above_envelope: bool,
    pub recurrent_boundary_grazing: bool,
}
Expand description

Result of one RegimeEnvelope::update() call.

Fields§

§rho_eff: f32

Current effective envelope radius after mode update.

§mode: EnvelopeMode

Mode that produced this result.

§grammar_trust: GrammarTrustScalar

Grammar trust scalar T ∈ [0, 1].

§in_boundary_band: bool

True if the residual norm falls within the boundary band.

Boundary band = (ρ_eff − 4%·ρ_eff, ρ_eff].

§above_envelope: bool

True if the residual norm is above ρ_eff (envelope violation).

§recurrent_boundary_grazing: bool

True if ≥ 2 consecutive samples were in the boundary band.

Corroborates ReasonCode::RecurrentBoundaryGrazing in the grammar layer.

Trait Implementations§

Source§

impl Clone for EnvelopeUpdateResult

Source§

fn clone(&self) -> EnvelopeUpdateResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnvelopeUpdateResult

Source§

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

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

impl Copy for EnvelopeUpdateResult

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, 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.