Struct CircularBuffer 

pub struct CircularBuffer<T> { /* private fields */ }

Fixed-size circular buffer optimized for indicator calculations.

This buffer maintains a fixed capacity and automatically overwrites the oldest data when new data is added. It’s more memory-efficient than keeping all historical data when only a fixed window is needed.

Example

let mut buffer = CircularBuffer::new(3);
buffer.push(10.0);
buffer.push(20.0);
buffer.push(30.0);  // Buffer is now full: [10, 20, 30]

assert_eq!(buffer.sum(), 60.0);
assert_eq!(buffer.mean(), Some(20.0));

buffer.push(40.0);  // Overwrites 10: [20, 30, 40]
assert_eq!(buffer.sum(), 90.0);

Implementations

impl<T: Copy + Default> CircularBuffer<T>

pub fn new(capacity: usize) -> Self

Create a new circular buffer with the specified capacity.

Arguments

• capacity - Maximum number of elements the buffer can hold

Panics

Panics if capacity is 0.

pub fn push(&mut self, value: T)

Add a new value to the buffer.

If the buffer is full, this overwrites the oldest value.

pub fn get(&self, index: usize) -> Option<T>

Get a value at a specific index.

Index 0 is the oldest value, index size - 1 is the newest. Returns None if the index is out of bounds.

pub fn last(&self) -> Option<T>

Get the most recent value (last pushed).

pub fn first(&self) -> Option<T>

Get the oldest value in the buffer.

pub fn is_full(&self) -> bool

Check if the buffer is full.

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn len(&self) -> usize

Get the current number of elements in the buffer.

pub fn capacity(&self) -> usize

Get the maximum capacity of the buffer.

pub fn clear(&mut self)

Clear all elements from the buffer.

pub fn iter(&self) -> CircularBufferIter<'_, T>

Iterate over all values in the buffer (oldest to newest).

pub fn as_slice(&self) -> Vec<T>

Get a slice view of the buffer’s data in insertion order.

Note: This returns the values in chronological order (oldest to newest), which may not match the internal storage order.

impl<T> CircularBuffer<T>

where T: Copy + Default + Add<Output = T> + PartialOrd,

pub fn sum(&self) -> T

where T: Add<Output = T> + Default,

Calculate the sum of all values in the buffer.

pub fn max(&self) -> Option<T>

Find the maximum value in the buffer.

Returns None if the buffer is empty.

pub fn min(&self) -> Option<T>

Find the minimum value in the buffer.

Returns None if the buffer is empty.

impl CircularBuffer<f64>

pub fn mean(&self) -> Option<f64>

Calculate the mean (average) of all values in the buffer.

Returns None if the buffer is empty.

pub fn variance(&self) -> Option<f64>

Calculate the variance of all values in the buffer.

Returns None if the buffer is empty.

pub fn std_dev(&self) -> Option<f64>

Calculate the standard deviation of all values in the buffer.

Returns None if the buffer is empty.

Trait Implementations

impl<T: Clone> Clone for CircularBuffer<T>

fn clone(&self) -> CircularBuffer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CircularBuffer<T>

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

Formats the value using the given formatter.