feanor-math 3.5.18

A library for number theory, providing implementations for arithmetic in various rings and algorithms working on them.
Documentation
use std::fmt::Debug;
use std::marker::PhantomData;

use super::{
    SelfSubvectorFn, SelfSubvectorView, SparseVectorViewOperation, SwappableVectorViewMut, VectorFn, VectorView,
    VectorViewMut, VectorViewSparse,
};

pub struct SubvectorView<V: VectorView<T>, T: ?Sized> {
    begin: usize,
    end: usize,
    base: V,
    element: PhantomData<T>,
}

impl<V: Clone + VectorView<T>, T: ?Sized> Clone for SubvectorView<V, T> {
    fn clone(&self) -> Self {
        Self {
            begin: self.begin,
            end: self.end,
            base: self.base.clone(),
            element: PhantomData,
        }
    }
}

impl<V: Copy + VectorView<T>, T: ?Sized> Copy for SubvectorView<V, T> {}

impl<V: VectorView<T>, T: ?Sized> SubvectorView<V, T> {
    pub fn new(base: V) -> Self {
        Self {
            begin: 0,
            end: base.len(),
            base,
            element: PhantomData,
        }
    }
}

impl<V: VectorView<T>, T: ?Sized> VectorView<T> for SubvectorView<V, T> {
    fn at(&self, i: usize) -> &T {
        assert!(i < self.len());
        self.base.at(i + self.begin)
    }

    fn len(&self) -> usize { self.end - self.begin }

    fn specialize_sparse<'a, Op: SparseVectorViewOperation<T>>(&'a self, op: Op) -> Option<Op::Output<'a>> {
        struct WrapSubvector<T: ?Sized, Op: SparseVectorViewOperation<T>> {
            op: Op,
            element: PhantomData<T>,
            begin: usize,
            end: usize,
        }

        impl<T: ?Sized, Op: SparseVectorViewOperation<T>> SparseVectorViewOperation<T> for WrapSubvector<T, Op> {
            type Output<'a>
                = Op::Output<'a>
            where
                Self: 'a;

            fn execute<'a, V: 'a + VectorViewSparse<T> + Clone>(self, vector: V) -> Self::Output<'a>
            where
                Self: 'a,
            {
                self.op
                    .execute(SubvectorView::new(vector).restrict_full(self.begin..self.end))
            }
        }

        self.base.specialize_sparse(WrapSubvector {
            op,
            element: PhantomData,
            begin: self.begin,
            end: self.end,
        })
    }

    fn as_slice(&self) -> Option<&[T]>
    where
        T: Sized,
    {
        self.base.as_slice().map(|slice| &slice[self.begin..self.end])
    }
}

impl<V: VectorView<T> + Debug, T: ?Sized> Debug for SubvectorView<V, T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("SubvectorView")
            .field("begin", &self.begin)
            .field("end", &self.end)
            .field("base", &self.base)
            .finish()
    }
}

