generic-simd 0.1.0

safe and idiomatic zero-cost abstractions for writing explicit cross-platform SIMD operations
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

//! Extensions for pointers to vectors.

use crate::{
    scalar::Scalar,
    vector::{width, Native, NativeWidth, Vector},
};

/// A pointer to a vector.
pub trait Pointer<Token, Width>: Copy
where
    Token: crate::arch::Token,
    Width: width::Width,
{
    type Vector: Vector<Token = Token, Width = Width>;

    /// Read a vector from a pointer.
    ///
    /// # Safety
    /// See [`read_ptr`](../vector/trait.Vector.html#method.read_ptr).
    unsafe fn vector_read(self, token: Token) -> Self::Vector;

    /// Read a vector from a vector-aligned pointer.
    ///
    /// # Safety
    /// See [`read_aligned_ptr`](../vector/trait.Vector.html#method.read_aligned_ptr).
    unsafe fn vector_read_aligned(self, token: Token) -> Self::Vector;
}

impl<T, Token, Width> Pointer<Token, Width> for *const T
where
    T: Scalar<Token, Width>,
    Token: crate::arch::Token,
    Width: width::Width,
{
    type Vector = T::Vector;

    #[inline]
    unsafe fn vector_read(self, token: Token) -> Self::Vector {
        Self::Vector::read_ptr(token, self)
    }

    #[inline]
    unsafe fn vector_read_aligned(self, token: Token) -> Self::Vector {
        Self::Vector::read_aligned_ptr(token, self)
    }
}

impl<T, Token, Width> Pointer<Token, Width> for *mut T
where
    T: Scalar<Token, Width>,
    Token: crate::arch::Token,
    Width: width::Width,
{
    type Vector = T::Vector;

    #[inline]
    unsafe fn vector_read(self, token: Token) -> Self::Vector {
        Self::Vector::read_ptr(token, self)
    }

    #[inline]
    unsafe fn vector_read_aligned(self, token: Token) -> Self::Vector {
        Self::Vector::read_aligned_ptr(token, self)
    }
}

macro_rules! pointer_impl {
    {
        $width:literal,
        $width_type:ty,
        $read_unaligned:ident,
        $read_aligned:ident
    } => {
        #[doc = "Read a vector with "]
        #[doc = $width]
        #[doc = " from a pointer.\n\n# Safety\nSee [`read_ptr`](../vector/trait.Vector.html#method.read_ptr)."]
        #[inline]
        unsafe fn $read_unaligned(self, token: Token) -> <Self as Pointer<Token, $width_type>>::Vector {
            <Self as Pointer<Token, $width_type>>::vector_read(self, token)
        }

        #[doc = "Read a vector with "]
        #[doc = $width]
        #[doc = " from a vector-aligned pointer.\n\n# Safety\nSee [`read_aligned_ptr`](../vector/trait.Vector.html#method.read_aligned_ptr)."]
        #[inline]
        unsafe fn $read_aligned(self, token: Token) -> <Self as Pointer<Token, $width_type>>::Vector {
            <Self as Pointer<Token, $width_type>>::vector_read_aligned(self, token)
        }
    }
}

/// A pointer to a vector, supporting all vector widths.
pub trait PointerExt<Token>:
    Native<Token>
    + Pointer<Token, width::W1>
    + Pointer<Token, width::W2>
    + Pointer<Token, width::W4>
    + Pointer<Token, width::W8>
    + Pointer<Token, NativeWidth<Self, Token>>
where
    Token: crate::arch::Token,
{
    pointer_impl! { "the native number of lanes", <Self as Native<Token>>::Width, vector_read_native, vector_read_aligned_native }
    pointer_impl! { "1 lane",  width::W1, vector_read1, vector_read1_aligned }
    pointer_impl! { "2 lanes", width::W2, vector_read2, vector_read2_aligned }
    pointer_impl! { "4 lanes", width::W4, vector_read4, vector_read4_aligned }
    pointer_impl! { "8 lanes", width::W8, vector_read8, vector_read8_aligned }
}

impl<T, Token> PointerExt<Token> for T
where
    T: Native<Token>
        + Pointer<Token, width::W1>
        + Pointer<Token, width::W2>
        + Pointer<Token, width::W4>
        + Pointer<Token, width::W8>
        + Pointer<Token, NativeWidth<Self, Token>>,
    Token: crate::arch::Token,
{
}