khal-std 0.2.0

GPU standard library for khal compute shaders, with cross-platform primitives compiling to SPIR-V, CUDA PTX, and CPU targets.
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

/// Indexing trait that optionally removes bounds checks on GPU targets.
///
/// When the `unsafe_remove_boundchecks` feature is enabled, methods use
/// unchecked indexing for performance on SPIR-V and CUDA targets.
/// Otherwise, standard bounds-checked indexing is used.
pub trait MaybeIndexUnchecked<T> {
    /// Returns a reference to the element at `id`.
    fn at(&self, id: usize) -> &T;
    /// Returns a mutable reference to the element at `id`.
    fn at_mut(&mut self, id: usize) -> &mut T;
    /// Copies and returns the element at `id`.
    fn read(&self, id: usize) -> T;
    /// Writes `data` to the element at `id`.
    fn write(&mut self, id: usize, data: T);
}

impl<T: Copy> MaybeIndexUnchecked<T> for [T] {
    #[inline(always)]
    fn at(&self, id: usize) -> &T {
        #[cfg(all(feature = "unsafe_remove_boundchecks", target_arch = "nvptx64"))]
        return unsafe { self.get_unchecked(id) };
        #[cfg(all(feature = "unsafe_remove_boundchecks", not(target_arch = "nvptx64")))]
        return unsafe {
            use spirv_std::arch::IndexUnchecked;
            self.index_unchecked(id)
        };
        #[cfg(not(feature = "unsafe_remove_boundchecks"))]
        return &self[id];
    }

    #[inline(always)]
    fn at_mut(&mut self, id: usize) -> &mut T {
        #[cfg(all(feature = "unsafe_remove_boundchecks", target_arch = "nvptx64"))]
        return unsafe { self.get_unchecked_mut(id) };
        #[cfg(all(feature = "unsafe_remove_boundchecks", not(target_arch = "nvptx64")))]
        return unsafe {
            use spirv_std::arch::IndexUnchecked;
            self.index_unchecked_mut(id)
        };
        #[cfg(not(feature = "unsafe_remove_boundchecks"))]
        return &mut self[id];
    }

    #[inline(always)]
    fn read(&self, id: usize) -> T {
        *self.at(id)
    }

    #[inline(always)]
    fn write(&mut self, id: usize, data: T) {
        *self.at_mut(id) = data;
    }
}

impl<T: Copy, const N: usize> MaybeIndexUnchecked<T> for [T; N] {
    #[inline(always)]
    fn at(&self, id: usize) -> &T {
        #[cfg(all(feature = "unsafe_remove_boundchecks", target_arch = "nvptx64"))]
        return unsafe { self.get_unchecked(id) };
        #[cfg(all(feature = "unsafe_remove_boundchecks", not(target_arch = "nvptx64")))]
        return unsafe {
            use spirv_std::arch::IndexUnchecked;
            self.index_unchecked(id)
        };
        #[cfg(not(feature = "unsafe_remove_boundchecks"))]
        return &self[id];
    }

    #[inline(always)]
    fn at_mut(&mut self, id: usize) -> &mut T {
        #[cfg(all(feature = "unsafe_remove_boundchecks", target_arch = "nvptx64"))]
        return unsafe { self.get_unchecked_mut(id) };
        #[cfg(all(feature = "unsafe_remove_boundchecks", not(target_arch = "nvptx64")))]
        return unsafe {
            use spirv_std::arch::IndexUnchecked;
            self.index_unchecked_mut(id)
        };
        #[cfg(not(feature = "unsafe_remove_boundchecks"))]
        return &mut self[id];
    }

    #[inline(always)]
    fn read(&self, id: usize) -> T {
        *self.at(id)
    }

    #[inline(always)]
    fn write(&mut self, id: usize, data: T) {
        *self.at_mut(id) = data;
    }
}