Struct MemoryMetrics 

pub struct MemoryMetrics {
    pub peak_memory_usage: usize,
    pub total_number_of_allocations: usize,
    pub allocated_buffers_size: Vec<usize>,
    pub total_memory_allocated: usize,
    pub output_memory_usage: usize,
}

A snapshot of the allocations a Skeleton will perform when run.

Returned by Skeleton::memory_report; every field is in bytes and reflects the plan’s cache state at the moment the report was taken.

Note

All allocations are reported as Candela sees them; they do not account for caching or memory reuse by the system allocator, so the figures may differ from what actually happens at runtime.

Examples

use candela::skeleton::SkeletonSlot;

let slot = SkeletonSlot::from_shape(&[4]);
let skeleton = (&slot * 2.0 + 1.0).into_skeleton(&[slot])?;

let report = skeleton.memory_report();
// Every field is in bytes; a [4] f64 output is 4 * 8 = 32 bytes.
assert_eq!(report.output_memory_usage, 32);
assert!(report.peak_memory_usage >= report.output_memory_usage);

Fields

peak_memory_usage: usize

peak memory usage in bytes

total_number_of_allocations: usize

number of allocations performed

allocated_buffers_size: Vec<usize>

the sizes, in bytes, of all allocated buffers

total_memory_allocated: usize

total memory allocated in bytes

output_memory_usage: usize

the size, in bytes, of the output node

Trait Implementations

impl Clone for MemoryMetrics

fn clone(&self) -> MemoryMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryMetrics

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

Formats the value using the given formatter.

impl Eq for MemoryMetrics

impl PartialEq for MemoryMetrics

fn eq(&self, other: &MemoryMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MemoryMetrics