Struct HistogramAnalyzer 

pub struct HistogramAnalyzer { /* private fields */ }

Analyzer that computes histogram distributions for numeric columns.

This analyzer creates a histogram with configurable number of buckets, providing insights into data distribution patterns. It’s memory-efficient even for high-cardinality columns by using fixed-size buckets.

Example

use term_guard::analyzers::advanced::HistogramAnalyzer;
use datafusion::prelude::*;

let ctx = SessionContext::new();
// Register your data table

let analyzer = HistogramAnalyzer::new("price", 10); // 10 buckets
let state = analyzer.compute_state_from_data(&ctx).await?;
let metric = analyzer.compute_metric_from_state(&state)?;

if let MetricValue::Histogram(distribution) = metric {
    println!("Price distribution: {} buckets", distribution.buckets.len());
    for bucket in &distribution.buckets {
        println!("[{:.2}, {:.2}): {} items",
            bucket.lower_bound, bucket.upper_bound, bucket.count);
    }
}

Implementations

impl HistogramAnalyzer

pub fn new(column: impl Into<String>, num_buckets: usize) -> Self

Creates a new histogram analyzer with the specified number of buckets.

Arguments

• column - The column to analyze
• num_buckets - Number of histogram buckets (clamped between 1 and 1000)

pub fn column(&self) -> &str

Returns the column being analyzed.

pub fn num_buckets(&self) -> usize

Returns the number of buckets.

Trait Implementations

impl Analyzer for HistogramAnalyzer

type State = HistogramState

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 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 metric_key(&self) -> String

Returns the metric key for storing results.

fn is_combinable(&self) -> bool

Indicates whether this analyzer can be combined with others.

impl Clone for HistogramAnalyzer

fn clone(&self) -> HistogramAnalyzer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramAnalyzer

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

Formats the value using the given formatter.