Skip to main content

SpectralBudget

Struct SpectralBudget 

Source
pub struct SpectralBudget {
    pub principal_period: f64,
    pub ring_down_factor: f64,
}
Expand description

A ceiling on the diameter a bounded sequential domain may reach before its becoming exceeds the principal eigenvalue of the underlying Laplacian.

For a closed scene of diameter d with wave-speed c, the principal period is T_1 ≈ 2·d/c (Faber–Krahn). The recommended ceiling is ring_down_factor · T_1 — capturing the first few rings of the lowest mode.

Fields§

§principal_period: f64

T_1 — period of the lowest mode of the bounded domain.

§ring_down_factor: f64

Multiplier on T_1 defining the admission ceiling. 3.0 by default — three ring-down cycles of the principal mode.

Implementations§

Source§

impl SpectralBudget

Source

pub fn for_scene_diameter(diam_m: f64, c: f64) -> SpectralBudget

Continuous Dirichlet bound for a scene of diameter diam_m (metres) with propagation speed c (m/s). T_1 = 2·diam/c. Useful for physical (path-tracer-style) budgets.

Source

pub fn try_admit(&self, diameter: f64) -> Result<(), BudgetError>

Strict admission. Returns Ok(()) if the diameter sits within the ring_down_factor · principal_period ceiling; otherwise returns the structured violation so the caller can decide to abort, downgrade, or surface the error.

Source

pub fn admits(&self, diameter: f64) -> bool

Boolean shortcut where the caller does not need violation detail. Prefer Self::try_admit when you need to surface the reason.

Trait Implementations§

Source§

impl Clone for SpectralBudget

Source§

fn clone(&self) -> SpectralBudget

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 SpectralBudget

Source§

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

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

impl Copy for SpectralBudget

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V