Skip to main content

MetricsCalculator

Struct MetricsCalculator 

Source
pub struct MetricsCalculator {
    pub thresholds: IsoQualityConfig,
    /* private fields */
}
Expand description

Engine for calculating comprehensive data quality metrics.

Fields§

§thresholds: IsoQualityConfig

Configurable quality thresholds and score weights.

Implementations§

Source§

impl MetricsCalculator

Source

pub fn new() -> MetricsCalculator

Create a new calculator with default quality settings.

Source

pub fn with_thresholds(thresholds: IsoQualityConfig) -> MetricsCalculator

Create a calculator with custom thresholds

Source

pub fn strict() -> MetricsCalculator

Create a calculator with strict thresholds (finance, healthcare)

Source

pub fn lenient() -> MetricsCalculator

Create a calculator with lenient thresholds (exploratory, marketing)

Source

pub fn with_row_completeness( self, summary: Option<RowCompletenessSummary>, ) -> MetricsCalculator

Supply the engine’s exact complete-record count over the full stream.

Without it the completeness dimension can only report a lower bound for complete_records_ratio, because per-column null totals do not say whether two nulls shared a record.

Source

pub fn validate_sample_size( sample_size: usize, metric_type: &str, ) -> StatisticalValidation

Validate statistical requirements for metric calculation

Source

pub fn calculate_comprehensive_metrics( &self, data: &HashMap<String, Vec<String>>, column_profiles: &[ColumnProfile], requested_dimensions: Option<&[QualityDimension]>, ) -> Result<QualityMetrics, DataProfilerError>

Calculate comprehensive data quality metrics from column data.

When requested_dimensions is None, all dimensions are computed (backward-compatible default). When Some(&[...]), only the listed dimensions are computed; the rest are None in the returned struct.

Source

pub fn calculate_comprehensive_metrics_with_hints( &self, data: &HashMap<String, Vec<String>>, column_profiles: &[ColumnProfile], requested_dimensions: Option<&[QualityDimension]>, semantic_hints: &SemanticHints, row_duplicates: Option<RowDuplicateSummary>, ) -> Result<QualityMetrics, DataProfilerError>

Calculate comprehensive metrics with explicit semantic column hints and, when the engine tracked whole rows, full-stream duplicate counts that supersede the sample-based duplicate scan.

Source

pub fn calculate_bifurcated_metrics( &self, data: &HashMap<String, Vec<String>>, column_profiles: &[ColumnProfile], requested_dimensions: Option<&[QualityDimension]>, ) -> Result<BifurcatedResult, DataProfilerError>

Calculate quality metrics with bifurcated computation for streaming.

Phase A (exact from global counters): Completeness metrics are computed from ColumnProfile stats (null_count, total_count) which are exact even for infinite streams. Key uniqueness already uses ColumnProfile.

Phase B (sampled): Consistency, Accuracy, and Timeliness are computed from the bounded reservoir sample. Duplicate rows use a full-stream row tracker when supplied; otherwise they fall back to an aligned sample.

Returns a BifurcatedResult containing the metrics plus provenance for which dimensions are exact vs sampled.

Source

pub fn calculate_bifurcated_metrics_with_hints( &self, data: &HashMap<String, Vec<String>>, column_profiles: &[ColumnProfile], requested_dimensions: Option<&[QualityDimension]>, semantic_hints: &SemanticHints, row_duplicates: Option<RowDuplicateSummary>, ) -> Result<BifurcatedResult, DataProfilerError>

Calculate bifurcated metrics with explicit semantic column hints and, when the engine tracked whole rows, full-stream duplicate counts that supersede the sample-based duplicate scan.

Trait Implementations§

Source§

impl Default for MetricsCalculator

Source§

fn default() -> MetricsCalculator

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more