parry2d 0.30.0

2 dimensional collision detection library in Rust.
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

/*!
parry
========

**parry** is a 2 and 3-dimensional geometric library written with
the rust programming language.

*/

#![deny(non_camel_case_types)]
#![deny(unused_parens)]
#![deny(non_upper_case_globals)]
#![deny(unused_results)]
#![deny(unused_qualifications)]
#![warn(missing_docs)]
#![warn(unused_imports)]
#![allow(missing_copy_implementations)]
#![allow(clippy::too_many_arguments)] // Maybe revisit this one later.
#![allow(clippy::module_inception)]
#![allow(clippy::manual_range_contains)] // This usually makes it way more verbose that it could be.
#![allow(clippy::type_complexity)] // Complains about closures that are fairly simple.
#![cfg_attr(feature = "dim2", doc(html_root_url = "https://docs.rs/parry2d"))]
#![cfg_attr(feature = "dim3", doc(html_root_url = "https://docs.rs/parry3d"))]
#![no_std]

#[cfg(all(feature = "simd8", feature = "enhanced-determinism"))]
core::compile_error!(
    "8-lanes SIMD cannot be enabled when the `enhanced-determinism` feature is also enabled because it breaks cross-platform determinism."
);

#[allow(unused_macros)]
macro_rules! array(
    ($callback: expr; SIMD_WIDTH) => {
        {
            #[inline(always)]
            #[allow(dead_code)]
            fn create_arr<T>(callback: impl FnMut(usize) -> T) -> [T; SIMD_WIDTH] {
                // Width-agnostic: `N` is inferred from the `[T; SIMD_WIDTH]` return type,
                // so this covers the 1-, 4-, and 8-lane builds alike.
                core::array::from_fn(callback)
            }

            create_arr($callback)
        }
    }
);

#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "alloc")]
#[cfg_attr(test, macro_use)]
extern crate alloc;

#[cfg(feature = "serde")]
#[macro_use]
extern crate serde;
#[macro_use]
extern crate approx;
extern crate num_traits as num;

pub extern crate either;
pub extern crate glamx;
pub extern crate simba;

#[macro_use]
mod macros;

pub mod bounding_volume;
pub mod mass_properties;
pub mod math;
pub mod partitioning;
pub mod query;
pub mod shape;
#[cfg(feature = "alloc")]
pub mod transformation;
pub mod utils;

mod simd {
    // The `wide` types fall back to scalar code on targets without SIMD, so
    // they are always used, whatever the platform.

    // 8-lane SIMD (f32 only; simba has no `WideF64x8`). Opt-in via `simd8`.
    // Requires an AVX-enabled target (`RUSTFLAGS="-C target-feature=+avx2,+fma"`
    // or `-C target-cpu=native`) for the compiler to actually emit 256-bit
    // instructions; otherwise it runs (correctly) as two 128-bit halves.
    #[cfg(all(feature = "simd8", feature = "f32"))]
    pub use simba::simd::{WideBoolF32x8 as SimdBool, WideF32x8 as SimdReal};

    // 4-lane SIMD (default width).
    #[cfg(all(not(feature = "simd8"), feature = "f32"))]
    pub use simba::simd::{WideBoolF32x4 as SimdBool, WideF32x4 as SimdReal};

    // f64 stays 4-lane regardless of `simd8` (no 8-lane f64 type in simba).
    #[cfg(feature = "f64")]
    pub use simba::simd::{WideBoolF64x4 as SimdBool, WideF64x4 as SimdReal};

    /// The number of lanes of a SIMD number.
    #[cfg(all(feature = "simd8", feature = "f32"))]
    pub const SIMD_WIDTH: usize = 8;
    /// SIMD_WIDTH - 1
    #[cfg(all(feature = "simd8", feature = "f32"))]
    pub const SIMD_LAST_INDEX: usize = 7;

    /// The number of lanes of a SIMD number.
    #[cfg(not(all(feature = "simd8", feature = "f32")))]
    pub const SIMD_WIDTH: usize = 4;
    /// SIMD_WIDTH - 1
    #[cfg(not(all(feature = "simd8", feature = "f32")))]
    pub const SIMD_LAST_INDEX: usize = 3;
}