Skip to main content

CyclePolicy

Enum CyclePolicy 

Source
pub enum CyclePolicy {
    Error,
    Iterate {
        max_iterations: u32,
        max_change: f64,
    },
}
Expand description

What happens to witnessed (live) cycles under CycleDetection::Runtime.

Variants§

§

Error

Live cycles produce #CIRC!.

§

Iterate

Excel-style iterative calculation (RFC #113, spec §3.5/§6): live cycles keep running full passes over all SCC members in member order (Gauss–Seidel: each result is committed before the next member runs) until every member converges per the spec-§6 rules or max_iterations total passes (pass 1 included) have run. Hitting the cap keeps the last values and is NOT an error (Excel parity); telemetry records capped_sccs.

Fields

§max_iterations: u32

Total passes per SCC per recalc, pass 1 included. 1 means each member evaluates exactly once per recalc (the Excel accumulator contract, spec §7.6); 0 is a config error.

§max_change: f64

Absolute per-member convergence threshold on f64 serial values (|Δ| < max_change, strict — Excel semantics). Negative or non-finite values are config errors.

Implementations§

Source§

impl CyclePolicy

Source

pub const EXCEL_DEFAULT_MAX_ITERATIONS: u32 = 100

Excel’s default iterative-calculation knobs.

Source

pub const EXCEL_DEFAULT_MAX_CHANGE: f64 = 0.001

Excel’s default maximum-change threshold.

Source

pub fn iterate_excel_defaults() -> Self

Iterate with Excel’s defaults (100 iterations, 0.001 max change).

Trait Implementations§

Source§

impl Clone for CyclePolicy

Source§

fn clone(&self) -> CyclePolicy

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 Copy for CyclePolicy

Source§

impl Debug for CyclePolicy

Source§

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

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

impl Default for CyclePolicy

Source§

fn default() -> CyclePolicy

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CyclePolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CyclePolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.