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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
use super::Vec3A;
#[cfg(vec3a_f32)]
use super::Vec3Mask;
use core::{fmt, ops::*};

#[cfg(all(vec3a_sse2, target_arch = "x86"))]
use core::arch::x86::*;
#[cfg(all(vec3a_sse2, target_arch = "x86_64"))]
use core::arch::x86_64::*;
#[cfg(vec3a_sse2)]
use core::{cmp::Ordering, hash};

/// A 3-dimensional vector mask.
///
/// This type is typically created by comparison methods on `Vec3A`.  It is
/// essentially a vector of three boolean values.
#[cfg(vec3a_sse2)]
#[derive(Clone, Copy)]
#[repr(C)]
pub struct Vec3AMask(pub(crate) __m128);

/// A 3-dimensional vector mask.
#[cfg(vec3a_f32)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Ord, PartialOrd, Hash)]
#[repr(align(16), C)]
pub struct Vec3AMask(pub(crate) Vec3Mask);

#[cfg(vec3a_sse2)]
impl Default for Vec3AMask {
    #[inline]
    fn default() -> Self {
        unsafe { Self(_mm_setzero_ps()) }
    }
}

#[cfg(vec3a_sse2)]
impl PartialEq for Vec3AMask {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.as_ref().eq(other.as_ref())
    }
}

#[cfg(vec3a_sse2)]
impl Eq for Vec3AMask {}

#[cfg(vec3a_sse2)]
impl Ord for Vec3AMask {
    #[inline]
    fn cmp(&self, other: &Self) -> Ordering {
        self.as_ref().cmp(other.as_ref())
    }
}

#[cfg(vec3a_sse2)]
impl PartialOrd for Vec3AMask {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

#[cfg(vec3a_sse2)]
impl hash::Hash for Vec3AMask {
    #[inline]
    fn hash<H: hash::Hasher>(&self, state: &mut H) {
        self.as_ref().hash(state);
    }
}

impl Vec3AMask {
    /// Creates a new `Vec3AMask`.
    #[inline]
    pub fn new(x: bool, y: bool, z: bool) -> Self {
        // A SSE2 mask can be any bit pattern but for the `Vec3AMask` implementation of select we
        // expect either 0 or 0xff_ff_ff_ff. This should be a safe assumption as this type can only
        // be created via this function or by `Vec3A` methods.

        #[cfg(vec3a_sse2)]
        unsafe {
            const MASK: [u32; 2] = [0, 0xff_ff_ff_ff];
            Self(_mm_set_ps(
                f32::from_bits(MASK[z as usize]),
                f32::from_bits(MASK[z as usize]),
                f32::from_bits(MASK[y as usize]),
                f32::from_bits(MASK[x as usize]),
            ))
        }

        #[cfg(vec3a_f32)]
        {
            Self(Vec3Mask::new(x, y, z))
        }
    }

    /// Returns a bitmask with the lowest three bits set from the elements of
    /// the `Vec3AMask`.
    ///
    /// A true element results in a `1` bit and a false element in a `0` bit.
    /// Element `x` goes into the first lowest bit, element `y` into the
    /// second, etc.
    #[inline]
    pub fn bitmask(&self) -> u32 {
        // _mm_movemask_ps only checks the most significant bit of the u32 is
        // true, so we replicate that here with the non-SSE2 version.

        #[cfg(vec3a_sse2)]
        unsafe {
            (_mm_movemask_ps(self.0) as u32) & 0x7
        }

        #[cfg(vec3a_f32)]
        {
            self.0.bitmask()
        }
    }

    /// Returns true if any of the elements are true, false otherwise.
    ///
    /// In other words: `x || y || z`.
    #[inline]
    pub fn any(&self) -> bool {
        #[cfg(vec3a_sse2)]
        unsafe {
            (_mm_movemask_ps(self.0) & 0x7) != 0
        }

        #[cfg(vec3a_f32)]
        {
            self.0.any()
        }
    }

    /// Returns true if all the elements are true, false otherwise.
    ///
    /// In other words: `x && y && z`.
    #[inline]
    pub fn all(&self) -> bool {
        #[cfg(vec3a_sse2)]
        unsafe {
            (_mm_movemask_ps(self.0) & 0x7) == 0x7
        }

        #[cfg(vec3a_f32)]
        {
            self.0.all()
        }
    }

