Struct CorrelationAnalyzer 

pub struct CorrelationAnalyzer { /* private fields */ }

Analyzer for computing correlation between two numeric columns.

Example

use term_guard::analyzers::advanced::{CorrelationAnalyzer, CorrelationType};

let analyzer = CorrelationAnalyzer::new(
    "height",
    "weight",
    CorrelationType::Pearson
);

Implementations

impl CorrelationAnalyzer

pub fn new( column1: impl Into<String>, column2: impl Into<String>, correlation_type: CorrelationType, ) -> Self

Creates a new correlation analyzer.

pub fn pearson(column1: impl Into<String>, column2: impl Into<String>) -> Self

Creates a Pearson correlation analyzer.

pub fn spearman(column1: impl Into<String>, column2: impl Into<String>) -> Self

Creates a Spearman correlation analyzer.

pub fn covariance( column1: impl Into<String>, column2: impl Into<String>, ) -> Self

Creates a covariance analyzer.

Trait Implementations

impl Analyzer for CorrelationAnalyzer

type State = CorrelationState

The state type for incremental computation.

type Metric = MetricValue

The metric type produced by this analyzer.

fn compute_state_from_data<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = AnalyzerResult<Self::State>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Computes the state from the input data.

fn compute_metric_from_state( &self, state: &Self::State, ) -> AnalyzerResult<Self::Metric>

Computes the final metric from the accumulated state.

fn name(&self) -> &str

Returns the name of this analyzer.

fn description(&self) -> &str

Returns a description of what this analyzer computes.

fn metric_key(&self) -> String

Returns the metric key for storing results.

fn columns(&self) -> Vec<&str>

Returns the column(s) this analyzer operates on, if any.

fn merge_states(&self, states: Vec<Self::State>) -> AnalyzerResult<Self::State>

Merges multiple states into a single state.

fn is_combinable(&self) -> bool

Indicates whether this analyzer can be combined with others.

impl Clone for CorrelationAnalyzer

fn clone(&self) -> CorrelationAnalyzer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CorrelationAnalyzer

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

Formats the value using the given formatter.