nstack 0.8.0

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

//! NStack
//!
//! A stack datastructure with indexed lookup.
#![no_std]
#![allow(clippy::large_enum_variant)]
use core::mem;

use canonical::{Canon, CanonError};
use canonical_derive::Canon;

use microkelvin::{
    Annotated, Child, ChildMut, Combine, Compound, MutableLeaves,
};

const N: usize = 4;

// Clippy complains about the difference in size between the enum variants, however since the
// most common case is the larger enum, and node traversal should be fast, we trade memory for
// speed here.
#[derive(Clone, Canon, Debug)]
pub enum NStack<T, A> {
    Leaf([Option<T>; N]),
    Node([Option<Annotated<NStack<T, A>, A>>; N]),
}

impl<T, A> Compound<A> for NStack<T, A>
where
    T: Canon,
    A: Canon,
{
    type Leaf = T;

    fn child(&self, ofs: usize) -> Child<Self, A> {
        match (ofs, self) {
            (0, NStack::Node([Some(a), _, _, _])) => Child::Node(a),
            (1, NStack::Node([_, Some(b), _, _])) => Child::Node(b),
            (2, NStack::Node([_, _, Some(c), _])) => Child::Node(c),
            (3, NStack::Node([_, _, _, Some(d)])) => Child::Node(d),
            (0, NStack::Leaf([Some(a), _, _, _])) => Child::Leaf(a),
            (1, NStack::Leaf([_, Some(b), _, _])) => Child::Leaf(b),
            (2, NStack::Leaf([_, _, Some(c), _])) => Child::Leaf(c),
            (3, NStack::Leaf([_, _, _, Some(d)])) => Child::Leaf(d),
            _ => Child::EndOfNode,
        }
    }

    fn child_mut(&mut self, ofs: usize) -> ChildMut<Self, A> {
        match (ofs, self) {
            (0, NStack::Node([Some(a), _, _, _])) => ChildMut::Node(a),
            (1, NStack::Node([_, Some(b), _, _])) => ChildMut::Node(b),
            (2, NStack::Node([_, _, Some(c), _])) => ChildMut::Node(c),
            (3, NStack::Node([_, _, _, Some(d)])) => ChildMut::Node(d),
            (0, NStack::Leaf([Some(a), _, _, _])) => ChildMut::Leaf(a),
            (1, NStack::Leaf([_, Some(b), _, _])) => ChildMut::Leaf(b),
            (2, NStack::Leaf([_, _, Some(c), _])) => ChildMut::Leaf(c),
            (3, NStack::Leaf([_, _, _, Some(d)])) => ChildMut::Leaf(d),
            _ => ChildMut::EndOfNode,
        }
    }
}

impl<T, A> MutableLeaves for NStack<T, A> {}

impl<T, A> Default for NStack<T, A> {
    fn default() -> Self {
        NStack::Leaf([None, None, None, None])
    }
}

enum Push<T> {
    Ok,
    NoRoom { t: T, depth: usize },
}

enum Pop<T> {
    Ok(T),
    Last(T),
    None,
}

