Files
orchid/src/utils/substack.rs
Lawrence Bethlenfalvy 0bcf10659b Cut down on macro nonsense
- InertAtomic replaced atomic_inert! for improved tooling support
- atomic_defaults! is easier to type out than to explain in a docstring
- Changed rustfmt config to better support tiny functions such as as_any
2023-09-15 12:37:10 +01:00

118 lines
3.1 KiB
Rust

use std::collections::VecDeque;
use std::fmt::Debug;
// TODO: extract to crate
/// A frame of [Substack] which contains an element and a reference to the
/// rest of the stack.
#[derive(Clone, Copy)]
pub struct Stackframe<'a, T> {
pub item: T,
pub prev: &'a Substack<'a, T>,
pub len: usize,
}
/// A FILO stack that lives on the regular call stack as a linked list.
/// Mainly useful to detect loops in recursive algorithms where
/// the recursion isn't deep enough to warrant a heap-allocated set.
#[derive(Clone, Copy)]
pub enum Substack<'a, T> {
/// A level in the linked list
Frame(Stackframe<'a, T>),
/// The end of the list
Bottom,
}
impl<'a, T> Substack<'a, T> {
/// Convert the substack into an option of stackframe
pub fn opt(&'a self) -> Option<&'a Stackframe<'a, T>> {
match self {
Self::Frame(f) => Some(f),
Self::Bottom => None,
}
}
/// Construct an iterator over the listlike, very fast O(1)
pub fn iter(&self) -> SubstackIterator<T> { SubstackIterator { curr: self } }
/// Add the item to this substack
pub fn push(&'a self, item: T) -> Self { Self::Frame(self.new_frame(item)) }
/// Create a new frame on top of this substack
pub fn new_frame(&'a self, item: T) -> Stackframe<'a, T> {
Stackframe { item, prev: self, len: self.opt().map_or(1, |s| s.len + 1) }
}
/// obtain the previous stackframe if one exists
pub fn pop(&'a self, count: usize) -> &'a Substack<'a, T> {
if count == 0 {
self
} else if let Self::Frame(p) = self {
p.prev.pop(count - 1)
} else {
&Substack::Bottom
}
}
/// number of stackframes
pub fn len(&self) -> usize {
match self {
Self::Frame(f) => f.len,
Self::Bottom => 0,
}
}
/// is this the bottom of the stack
pub fn is_empty(&self) -> bool { self.len() == 0 }
}
impl<'a, T: Debug> Debug for Substack<'a, T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "Substack")?;
f.debug_list().entries(self.iter()).finish()
}
}
/// Iterates over a substack from the top down
pub struct SubstackIterator<'a, T> {
curr: &'a Substack<'a, T>,
}
impl<'a, T> SubstackIterator<'a, T> {
pub fn first_some<U, F: Fn(&T) -> Option<U>>(&mut self, f: F) -> Option<U> {
for x in self.by_ref() {
if let Some(result) = f(x) {
return Some(result);
}
}
None
}
/// Returns an iterator that starts from the bottom of the stack
/// and ends at the current position.
pub fn rev_vec_clone(self) -> Vec<T>
where
T: Clone,
{
let mut deque = VecDeque::with_capacity(self.curr.len());
for item in self {
deque.push_front(item.clone())
}
deque.into()
}
}
impl<'a, T> Copy for SubstackIterator<'a, T> {}
impl<'a, T> Clone for SubstackIterator<'a, T> {
fn clone(&self) -> Self { Self { curr: self.curr } }
}
impl<'a, T> Iterator for SubstackIterator<'a, T> {
type Item = &'a T;
fn next(&mut self) -> Option<&'a T> {
let curr = self.curr.opt()?;
let item = &curr.item;
let prev = curr.prev;
self.curr = prev;
Some(item)
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.curr.len(), Some(self.curr.len()))
}
}