pub struct FilterWithinRangeIter<'a, T: ?Sized, I>
where
    T: 'a,
    I: Iterator<Item = (usize, &'a T)>,
{
    it: I,
    begin: usize,
    end: usize,
}

impl<'a, T: ?Sized, I> Iterator for FilterWithinRangeIter<'a, T, I>
where
    T: 'a,
    I: Iterator<Item = (usize, &'a T)>,
{
    type Item = (usize, &'a T);

    fn next(&mut self) -> Option<Self::Item> { self.it.by_ref().find(|(i, _)| *i >= self.begin && *i < self.end) }
}

impl<V: VectorViewSparse<T>, T: ?Sized> VectorViewSparse<T> for SubvectorView<V, T> {
    type Iter<'a>
        = FilterWithinRangeIter<'a, T, V::Iter<'a>>
    where
        Self: 'a,
        T: 'a;

    fn nontrivial_entries<'a>(&'a self) -> Self::Iter<'a> {
        FilterWithinRangeIter {
            it: self.base.nontrivial_entries(),
            begin: self.begin,
            end: self.end,
        }
    }
}

impl<V: VectorViewMut<T>, T: ?Sized> VectorViewMut<T> for SubvectorView<V, T> {
    fn at_mut(&mut self, i: usize) -> &mut T {
        assert!(i < self.len());
        self.base.at_mut(i + self.begin)
    }

    fn as_slice_mut(&mut self) -> Option<&mut [T]>
    where
        T: Sized,
    {
        self.base.as_slice_mut().map(|slice| &mut slice[self.begin..self.end])
    }
}

impl<V: SwappableVectorViewMut<T>, T: ?Sized> SwappableVectorViewMut<T> for SubvectorView<V, T> {
    fn swap(&mut self, i: usize, j: usize) {
        assert!(i < self.len());
        assert!(j < self.len());
        self.base.swap(i + self.begin, j + self.begin)
    }
}

impl<V: VectorView<T>, T: ?Sized> SelfSubvectorView<T> for SubvectorView<V, T> {
    fn restrict_full(mut self, range: std::ops::Range<usize>) -> Self {
        assert!(range.end <= self.len());
        debug_assert!(range.start <= range.end);
        self.end = self.begin + range.end;
        self.begin += range.start;
        return self;
    }
}

pub struct SubvectorFn<V: VectorFn<T>, T> {
    begin: usize,
    end: usize,
    base: V,
    element: PhantomData<T>,
}

impl<V: Clone + VectorFn<T>, T> Clone for SubvectorFn<V, T> {
    fn clone(&self) -> Self {
        Self {
            begin: self.begin,
            end: self.end,
            base: self.base.clone(),
            element: PhantomData,
        }
    }
}

impl<V: Copy + VectorFn<T>, T> Copy for SubvectorFn<V, T> {}

impl<V: VectorFn<T>, T> SubvectorFn<V, T> {
    pub fn new(base: V) -> Self {
        Self {
            begin: 0,
            end: base.len(),
            base,
            element: PhantomData,
        }
    }
}

impl<V: VectorFn<T>, T> VectorFn<T> for SubvectorFn<V, T> {
    fn at(&self, i: usize) -> T {
        assert!(i < self.len());
        self.base.at(i + self.begin)
    }

    fn len(&self) -> usize { self.end - self.begin }
}

impl<V: VectorFn<T>, T> SelfSubvectorFn<T> for SubvectorFn<V, T> {
    fn restrict_full(mut self, range: std::ops::Range<usize>) -> Self {
        assert!(range.end <= self.len());
        debug_assert!(range.start <= range.end);
        self.end = self.begin + range.end;
        self.begin += range.start;
        return self;
    }
}

#[cfg(test)]
use super::sparse::SparseMapVector;
#[cfg(test)]
use crate::primitive_int::StaticRing;

#[test]
fn test_subvector_ranges() {
    let a = SubvectorView::new([0, 1, 2, 3, 4]);
    assert_eq!(3, a.restrict(0..3).len());
    assert_eq!(3, a.restrict(0..=2).len());
    assert_eq!(5, a.restrict(0..).len());
    assert_eq!(5, a.restrict(..).len());
    assert_eq!(2, a.restrict(3..).len());
}

#[test]
fn test_subvector_subvector() {
    let a = SubvectorView::new([0, 1, 2, 3, 4]);
    let b = a.restrict(1..4);
    assert_eq!(3, b.len());
    assert_eq!(1, *b.at(0));
    assert_eq!(2, *b.at(1));
    assert_eq!(3, *b.at(2));
}

#[test]
#[should_panic]
fn test_subvector_subvector_oob() {
    let a = SubvectorView::new([0, 1, 2, 3, 4]);
    let b = a.restrict(1..4);
    _ = b.restrict(0..4);
}

#[test]
fn test_subvector_fn_ranges() {
    let a = SubvectorFn::new([0, 1, 2, 3, 4].clone_els_by(|x| *x));
    assert_eq!(3, a.restrict(0..3).len());
    assert_eq!(3, a.restrict(0..=2).len());
    assert_eq!(5, a.restrict(0..).len());
    assert_eq!(5, a.restrict(..).len());
    assert_eq!(2, a.restrict(3..).len());
}

#[test]
fn test_subvector_fn_subvector() {
    let a = SubvectorFn::new([0, 1, 2, 3, 4].clone_els_by(|x| *x));
    let b = a.restrict(1..4);
    assert_eq!(3, b.len());
    assert_eq!(1, b.at(0));
    assert_eq!(2, b.at(1));
    assert_eq!(3, b.at(2));
}

#[test]
#[should_panic]
fn test_subvector_fn_subvector_oob() {
    let a = SubvectorFn::new([0, 1, 2, 3, 4].clone_els_by(|x| *x));
    let b = a.restrict(1..4);
    _ = b.restrict(0..4);
}

#[test]
fn test_subvector_sparse() {
    let mut sparse_vector = SparseMapVector::new(1000, StaticRing::<i64>::RING);
    *sparse_vector.at_mut(6) = 6;
    *sparse_vector.at_mut(20) = 20;
    *sparse_vector.at_mut(256) = 256;
    *sparse_vector.at_mut(257) = 257;

    let subvector = SubvectorView::new(sparse_vector).restrict(20..=256);

    struct Verify;

    impl SparseVectorViewOperation<i64> for Verify {
        type Output<'a> = ();

        fn execute<'a, V: 'a + VectorViewSparse<i64>>(self, vector: V) -> Self::Output<'a> {
            assert!(
                vec![(20, &20), (256, &256)] == vector.nontrivial_entries().collect::<Vec<_>>()
                    || vec![(256, &256), (20, &20)] == vector.nontrivial_entries().collect::<Vec<_>>()
            );
        }
    }

    subvector.specialize_sparse(Verify).unwrap();
}