impl<T, A> NStack<T, A>
where
    Self: Compound<A>,
    T: Canon,
    A: Canon + Combine<Self, A>,
{
    /// Creates a new empty NStack
    pub fn new() -> Self {
        Self::default()
    }

    /// Pushes a new element onto the stack
    pub fn push(&mut self, t: T) -> Result<(), CanonError> {
        match self._push(t)? {
            Push::Ok => Ok(()),
            Push::NoRoom { t, .. } => {
                let old_root = mem::take(self);

                let mut new_node = [None, None, None, None];
                new_node[0] = Some(Annotated::new(old_root));

                *self = NStack::Node(new_node);

                // the first child of our new root will be our old root
                self.push(t)
            }
        }
    }

    fn _push(&mut self, t: T) -> Result<Push<T>, CanonError> {
        match self {
            NStack::Leaf(leaf) => {
                for mut item in leaf.iter_mut() {
                    match item {
                        ref mut empty @ None => {
                            **empty = Some(t);
                            return Ok(Push::Ok);
                        }
                        Some(_) => (),
                    }
                }
                Ok(Push::NoRoom { t, depth: 0 })
            }
            NStack::Node(node) => {
                let mut insert_node = None;

                // find last node, searching from reverse
                for i in 0..N {
                    let i = N - i - 1;

                    match &mut node[i] {
                        None => (),
                        Some(annotated) => {
                            match annotated.val_mut()?._push(t)? {
                                Push::Ok => return Ok(Push::Ok),
                                Push::NoRoom { t, depth } => {
                                    // Are we in the last node
                                    if i == N - 1 {
                                        return Ok(Push::NoRoom {
                                            t,
                                            depth: depth + 1,
                                        });
                                    } else {
                                        // create a new node
                                        let mut new_node = NStack::Leaf([
                                            Some(t),
                                            None,
                                            None,
                                            None,
                                        ]);

                                        // give it enough depth
                                        for _ in 0..depth {
                                            let old_root = mem::replace(
                                                &mut new_node,
                                                NStack::new(),
                                            );
                                            new_node = NStack::Node([
                                                Some(Annotated::new(old_root)),
                                                None,
                                                None,
                                                None,
                                            ]);
                                        }

                                        // Insert node
                                        insert_node = Some((new_node, i + 1));
                                        break;
                                    }
                                }
                            }
                        }
                    }
                }
                // break out and insert
                if let Some((new_node, index)) = insert_node {
                    node[index] = Some(Annotated::new(new_node));
                } else {
                    unreachable!()
                }

                Ok(Push::Ok)
            }
        }
    }

    /// Pop an element off the stack.
    ///
    /// Returns the popped element, if any.
    pub fn pop(&mut self) -> Result<Option<T>, CanonError> {
        match self._pop()? {
            Pop::Ok(t) | Pop::Last(t) => Ok(Some(t)),
            Pop::None => Ok(None),
        }
    }

    fn _pop(&mut self) -> Result<Pop<T>, CanonError> {
        let mut clear_node = None;

        match self {
            NStack::Leaf(leaf) => {
                for i in 0..N {
                    // reverse
                    let i = N - i - 1;
                    if let Some(leaf) = leaf[i].take() {
                        if i > 0 {
                            return Ok(Pop::Ok(leaf));
                        } else {
                            return Ok(Pop::Last(leaf));
                        }
                    }
                }
                Ok(Pop::None)
            }
            NStack::Node(node) => {
                for i in 0..N {
                    // reverse
                    let i = N - i - 1;
                    if let Some(ref mut subtree) = node[i] {
                        match subtree.val_mut()?._pop()? {
                            Pop::Ok(t) => return Ok(Pop::Ok(t)),
                            Pop::Last(t) => {
                                if i == 0 {
                                    return Ok(Pop::Last(t));
                                } else {
                                    clear_node = Some((t, i));
                                    break;
                                }
                            }
                            Pop::None => return Ok(Pop::None),
                        }
                    }
                }
                if let Some((popped, clear_index)) = clear_node {
                    node[clear_index] = None;
                    Ok(Pop::Ok(popped))
                } else {
                    unreachable!()
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use core::borrow::Borrow;
    use microkelvin::{Annotation, Cardinality, Combine, Keyed, MaxKey, Nth};

    #[test]
    fn trivial() {
        let mut nt = NStack::<u32, Cardinality>::new();
        assert_eq!(nt.pop().unwrap(), None);
    }

    #[test]
    fn push_pop() {
        let mut nt = NStack::<_, Cardinality>::new();
        nt.push(8).unwrap();
        assert_eq!(nt.pop().unwrap(), Some(8));
    }

    #[test]
    fn double() {
        let mut nt = NStack::<_, Cardinality>::new();
        nt.push(0).unwrap();
        nt.push(1).unwrap();
        assert_eq!(nt.pop().unwrap(), Some(1));
        assert_eq!(nt.pop().unwrap(), Some(0));
    }

    #[test]
    fn multiple() {
        let n = 1024;

        let mut nt = NStack::<_, Cardinality>::new();

        for i in 0..n {
            nt.push(i).unwrap();
        }

        for i in 0..n {
            assert_eq!(nt.pop().unwrap(), Some(n - i - 1));
        }

        assert_eq!(nt.pop().unwrap(), None);
    }

    #[test]
    fn nth() {
        let n: u64 = 1024;

        let mut nstack = NStack::<_, Cardinality>::new();

        for i in 0..n {
            nstack.push(i).unwrap();
        }

        for i in 0..n {
            assert_eq!(*nstack.nth(i).unwrap().unwrap(), i);
        }

        assert!(nstack.nth(n).unwrap().is_none());
    }

    #[test]
    fn nth_mut() -> Result<(), CanonError> {
        let n: u64 = 1024;

        let mut nstack = NStack::<_, Cardinality>::new();

        for i in 0..n {
            nstack.push(i)?;
        }

        for i in 0..n {
            *nstack.nth_mut(i)?.unwrap() += 1;
        }

        for i in 0..n {
            assert_eq!(*nstack.nth(i)?.unwrap(), i + 1);
        }

        Ok(())
    }

    // Assert that all branches are always of the same length
    #[test]
    fn branch_lengths() -> Result<(), CanonError> {
        let n = 256;

        let mut nt = NStack::<_, Cardinality>::new();

        for i in 0..n {
            nt.push(i)?;
        }

        let length_zero = nt.nth(0)?.unwrap().depth();

        for i in 1..n {
            assert_eq!(length_zero, nt.nth(i)?.unwrap().depth())
        }

        Ok(())
    }

    #[derive(Canon, Clone, Debug)]
    struct MaxAndCardinality<K> {
        cardinality: Cardinality,
        max: MaxKey<K>,
    }

    impl<K> Default for MaxAndCardinality<K> {
        fn default() -> Self {
            Self {
                max: Default::default(),
                cardinality: Default::default(),
            }
        }
    }

    impl<K> Borrow<Cardinality> for MaxAndCardinality<K> {
        fn borrow(&self) -> &Cardinality {
            &self.cardinality
        }
    }

    impl<K> Borrow<MaxKey<K>> for MaxAndCardinality<K> {
        fn borrow(&self) -> &MaxKey<K> {
            &self.max
        }
    }

    impl<K, L> Annotation<L> for MaxAndCardinality<K>
    where
        L: Keyed<K>,
        K: Clone,
    {
        fn from_leaf(leaf: &L) -> Self {
            Self {
                cardinality: Cardinality::from_leaf(leaf),
                max: MaxKey::from_leaf(leaf),
            }
        }
    }

    impl<C, A, K> Combine<C, A> for MaxAndCardinality<K>
    where
        C: Compound<A>,
        C::Leaf: Keyed<K> + Clone,
        A: Borrow<Cardinality> + Borrow<MaxKey<K>>,
        A: Annotation<C::Leaf>,
        K: Clone + Ord,
    {
        fn combine(node: &C) -> Self {
            Self {
                cardinality: Cardinality::combine(node),
                max: MaxKey::combine(node),
            }
        }
    }
}