mod.rs.html -- source
Description: Source to the Rust file `libcore/../stdsimd/coresimd/mod.rs`.
Keywords: rust, rustlang, rust-lang

      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

    //! `coresimd`

    #[macro_use]
    mod macros;

    mod simd;

    /// Platform dependent vendor intrinsics.
    ///
    /// This documentation is for the version of this module in the `coresimd`
    /// crate, but you probably want to use the [`stdsimd` crate][stdsimd] which
    /// should have more complete documentation.
    ///
    /// [stdsimd]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/arch/index.html
    ///
    /// Also note that while this module may appear to contains the intrinsics for
    /// only one platform it actually contains intrinsics for multiple platforms
    /// compiled in conditionally. For other platforms of stdsimd see:
    ///
    /// * [`x86`]
    /// * [`x86_64`]
    /// * [`arm`]
    /// * [`aarch64`]
    /// * [`mips`]
    /// * [`mips64`]
    /// * [`PowerPC`]
    /// * [`PowerPC64`]
    ///
    /// [`x86`]: https://rust-lang-nursery.github.io/stdsimd/x86/stdsimd/arch/index.html
    /// [`x86_64`]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/arch/index.html
    /// [`arm`]: https://rust-lang-nursery.github.io/stdsimd/arm/stdsimd/arch/index.html
    /// [`aarch64`]: https://rust-lang-nursery.github.io/stdsimd/aarch64/stdsimd/arch/index.html
    /// [`mips`]: https://rust-lang-nursery.github.io/stdsimd/mips/stdsimd/arch/index.html
    /// [`mips64`]: https://rust-lang-nursery.github.io/stdsimd/mips64/stdsimd/arch/index.html
    /// [`PowerPC`]: https://rust-lang-nursery.github.io/stdsimd/powerpc/stdsimd/arch/index.html
    /// [`PowerPC64`]: https://rust-lang-nursery.github.io/stdsimd/powerpc64/stdsimd/arch/index.html
    #[stable(feature = "simd_arch", since = "1.27.0")]
    pub mod arch {
        /// Platform-specific intrinsics for the `x86` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "x86", dox))]
        #[doc(cfg(target_arch = "x86"))]
        #[stable(feature = "simd_x86", since = "1.27.0")]
        pub mod x86 {
            #[stable(feature = "simd_x86", since = "1.27.0")]
            pub use coresimd::x86::*;
        }

        /// Platform-specific intrinsics for the `x86_64` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "x86_64", dox))]
        #[doc(cfg(target_arch = "x86_64"))]
        #[stable(feature = "simd_x86", since = "1.27.0")]
        pub mod x86_64 {
            #[stable(feature = "simd_x86", since = "1.27.0")]
            pub use coresimd::x86::*;
            #[stable(feature = "simd_x86", since = "1.27.0")]
            pub use coresimd::x86_64::*;
        }

        /// Platform-specific intrinsics for the `arm` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "arm", dox))]
        #[doc(cfg(target_arch = "arm"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod arm {
            pub use coresimd::arm::*;
        }

        /// Platform-specific intrinsics for the `aarch64` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "aarch64", dox))]
        #[doc(cfg(target_arch = "aarch64"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod aarch64 {
            pub use coresimd::aarch64::*;
            pub use coresimd::arm::*;
        }

        /// Platform-specific intrinsics for the `wasm32` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(target_arch = "wasm32")]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod wasm32 {
            pub use coresimd::wasm32::*;
        }

        /// Platform-specific intrinsics for the `mips` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "mips", dox))]
        #[doc(cfg(target_arch = "mips"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod mips {
            pub use coresimd::mips::*;
        }

        /// Platform-specific intrinsics for the `mips64` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "mips64", dox))]
        #[doc(cfg(target_arch = "mips64"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod mips64 {
            pub use coresimd::mips::*;
        }

        /// Platform-specific intrinsics for the `PowerPC` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "powerpc", dox))]
        #[doc(cfg(target_arch = "powerpc"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod powerpc {
            pub use coresimd::powerpc::*;
        }

        /// Platform-specific intrinsics for the `PowerPC64` platform.
        ///
        /// See the [module documentation](../index.html) for more details.
        #[cfg(any(target_arch = "powerpc64", dox))]
        #[doc(cfg(target_arch = "powerpc64"))]
        #[unstable(feature = "stdsimd", issue = "27731")]
        pub mod powerpc64 {
            pub use coresimd::powerpc64::*;
        }
    }

    mod simd_llvm;

    #[cfg(any(target_arch = "x86", target_arch = "x86_64", dox))]
    #[doc(cfg(any(target_arch = "x86", target_arch = "x86_64")))]
    mod x86;
    #[cfg(any(target_arch = "x86_64", dox))]
    #[doc(cfg(target_arch = "x86_64"))]
    mod x86_64;

    #[cfg(any(target_arch = "aarch64", dox))]
    #[doc(cfg(target_arch = "aarch64"))]
    mod aarch64;
    #[cfg(any(target_arch = "arm", target_arch = "aarch64", dox))]
    #[doc(cfg(any(target_arch = "arm", target_arch = "aarch64")))]
    mod arm;
    #[cfg(target_arch = "wasm32")]
    mod wasm32;

    #[cfg(any(target_arch = "mips", target_arch = "mips64", dox))]
    #[doc(cfg(any(target_arch = "mips", target_arch = "mips64")))]
    mod mips;

    #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64", dox))]
    #[doc(cfg(any(target_arch = "powerpc", target_arch = "powerpc64")))]
    mod powerpc;

    #[cfg(any(target_arch = "powerpc64", dox))]
    #[doc(cfg(target_arch = "powerpc64"))]
    mod powerpc64;

    mod nvptx;

# 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)