Struct Ring 

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

A ring topology over a collection of elements.

Provides circular access patterns and ring-based distance metrics. Elements are stored contiguously for cache efficiency.

Implementations

impl<T> Ring<T>

pub fn new(nodes: Vec<T>) -> Self

Create a new ring from a vector of nodes.

Panics

Panics if nodes is empty.

pub fn with_capacity(capacity: usize) -> Self

Create a ring with capacity for n nodes.

pub fn len(&self) -> usize

Number of nodes in the ring.

pub fn is_empty(&self) -> bool

Check if the ring is empty.

pub fn get(&self, idx: usize) -> &T

Get a reference to the node at the given index (wrapping).

pub fn get_mut(&mut self, idx: usize) -> &mut T

Get a mutable reference to the node at the given index (wrapping).

pub fn next(&self, idx: usize) -> usize

Get the next index in the ring (wrapping).

pub fn prev(&self, idx: usize) -> usize

Get the previous index in the ring (wrapping).

pub fn ring_distance(&self, a: usize, b: usize) -> usize

Compute the ring distance between two indices.

The ring distance is the shortest path between two nodes, going either forward or backward around the ring.

Example

For a ring of size 5:

• ring_distance(0, 1) = 1 (one step forward)
• ring_distance(0, 4) = 1 (one step backward)
• ring_distance(0, 2) = 2 (two steps either way)

pub fn neighbors(&self, idx: usize, radius: usize) -> impl Iterator<Item = &T>

Iterate over neighbors within a given radius.

Returns an iterator yielding references to nodes within radius steps in both directions.

Example

For a ring [0, 1, 2, 3, 4], neighbors(0, 1) yields nodes at indices 4, 1 (previous and next).

pub fn neighbor_indices(&self, idx: usize, radius: usize) -> Vec<usize>

Get neighbor indices within a given radius.

Returns indices (not values) of neighbors.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterate over all nodes in order.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterate over all nodes mutably in order.

pub fn iter_from(&self, start: usize) -> impl Iterator<Item = &T>

Iterate starting from a given index, wrapping around.

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

Push a new node to the ring.

pub fn as_slice(&self) -> &[T]

Get the underlying nodes as a slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Get the underlying nodes as a mutable slice.

pub fn into_inner(self) -> Vec<T>

Into the underlying vector.

Trait Implementations

impl<T: Clone> Clone for Ring<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ring<T>

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

Formats the value using the given formatter.

impl<T> FromIterator<T> for Ring<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> Index<usize> for Ring<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.