Skip to main content

SymbolCorrelationMatrix

Struct SymbolCorrelationMatrix 

Source
pub struct SymbolCorrelationMatrix {
    pub symbols: Vec<String>,
    pub matrix: Vec<Vec<f64>>,
    pub n: usize,
}
Expand description

Full Pearson correlation matrix for a fixed set of symbols.

Constructed from complete return histories; not updated incrementally. For rolling / streaming use, see RollingCorrelation.

Fields§

§symbols: Vec<String>

Symbol labels in order.

§matrix: Vec<Vec<f64>>

n×n correlation matrix (row-major).

§n: usize

Dimension (number of symbols).

Implementations§

Source§

impl SymbolCorrelationMatrix

Source

pub fn from_returns(symbols: Vec<String>, returns: Vec<Vec<f64>>) -> Self

Build the Pearson correlation matrix from full return series.

symbols and returns must have the same length; all return slices must also have the same length (the minimum across series is used).

Source

pub fn get(&self, i: usize, j: usize) -> f64

Get the correlation between symbols at indices i and j.

Source

pub fn to_table(&self) -> String

Render the correlation matrix as a plain-text ASCII table.

Source

pub fn highly_correlated(&self, threshold: f64) -> Vec<(String, String, f64)>

Returns all symbol pairs where |correlation| > threshold.

Each entry is (symbol_a, symbol_b, correlation) for i < j.

Source

pub fn eigenvalues(&self) -> Vec<f64>

Compute eigenvalues of the correlation matrix using the Jacobi sweep algorithm.

Returns eigenvalues in descending order. The Jacobi method iteratively zeroes off-diagonal elements via plane rotations.

Trait Implementations§

Source§

impl Clone for SymbolCorrelationMatrix

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 SymbolCorrelationMatrix

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.