Struct CorrelationHeatmap 

pub struct CorrelationHeatmap { /* private fields */ }

A correlation heatmap: a square, labeled, color-mapped grid of a correlation matrix, with an optional colorbar and per-cell value annotations.

Defaults suit correlations: a diverging RdBu colormap on a symmetric [-1, 1] normalization (0 → white).

Implementations

impl CorrelationHeatmap

pub fn from_columns( columns: &[Vec<f64>], labels: Vec<String>, method: CorrelationMethod, ) -> Result<Self, StatsError>

Compute the correlation matrix of columns (one slice per variable, all the same length) and build a heatmap. labels names the variables.

Errors

• StatsError::LengthMismatch if labels and columns differ in count.
• plus any error from correlation_matrix.

pub fn from_matrix(matrix: Vec<Vec<f64>>, labels: Vec<String>) -> Self

Build directly from a precomputed square matrix and its labels.

pub fn colormap(self, colormap: GradientColorMap) -> Self

Set the color map.

pub fn normalization(self, norm: Normalization) -> Self

Set the value→color normalization.

pub fn annotate(self, on: bool) -> Self

Toggle per-cell value labels.

pub fn precision(self, precision: usize) -> Self

Decimal places for cell annotations.

pub fn colorbar(self, on: bool) -> Self

Toggle the colorbar.

pub fn gridlines(self, on: bool) -> Self

Toggle white cell gridlines.

pub fn title(self, title: impl Into<String>) -> Self

Set a title drawn above the grid.

pub fn draw<DB: DrawingBackend>( &self, area: &DrawingArea<DB, Shift>, ) -> Result<(), Box<dyn Error>>

where DB::ErrorType: 'static,

Render the heatmap onto area.

Trait Implementations

impl Clone for CorrelationHeatmap

fn clone(&self) -> CorrelationHeatmap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationHeatmap

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

Formats the value using the given formatter.