Skip to main content

ShapeHistory

Struct ShapeHistory 

Source
pub struct ShapeHistory { /* private fields */ }
Expand description

Bounded ring buffer of recent dispatch fingerprints. The predictor looks back at most MAX_HISTORY entries.

Implementations§

Source§

impl ShapeHistory

Source

pub fn new() -> Self

Empty history - no prediction is possible.

Source

pub fn record(&mut self, fingerprint: ShapeFingerprint)

Record a dispatch fingerprint. The predictor uses the most recent MAX_HISTORY entries to predict the next.

Source

pub fn latest(&self) -> Option<&ShapeFingerprint>

Most recent fingerprint, or None if history is empty.

Source

pub fn len(&self) -> usize

Number of entries currently retained.

Source

pub fn is_empty(&self) -> bool

True when no entries have been recorded yet.

Source

pub fn contains(&self, fingerprint: &ShapeFingerprint) -> bool

True when the retained history window contains fingerprint.

This lets backend-side prediction caches evict cloned predicted programs that can no longer be predicted by the bounded history.

Source

pub fn predict_next(&self) -> Option<ShapeFingerprint>

Predict the next dispatch fingerprint. Returns None when the history is too sparse or no pattern matches.

Strategy:

  1. If the last two entries are equal, predict another repeat.
  2. Otherwise, look for the smallest cycle length N such that every retained entry with an entry N positions earlier matches it. This predicts partial cycles as soon as one lag agrees, e.g. A,B,C,A,B -> C, instead of waiting for A,B,C,A,B,C.
  3. No prediction.

Trait Implementations§

Source§

impl Clone for ShapeHistory

Source§

fn clone(&self) -> ShapeHistory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShapeHistory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ShapeHistory

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more