Skip to main content

MonitoredRegion

Struct MonitoredRegion 

Source
pub struct MonitoredRegion {
    pub name: String,
    pub range: Range<usize>,
    pub on_threshold: u64,
    pub off_threshold: u64,
    pub weight: u8,
}
Expand description

A region being monitored for activity with hysteresis thresholds.

§Hysteresis

Two thresholds control state transitions to prevent chattering:

  • on_threshold: Energy must exceed this to become active
  • off_threshold: Energy must drop below this to become quiet

When energy is between the thresholds, the previous state is maintained.

§Energy Units

Energy is sum of squared magnitudes: Σ(magnitude²) For 64 dims with all magnitudes at 128: 64 × 128² = 1,048,576 For 64 dims with all magnitudes at 255: 64 × 255² = 4,161,600

Fields§

§name: String

Name for identification

§range: Range<usize>

Dimension range

§on_threshold: u64

Energy threshold to enter active state (higher threshold) Energy = sum of squared effective magnitudes (p×m×k)

§off_threshold: u64

Energy threshold to leave active state (lower threshold)

§weight: u8

Weight for convergence calculation (100 = 1.0×)

Implementations§

Source§

impl MonitoredRegion

Source

pub fn new(name: impl Into<String>, range: Range<usize>, threshold: u64) -> Self

Create a new monitored region with automatic hysteresis.

The off_threshold is set to 80% of the on_threshold by default, providing a 20% hysteresis gap to prevent chattering.

threshold: Energy threshold (sum of squared magnitudes)

Source

pub fn with_hysteresis( name: impl Into<String>, range: Range<usize>, on_threshold: u64, off_threshold: u64, ) -> Self

Create a monitored region with explicit hysteresis thresholds.

§Arguments
  • on_threshold: Energy must exceed this to become active
  • off_threshold: Energy must drop below this to become quiet
§Panics

Debug-asserts that off_threshold <= on_threshold

Source

pub fn with_gap(self, gap: u8) -> Self

Set the hysteresis gap as percentage (0-100).

off_threshold = on_threshold * (100 - gap) / 100

Source

pub fn with_weight(self, weight: u8) -> Self

Set weight (100 = 1.0×, 150 = 1.5×)

Source

pub fn hysteresis_gap(&self) -> u8

Get the hysteresis gap as percentage.

Trait Implementations§

Source§

impl Clone for MonitoredRegion

Source§

fn clone(&self) -> MonitoredRegion

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 MonitoredRegion

Source§

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

Formats the value using the given formatter. 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> 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.