      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

    //! Minimal boolean vector implementation

    /// Minimal interface: all packed SIMD boolean vector types implement this.
    macro_rules! impl_bool_minimal {
        ($id:ident, $elem_ty:ident, $elem_count:expr, $($elem_name:ident),+) => {

            #[cfg_attr(feature = "cargo-clippy", allow(expl_impl_clone_on_copy))]
            impl Clone for $id {
                #[inline] // currently needed for correctness
                fn clone(&self) -> Self {
                    *self
                }
            }

            impl $id {
                /// Creates a new instance with each vector elements initialized
                /// with the provided values.
                #[inline]
                pub const fn new($($elem_name: bool),*) -> Self {
                    $id($(Self::bool_to_internal($elem_name)),*)
                }

                /// Converts a boolean type into the type of the vector lanes.
                #[inline]
                const fn bool_to_internal(x: bool) -> $elem_ty {
                    [0 as $elem_ty, !(0 as $elem_ty)][x as usize]
                }

                /// Returns the number of vector lanes.
                #[inline]
                pub const fn lanes() -> usize {
                    $elem_count
                }

                /// Constructs a new instance with each element initialized to
                /// `value`.
                #[inline]
                pub const fn splat(value: bool) -> Self {
                    $id($({
                        #[allow(non_camel_case_types, dead_code)]
                        struct $elem_name;
                        Self::bool_to_internal(value)
                    }),*)
                }

                /// Extracts the value at `index`.
                ///
                /// # Panics
                ///
                /// If `index >= Self::lanes()`.
                #[inline]
                pub fn extract(self, index: usize) -> bool {
                    assert!(index < $elem_count);
                    unsafe { self.extract_unchecked(index) }
                }

                /// Extracts the value at `index`.
                ///
                /// If `index >= Self::lanes()` the behavior is undefined.
                #[inline]
                pub unsafe fn extract_unchecked(self, index: usize) -> bool {
                    let x: $elem_ty = simd_extract(self, index as u32);
                    x != 0
                }

                /// Returns a new vector where the value at `index` is replaced by `new_value`.
                ///
                /// # Panics
                ///
                /// If `index >= Self::lanes()`.
                #[inline]
                #[must_use = "replace does not modify the original value - it returns a new vector with the value at `index` replaced by `new_value`d"]
                pub fn replace(self, index: usize, new_value: bool) -> Self {
                    assert!(index < $elem_count);
                    unsafe { self.replace_unchecked(index, new_value) }
                }

                /// Returns a new vector where the value at `index` is replaced by `new_value`.
                ///
                /// # Panics
                ///
                /// If `index >= Self::lanes()`.
                #[inline]
                #[must_use = "replace_unchecked does not modify the original value - it returns a new vector with the value at `index` replaced by `new_value`d"]
                pub unsafe fn replace_unchecked(
                    self,
                    index: usize,
                    new_value: bool,
                ) -> Self {
                    simd_insert(self, index as u32, Self::bool_to_internal(new_value))
                }
            }
        }
    }

    #[cfg(test)]
    macro_rules! test_bool_minimal {
        ($id:ident, $elem_count:expr) => {
            #[test]
            fn minimal() {
                use ::coresimd::simd::$id;
                // TODO: test new

                // lanes:
                assert_eq!($elem_count, $id::lanes());

                // splat and extract / extract_unchecked:
                let vec = $id::splat(true);
                for i in 0..$id::lanes() {
                    assert_eq!(true, vec.extract(i));
                    assert_eq!(true, unsafe { vec.extract_unchecked(i) });
                }

                // replace / replace_unchecked
                let new_vec = vec.replace(1, false);
                for i in 0..$id::lanes() {
                    if i == 1 {
                        assert_eq!(false, new_vec.extract(i));
                    } else {
                        assert_eq!(true, new_vec.extract(i));
                    }
                }
                let new_vec = unsafe { vec.replace_unchecked(1, false) };
                for i in 0..$id::lanes() {
                    if i == 1 {
                        assert_eq!(false, new_vec.extract(i));
                    } else {
                        assert_eq!(true, new_vec.extract(i));
                    }
                }
            }
            #[test]
            #[should_panic]
            fn minimal_extract_panic_on_out_of_bounds() {
                use ::coresimd::simd::$id;
                let vec = $id::splat(false);
                let _ = vec.extract($id::lanes());
            }
            #[test]
            #[should_panic]
            fn minimal_replace_panic_on_out_of_bounds() {
                use ::coresimd::simd::$id;
                let vec = $id::splat(false);
                let _ = vec.replace($id::lanes(), true);
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)