ndarray 0.15.2

An n-dimensional array for general elements and for numerics. Lightweight array views and slicing; views support chunking and splitting.
Documentation
#![allow(
    clippy::many_single_char_names,
    clippy::deref_addrof,
    clippy::unreadable_literal,
    clippy::many_single_char_names
)]

use defmac::defmac;
use ndarray::prelude::*;
use ndarray::arr3;
use ndarray::Zip;

#[test]
fn test_from_shape_fn() {
    let step = 3.1;
    let h = Array::from_shape_fn((5, 5), |(i, j)| {
        f64::sin(i as f64 / step) * f64::cos(j as f64 / step)
    });
    assert_eq!(h.shape(), &[5, 5]);
}

#[test]
fn test_dimension_zero() {
    let a: Array2<f32> = Array2::from(vec![[], [], []]);
    assert_eq!(vec![0.; 0], a.into_raw_vec());
    let a: Array3<f32> = Array3::from(vec![[[]], [[]], [[]]]);
    assert_eq!(vec![0.; 0], a.into_raw_vec());
}

#[test]
#[cfg(feature = "approx")]
fn test_arc_into_owned() {
    use approx::assert_abs_diff_ne;

    let a = Array2::from_elem((5, 5), 1.).into_shared();
    let mut b = a.clone();
    b.fill(0.);
    let mut c = b.into_owned();
    c.fill(2.);
    // test that they are unshared
    assert_abs_diff_ne!(a, c, epsilon = 0.01);
}

#[test]
fn test_arcarray_thread_safe() {
    fn is_send<T: Send>(_t: &T) {}
    fn is_sync<T: Sync>(_t: &T) {}
    let a = Array2::from_elem((5, 5), 1.).into_shared();

    is_send(&a);
    is_sync(&a);
}

#[test]
#[cfg(feature = "std")]
#[allow(deprecated)] // uninitialized
fn test_uninit() {
    unsafe {
        let mut a = Array::<f32, _>::uninitialized((3, 4).f());
        assert_eq!(a.dim(), (3, 4));
        assert_eq!(a.strides(), &[1, 3]);
        let b = Array::<f32, _>::linspace(0., 25., a.len())
            .into_shape(a.dim())
            .unwrap();
        a.assign(&b);
        assert_eq!(&a, &b);
        assert_eq!(a.t(), b.t());
    }
}

#[test]
fn test_from_fn_c0() {
    let a = Array::from_shape_fn((), |i| i);
    assert_eq!(a[()], ());
    assert_eq!(a.len(), 1);
    assert_eq!(a.shape(), &[]);
}

