Struct DelayBuffer 

pub struct DelayBuffer { /* private fields */ }

Available on crate feature alloc only.

Circular buffer storing the last capacity observation vectors.

Observations are pushed one at a time. Once capacity observations have been stored, the buffer is “ready” and older observations are overwritten in FIFO order.

Examples

use irithyll_core::reservoir::DelayBuffer;

let mut buf = DelayBuffer::new(3);
buf.push(&[1.0]);
buf.push(&[2.0]);
buf.push(&[3.0]);
assert!(buf.is_ready());

assert_eq!(buf.get(0).unwrap(), &[3.0]); // most recent
assert_eq!(buf.get(1).unwrap(), &[2.0]);
assert_eq!(buf.get(2).unwrap(), &[1.0]); // oldest

Implementations

impl DelayBuffer

pub fn new(capacity: usize) -> Self

Create a new delay buffer with the given capacity.

Panics

Panics if capacity is 0.

pub fn push(&mut self, obs: &[f64])

Push a new observation into the buffer.

If the buffer is full, the oldest observation is overwritten.

pub fn get(&self, delay_idx: usize) -> Option<&[f64]>

Get the observation at the given delay index.

• delay_idx = 0 returns the most recently pushed observation.
• delay_idx = 1 returns the previous observation.
• Returns None if delay_idx >= len().

pub fn is_ready(&self) -> bool

Whether the buffer has been filled to capacity at least once.

NG-RC requires is_ready() before building features, because all k delay slots must be populated.

pub fn len(&self) -> usize

Number of observations currently stored (at most capacity).

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

pub fn capacity(&self) -> usize

The maximum number of observations this buffer can hold.

pub fn reset(&mut self)

Reset the buffer, discarding all stored observations.