Struct SegmentPlan 

pub struct SegmentPlan { /* private fields */ }

An immutable, bounded segmentation policy.

Implementations

impl SegmentPlan

pub fn new(total_steps: u64, segment_steps: u64) -> Result<Self>

Builds a plan that trains total_steps in segment_steps chunks.

Errors

Returns SpikeError::Segment if either step count is zero, if the default fidelity would require more than MAX_SEGMENTS segments, or if the segment count cannot fit in usize.

pub const fn total_steps(&self) -> u64

The default full-fidelity budget.

pub const fn segment_steps(&self) -> u64

The stride used for every non-final segment.

pub fn segments(&self) -> Result<Vec<Segment>>

Derives segments for the plan’s default fidelity.

Errors

Returns SpikeError::Segment if the default fidelity cannot be represented as a bounded segment list.

pub fn segments_for(&self, total_steps: u64) -> Result<Vec<Segment>>

Derives a bounded segment list for one trial fidelity.

Errors

Returns SpikeError::Segment if total_steps is zero, if the fidelity would require more than MAX_SEGMENTS segments, or if the segment count cannot fit in usize.

pub fn rungs(&self) -> Vec<u64>

The cumulative boundaries at which a segmented objective reports.

Trait Implementations

impl Clone for SegmentPlan

fn clone(&self) -> SegmentPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SegmentPlan

impl Debug for SegmentPlan

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

Formats the value using the given formatter.

impl Eq for SegmentPlan

impl PartialEq for SegmentPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SegmentPlan