axgeom 1.13.2

Library that provides ability to extract 1d ranges out of 2d objects.
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
121
122
123
124

//! A library that provides a way to easily extract 1d ranges from a 2d container based off of the x or y axis statically through
//! type parameters. This can help with performance in algorithms where you need to get values for a particular axis often.
//!

#![no_std]

mod range;
mod ray;
mod rect;
mod vec2;

#[cfg(feature = "std")]
pub use roots;

pub use num_traits;
pub use partial_min_max;

pub use self::range::range;
pub use self::range::Range;
pub use self::ray::ray;
pub use self::ray::CastResult;
pub use self::ray::Ray;
pub use self::rect::rect;
pub use self::rect::Rect;
pub use self::vec2::arr2_as;
pub use self::vec2::vec2;
pub use self::vec2::vec2same;
pub use self::vec2::Vec2;

///The x axis implementation of the Axis
#[derive(Eq, PartialEq, Copy, Clone, Debug)]
pub struct XAXIS;
impl Axis for XAXIS {
    type Next = YAXIS;
    #[inline(always)]
    #[must_use]
    fn is_xaxis(&self) -> bool {
        true
    }
    #[inline(always)]
    #[must_use]
    fn next(&self) -> Self::Next {
        YAXIS
    }
}

///The y axis implementation of the Axis
#[derive(Eq, PartialEq, Copy, Clone, Debug)]
pub struct YAXIS;
impl Axis for YAXIS {
    type Next = XAXIS;

    #[inline(always)]
    #[must_use]
    fn is_xaxis(&self) -> bool {
        false
    }

    #[inline(always)]
    #[must_use]
    fn next(&self) -> Self::Next {
        XAXIS
    }
}

///A dynamic axis as opposed to a statically known one via `impl Axis`.
#[derive(Eq, PartialEq, Copy, Clone, Debug)]
#[must_use]
pub enum AxisDyn {
    X,
    Y,
}
impl AxisDyn {
    #[inline(always)]
    #[must_use]
    pub const fn is_equal_to(&self, other: AxisDyn) -> bool {
        use AxisDyn::*;
        matches!((self, other), (X, X) | (Y, Y))
    }

    #[inline(always)]
    #[must_use]
    pub const fn is_xaxis(self) -> bool {
        match self {
            AxisDyn::X => true,
            AxisDyn::Y => false,
        }
    }

    #[inline(always)]
    pub const fn next(&self) -> Self {
        use AxisDyn::*;
        match self {
            X => Y,
            Y => X,
        }
    }
}

///Axis trait can be used to extract the x or y portions of a container.
///when you know the axis as compile time.
///The X implementation of this trait's Next associated trait is the Y implementation.
///The Y implementation of this trait's Next associated trait is the X implementation.
pub trait Axis: Sync + Send + Copy + Clone {
    type Next: Axis;
    fn is_xaxis(&self) -> bool;
    fn next(&self) -> Self::Next;

    ///Convert a statically known axis into a dynamic one.
    #[inline(always)]
    fn to_dyn(&self) -> AxisDyn {
        if self.is_xaxis() {
            AxisDyn::X
        } else {
            AxisDyn::Y
        }
    }

    #[inline(always)]
    #[must_use]
    fn is_equal_to<B: Axis>(&self, other: B) -> bool {
        self.to_dyn().is_equal_to(other.to_dyn())
    }
}