Struct MemoryAnalysis 

pub struct MemoryAnalysis {
    pub format: SparseFormat,
    pub nnz: usize,
    pub estimated_memory: usize,
    pub dense_memory: usize,
    pub compression_ratio: f32,
    pub overhead_per_nnz: f32,
    pub matrix_dimensions: (usize, usize),
    pub memory_breakdown: MemoryBreakdown,
    pub metrics: HashMap<String, f64>,
}

Comprehensive memory analysis result for sparse tensors

This struct provides detailed information about memory usage patterns, compression characteristics, and efficiency metrics for sparse tensor storage.

Fields

format: SparseFormat

Sparse format being analyzed

nnz: usize

Number of non-zero elements

estimated_memory: usize

Estimated memory usage for sparse representation (bytes)

dense_memory: usize

Memory usage if stored as dense tensor (bytes)

compression_ratio: f32

Compression ratio (dense_memory / sparse_memory)

overhead_per_nnz: f32

Memory overhead per non-zero element (bytes)

matrix_dimensions: (usize, usize)

Matrix dimensions (rows, columns)

memory_breakdown: MemoryBreakdown

Memory breakdown by component

metrics: HashMap<String, f64>

Additional memory metrics

Implementations

impl MemoryAnalysis

pub fn new( format: SparseFormat, nnz: usize, matrix_dimensions: (usize, usize), ) -> Self

Create a new memory analysis result

pub fn compression_effectiveness(&self) -> f32

Calculate compression effectiveness score (0-1, higher is better)

pub fn sparsity_ratio(&self) -> f32

Get sparsity ratio (percentage of zero elements)

pub fn is_memory_efficient(&self) -> bool

Check if sparse representation is memory efficient

pub fn memory_efficiency_rating(&self) -> String

Get memory efficiency rating (Poor, Fair, Good, Excellent)

pub fn add_metric(&mut self, key: String, value: f64)

Add a custom memory metric

Trait Implementations

impl Clone for MemoryAnalysis

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryAnalysis

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

Formats the value using the given formatter.