Skip to main content

CorrelationAnalyzer

datasynth_eval::statistical

Struct CorrelationAnalyzer 

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

Analyzer for correlation analysis.

Implementations§

Source§

impl CorrelationAnalyzer

Source

pub fn new() -> Self

Create a new correlation analyzer.

Source

pub fn with_expected_correlations( self, correlations: Vec<ExpectedCorrelation>, ) -> Self

Add expected correlations to validate.

Source

pub fn with_significance_level(self, level: f64) -> Self

Set significance level.

Source

pub fn analyze( &self, data: &HashMap<String, Vec<f64>>, ) -> EvalResult<CorrelationAnalysis>

Analyze correlations in the provided data.

data is a map from field name to values for that field. All value vectors must have the same length.

Source

pub fn analyze_pair( &self, values1: &[f64], values2: &[f64], ) -> EvalResult<CorrelationCheckResult>

Analyze correlations from paired data (simpler interface for two fields).

Trait Implementations§

Source§

impl Default for CorrelationAnalyzer

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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