strided-kernel 0.4.0

Cache-optimized kernels for strided multidimensional array operations in Rust (ported from Julia Strided.jl/StridedViews.jl).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use core::fmt::Debug;
use core::ptr::NonNull;

use num_complex::{Complex32, Complex64};
use strided_kernel::{
    ErasedCopyPlan, ErasedRawStridedMut, ErasedRawStridedRef, ExecContext, KernelDType,
    KernelStorageElement, StridedError,
};

#[test]
fn erased_copy_plan_executes_f64_transposed_layout() {
    let dims = [2usize, 3];
    let src_strides = [3isize, 1];
    let dst_strides = [1isize, 2];
    let src = [0.0f64, 1.0, 2.0, 10.0, 11.0, 12.0];
    let mut dst = [0.0f64; 6];

    let plan =
        ErasedCopyPlan::compile(KernelDType::F64, &dims, &dst_strides, &src_strides).unwrap();
    {
        let source = ErasedRawStridedRef::from_slice(&src, &dims, &src_strides, 0).unwrap();
        let mut dest =
            ErasedRawStridedMut::from_slice_mut(&mut dst, &dims, &dst_strides, 0).unwrap();

        plan.execute(&ExecContext::serial(), &mut dest, &source)
            .unwrap();
    }

    assert_eq!(dst, [0.0, 10.0, 1.0, 11.0, 2.0, 12.0]);
}

#[test]
fn erased_copy_plan_rejects_dtype_mismatch() {
    let dims = [2usize];
    let strides = [1isize];
    let src = [1.0f64, 2.0];
    let mut dst = [0.0f32; 2];

    let plan = ErasedCopyPlan::compile(KernelDType::F64, &dims, &strides, &strides).unwrap();
    let source = ErasedRawStridedRef::from_slice(&src, &dims, &strides, 0).unwrap();
    let mut dest = ErasedRawStridedMut::from_slice_mut(&mut dst, &dims, &strides, 0).unwrap();

    let err = plan
        .execute(&ExecContext::serial(), &mut dest, &source)
        .unwrap_err();
    assert!(matches!(err, StridedError::DTypeMismatch { .. }));
}

fn assert_supported_copy<T>(dtype: KernelDType, input: &[T])
where
    T: Copy + Debug + Default + PartialEq + KernelStorageElement,
{
    let dims = [input.len()];
    let strides = [1isize];
    let mut output = vec![T::default(); input.len()];

    let plan = ErasedCopyPlan::compile(dtype, &dims, &strides, &strides).unwrap();
    {
        let source = ErasedRawStridedRef::from_slice(input, &dims, &strides, 0).unwrap();
        let mut dest =
            ErasedRawStridedMut::from_slice_mut(&mut output, &dims, &strides, 0).unwrap();
        plan.execute(&ExecContext::serial(), &mut dest, &source)
            .unwrap();
    }

    assert_eq!(output, input);
}

#[test]
fn erased_copy_plan_executes_supported_scalar_set() {
    assert_supported_copy(KernelDType::F32, &[1.0f32, -2.0, 3.5]);
    assert_supported_copy(KernelDType::F64, &[1.0f64, -2.0, 3.5]);
    assert_supported_copy(KernelDType::I32, &[1i32, -2, 3]);
    assert_supported_copy(KernelDType::I64, &[1i64, -2, 3]);
    assert_supported_copy(KernelDType::Bool, &[true, false, true]);
    assert_supported_copy(
        KernelDType::C32,
        &[Complex32::new(1.0, -2.0), Complex32::new(3.5, 4.0)],
    );
    assert_supported_copy(
        KernelDType::C64,
        &[Complex64::new(1.0, -2.0), Complex64::new(3.5, 4.0)],
    );
}

#[test]
fn erased_raw_descriptors_reject_invalid_byte_layouts() {
    let dims = [1usize];
    let strides = [1isize];
    let mut aligned = [0u64; 2];
    let err = unsafe {
        ErasedRawStridedRef::from_raw_parts(
            KernelDType::F64,
            NonNull::new(aligned.as_mut_ptr().cast()).unwrap(),
            9,
            &dims,
            &strides,
            0,
        )
    }
    .unwrap_err();
    assert!(matches!(err, StridedError::ByteLengthMismatch { .. }));
}

#[test]
fn erased_copy_plan_accepts_explicit_execution_contexts() {
    let dims = [2usize];
    let strides = [1isize];
    let src = [3.0f64, 4.0];
    let mut serial_dst = [0.0f64; 2];
    let mut bounded_dst = [0.0f64; 2];
    let mut ambient_dst = [0.0f64; 2];

    let plan = ErasedCopyPlan::compile(KernelDType::F64, &dims, &strides, &strides).unwrap();
    let source = ErasedRawStridedRef::from_slice(&src, &dims, &strides, 0).unwrap();

    {
        let mut dest =
            ErasedRawStridedMut::from_slice_mut(&mut serial_dst, &dims, &strides, 0).unwrap();
        plan.execute(&ExecContext::serial(), &mut dest, &source)
            .unwrap();
    }
    {
        let mut dest =
            ErasedRawStridedMut::from_slice_mut(&mut bounded_dst, &dims, &strides, 0).unwrap();
        let ctx = ExecContext::max_threads(1).unwrap();
        plan.execute(&ctx, &mut dest, &source).unwrap();
    }
    {
        let mut dest =
            ErasedRawStridedMut::from_slice_mut(&mut ambient_dst, &dims, &strides, 0).unwrap();
        plan.execute(&ExecContext::ambient(), &mut dest, &source)
            .unwrap();
    }

    assert!(matches!(
        ExecContext::max_threads(0).unwrap_err(),
        StridedError::InvalidThreadBudget { max_threads: 0 }
    ));
    assert_eq!(serial_dst, src);
    assert_eq!(bounded_dst, src);
    assert_eq!(ambient_dst, src);
}