Struct CorrelationConstraint 

pub struct CorrelationConstraint { /* private fields */ }

A unified constraint that validates correlations and relationships between columns.

This constraint replaces individual correlation constraints and provides a consistent interface for all correlation-based validations.

Examples

use term_guard::constraints::{CorrelationConstraint, CorrelationType, Assertion};
use term_guard::core::Constraint;

// Check Pearson correlation
let pearson_check = CorrelationConstraint::pearson(
    "height",
    "weight",
    Assertion::Between(0.6, 0.9)
);

// Check independence
let independence_check = CorrelationConstraint::independence(
    "user_id",
    "transaction_amount",
    0.1
);

// Check mutual information
let mi_check = CorrelationConstraint::mutual_information(
    "category",
    "price",
    10, // bins
    Assertion::GreaterThan(0.5)
);

Implementations

impl CorrelationConstraint

pub fn new(validation: CorrelationValidation) -> Result<Self>

Creates a new unified correlation constraint.

Arguments

• validation - The type of validation to perform

Errors

Returns an error if column names are invalid.

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

Convenience constructor for Pearson correlation.

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

Convenience constructor for Spearman correlation.

pub fn mutual_information( column1: impl Into<String>, column2: impl Into<String>, bins: usize, assertion: Assertion, ) -> Result<Self>

Convenience constructor for mutual information.

pub fn independence( column1: impl Into<String>, column2: impl Into<String>, max_correlation: f64, ) -> Result<Self>

Convenience constructor for independence check.

Trait Implementations

impl Clone for CorrelationConstraint

fn clone(&self) -> CorrelationConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Constraint for CorrelationConstraint

fn evaluate<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = Result<ConstraintResult>> + Send + 'async_trait>>

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

Evaluates the constraint against the data in the session context.

fn name(&self) -> &str

Returns the name of the constraint.

fn metadata(&self) -> ConstraintMetadata

Returns the metadata associated with this constraint.

fn column(&self) -> Option<&str>

Returns the column this constraint operates on (if single-column).

fn description(&self) -> Option<&str>

Returns a description of what this constraint validates.

impl Debug for CorrelationConstraint

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

Formats the value using the given formatter.