    /// Creates a new `Vec3A` from the elements in `if_true` and `if_false`,
    /// selecting which to use for each element based on the `Vec3AMask`.
    ///
    /// A true element in the mask uses the corresponding element from
    /// `if_true`, and false uses the element from `if_false`.
    #[inline]
    pub fn select(self, if_true: Vec3A, if_false: Vec3A) -> Vec3A {
        // We are assuming that the mask values are either 0 or 0xff_ff_ff_ff for the SSE2 and f32
        // to behave the same here.

        #[cfg(vec3a_sse2)]
        unsafe {
            Vec3A(_mm_or_ps(
                _mm_andnot_ps(self.0, if_false.0),
                _mm_and_ps(if_true.0, self.0),
            ))
        }

        #[cfg(vec3a_f32)]
        {
            Vec3A(self.0.select(if_true.0, if_false.0))
        }
    }
}

impl BitAnd for Vec3AMask {
    type Output = Self;
    #[inline]
    fn bitand(self, other: Self) -> Self {
        #[cfg(vec3a_sse2)]
        unsafe {
            Self(_mm_and_ps(self.0, other.0))
        }

        #[cfg(vec3a_f32)]
        {
            Self(self.0.bitand(other.0))
        }
    }
}

impl BitAndAssign for Vec3AMask {
    #[inline]
    fn bitand_assign(&mut self, other: Self) {
        #[cfg(vec3a_sse2)]
        {
            self.0 = unsafe { _mm_and_ps(self.0, other.0) };
        }

        #[cfg(vec3a_f32)]
        {
            self.0.bitand_assign(other.0);
        }
    }
}

impl BitOr for Vec3AMask {
    type Output = Self;
    #[inline]
    fn bitor(self, other: Self) -> Self {
        #[cfg(vec3a_sse2)]
        unsafe {
            Self(_mm_or_ps(self.0, other.0))
        }

        #[cfg(vec3a_f32)]
        {
            Self(self.0.bitor(other.0))
        }
    }
}

impl BitOrAssign for Vec3AMask {
    #[inline]
    fn bitor_assign(&mut self, other: Self) {
        #[cfg(vec3a_sse2)]
        {
            self.0 = unsafe { _mm_or_ps(self.0, other.0) };
        }

        #[cfg(vec3a_f32)]
        {
            self.0.bitor_assign(other.0);
        }
    }
}

impl Not for Vec3AMask {
    type Output = Self;
    #[inline]
    fn not(self) -> Self {
        #[cfg(vec3a_sse2)]
        unsafe {
            Self(_mm_andnot_ps(
                self.0,
                _mm_set_ps1(f32::from_bits(0xff_ff_ff_ff)),
            ))
        }

        #[cfg(vec3a_f32)]
        {
            Self(self.0.not())
        }
    }
}

impl fmt::Debug for Vec3AMask {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        #[cfg(vec3a_sse2)]
        {
            let arr = self.as_ref();
            write!(f, "Vec3AMask({:#x}, {:#x}, {:#x})", arr[0], arr[1], arr[2])
        }

        #[cfg(vec3a_f32)]
        {
            write!(
                f,
                "Vec3AMask({:#x}, {:#x}, {:#x})",
                (self.0).0,
                (self.0).1,
                (self.0).2
            )
        }
    }
}

impl fmt::Display for Vec3AMask {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let arr = self.as_ref();
        write!(f, "[{}, {}, {}]", arr[0] != 0, arr[1] != 0, arr[2] != 0,)
    }
}

impl From<Vec3AMask> for [u32; 3] {
    #[inline]
    fn from(mask: Vec3AMask) -> Self {
        *mask.as_ref()
    }
}

#[cfg(vec3a_sse2)]
impl From<Vec3AMask> for __m128 {
    #[inline]
    fn from(t: Vec3AMask) -> Self {
        t.0
    }
}

impl AsRef<[u32; 3]> for Vec3AMask {
    #[inline]
    fn as_ref(&self) -> &[u32; 3] {
        unsafe { &*(self as *const Self as *const [u32; 3]) }
    }
}