#[test]
fn test_from_fn_c1() {
    let a = Array::from_shape_fn(28, |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn test_from_fn_c() {
    let a = Array::from_shape_fn((4, 7), |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn test_from_fn_c3() {
    let a = Array::from_shape_fn((4, 3, 7), |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn test_from_fn_f0() {
    let a = Array::from_shape_fn(().f(), |i| i);
    assert_eq!(a[()], ());
    assert_eq!(a.len(), 1);
    assert_eq!(a.shape(), &[]);
}

#[test]
fn test_from_fn_f1() {
    let a = Array::from_shape_fn(28.f(), |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn test_from_fn_f() {
    let a = Array::from_shape_fn((4, 7).f(), |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn test_from_fn_f_with_zero() {
    defmac!(test_from_fn_f_with_zero shape => {
        let a = Array::from_shape_fn(shape.f(), |i| i);
        assert_eq!(a.len(), 0);
        assert_eq!(a.shape(), &shape);
    });
    test_from_fn_f_with_zero!([0]);
    test_from_fn_f_with_zero!([0, 1]);
    test_from_fn_f_with_zero!([2, 0]);
    test_from_fn_f_with_zero!([0, 1, 2]);
    test_from_fn_f_with_zero!([2, 0, 1]);
    test_from_fn_f_with_zero!([1, 2, 0]);
}

#[test]
fn test_from_fn_f3() {
    let a = Array::from_shape_fn((4, 2, 7).f(), |i| i);
    for (i, elt) in a.indexed_iter() {
        assert_eq!(i, *elt);
    }
}

#[test]
fn deny_wraparound_from_vec() {
    let five = vec![0; 5];
    let five_large = Array::from_shape_vec((3, 7, 29, 36760123, 823996703), five.clone());
    println!("{:?}", five_large);
    assert!(five_large.is_err());
    let six = Array::from_shape_vec(6, five.clone());
    assert!(six.is_err());
}

#[test]
fn test_ones() {
    let mut a = Array::<f32, _>::zeros((2, 3, 4));
    a.fill(1.0);
    let b = Array::<f32, _>::ones((2, 3, 4));
    assert_eq!(a, b);
}

#[test]
fn test_from_shape_empty_with_neg_stride() {
    // Issue #998, negative strides for an axis where it doesn't matter.
    let s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
    let v = s[..12].to_vec();
    let v_ptr = v.as_ptr();
    let a = Array::from_shape_vec((2, 0, 2).strides((1, -4isize as usize, 2)), v).unwrap();
    assert_eq!(a, arr3(&[[[0; 2]; 0]; 2]));
    assert_eq!(a.as_ptr(), v_ptr);
}

#[test]
fn test_from_shape_with_neg_stride() {
    // Issue #998, negative strides for an axis where it doesn't matter.
    let s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
    let v = s[..12].to_vec();
    let v_ptr = v.as_ptr();
    let a = Array::from_shape_vec((2, 1, 2).strides((1, -4isize as usize, 2)), v).unwrap();
    assert_eq!(a, arr3(&[[[0, 2]],
                         [[1, 3]]]));
    assert_eq!(a.as_ptr(), v_ptr);
}

#[test]
fn test_from_shape_2_2_2_with_neg_stride() {
    // Issue #998, negative strides for an axis where it doesn't matter.
    let s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
    let v = s[..12].to_vec();
    let v_ptr = v.as_ptr();
    let a = Array::from_shape_vec((2, 2, 2).strides((1, -4isize as usize, 2)), v).unwrap();
    assert_eq!(a, arr3(&[[[4, 6],
                          [0, 2]],
                         [[5, 7],
                          [1, 3]]]));
    assert_eq!(a.as_ptr(), v_ptr.wrapping_add(4));
}

#[should_panic]
#[test]
fn deny_wraparound_zeros() {
    //2^64 + 5 = 18446744073709551621 = 3×7×29×36760123×823996703  (5 distinct prime factors)
    let _five_large = Array::<f32, _>::zeros((3, 7, 29, 36760123, 823996703));
}

#[should_panic]
#[test]
fn deny_wraparound_reshape() {
    //2^64 + 5 = 18446744073709551621 = 3×7×29×36760123×823996703  (5 distinct prime factors)
    let five = Array::<f32, _>::zeros(5);
    let _five_large = five.into_shape((3, 7, 29, 36760123, 823996703)).unwrap();
}

#[should_panic]
#[test]
fn deny_wraparound_default() {
    let _five_large = Array::<f32, _>::default((3, 7, 29, 36760123, 823996703));
}

#[should_panic]
#[test]
fn deny_wraparound_from_shape_fn() {
    let _five_large = Array::<f32, _>::from_shape_fn((3, 7, 29, 36760123, 823996703), |_| 0.);
}

#[should_panic]
#[test]
#[allow(deprecated)] // uninitialized
fn deny_wraparound_uninitialized() {
    unsafe {
        let _five_large = Array::<f32, _>::uninitialized((3, 7, 29, 36760123, 823996703));
    }
}

#[should_panic]
#[test]
fn deny_wraparound_uninit() {
    let _five_large = Array::<f32, _>::uninit((3, 7, 29, 36760123, 823996703));
}


#[test]
fn maybe_uninit_1() {
    use std::mem::MaybeUninit;

    unsafe {
        // Array
        type Mat<D> = Array<f32, D>;

        let mut a = Mat::uninit((10, 10));
        a.mapv_inplace(|_| MaybeUninit::new(1.));

        let a_init = a.assume_init();
        assert_eq!(a_init, Array2::from_elem(a_init.dim(), 1.));

        // ArcArray
        type ArcMat<D> = ArcArray<f32, D>;

        let mut a = ArcMat::uninit((10, 10));
        a.mapv_inplace(|_| MaybeUninit::new(1.));
        let a2 = a.clone();

        let a_init = a.assume_init();
        assert_eq!(a_init, Array2::from_elem(a_init.dim(), 1.));

        // ArrayView
        let av_init = a2.view().assume_init();
        assert_eq!(av_init, Array2::from_elem(a_init.dim(), 1.));

        // RawArrayViewMut
        let mut a = Mat::uninit((10, 10));
        let v = a.raw_view_mut();
        Zip::from(v)
            .for_each(|ptr| *(*ptr).as_mut_ptr() = 1.);

        let u = a.raw_view_mut().assume_init();

        Zip::from(u)
            .for_each(|ptr| assert_eq!(*ptr, 1.));

    }
}