Struct MemoryCostEstimate 

pub struct MemoryCostEstimate {
    pub input_bytes: u64,
    pub output_bytes: u64,
    pub workspace_bytes: u64,
    pub peak_bytes: u64,
}

Memory estimate for a single node.

Named MemoryCostEstimate to avoid collision with crate::memory::MemoryEstimate.

Fields

input_bytes: u64

Bytes needed to hold all input tensors.

output_bytes: u64

Bytes needed for the output tensor.

workspace_bytes: u64

Temporary workspace bytes required during execution.

peak_bytes: u64

Peak bytes: input_bytes + output_bytes + workspace_bytes.

Implementations

impl MemoryCostEstimate

pub fn zero() -> Self

Create a zero estimate.

pub fn new(input_bytes: u64, output_bytes: u64, workspace_bytes: u64) -> Self

Create from components; peak_bytes is derived.

pub fn total_bytes(&self) -> u64

Sum of all byte components.

pub fn add(&self, other: &MemoryCostEstimate) -> MemoryCostEstimate

Add two estimates together.

Trait Implementations

impl Clone for MemoryCostEstimate

fn clone(&self) -> MemoryCostEstimate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryCostEstimate

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

Formats the value using the given formatter.

impl PartialEq for MemoryCostEstimate

fn eq(&self, other: &MemoryCostEstimate) -> 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 Eq for MemoryCostEstimate

impl StructuralPartialEq for MemoryCostEstimate