Skip to main content

CorrelationBreakdownDetector

Struct CorrelationBreakdownDetector 

Source
pub struct CorrelationBreakdownDetector { /* private fields */ }
Expand description

Tracks pairwise rolling correlations across N assets and detects rapid decorrelation, which is a hallmark of systemic crisis events.

The detector maintains a sliding window of cross-asset return pairs. When the fraction of pairs with |r| < threshold exceeds crisis_pair_fraction, a crisis signal is raised.

§Example

use fin_primitives::regime::CorrelationBreakdownDetector;

let mut detector = CorrelationBreakdownDetector::new(20, 0.3, 0.6).unwrap();
// Feed returns for two assets over time
for i in 0..25 {
    let r_a = if i % 2 == 0 { 0.01 } else { -0.01 };
    let r_b = if i % 3 == 0 { 0.01 } else { -0.01 }; // decorrelated
    detector.update(0, r_a);
    detector.update(1, r_b);
    if detector.is_crisis() {
        println!("Crisis at bar {i}");
    }
}

Implementations§

Source§

impl CorrelationBreakdownDetector

Source

pub fn new( window: usize, threshold: f64, crisis_fraction: f64, ) -> Result<Self, FinError>

Constructs a new detector.

  • window: rolling window length for correlation estimation.
  • threshold: Pearson |r| below which a pair is considered decorrelated.
  • crisis_fraction: fraction of pairs that must be decorrelated to signal crisis.
§Errors

Returns FinError::InvalidInput on invalid parameters.

Source

pub fn update(&mut self, asset_idx: usize, log_return: f64)

Registers a new return observation for asset asset_idx.

Assets are identified by a zero-based index. The detector auto-expands its internal storage as new asset indices are encountered.

Source

pub fn is_crisis(&self) -> bool

Returns true when a crisis-level correlation breakdown is detected.

Source

pub fn n_assets(&self) -> usize

Returns the number of asset slots registered.

Source

pub fn reset(&mut self)

Resets all return buffers.

Trait Implementations§

Source§

impl Clone for CorrelationBreakdownDetector

Source§

fn clone(&self) -> Self

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 CorrelationBreakdownDetector

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.