meos 0.3.0

Rust bindings for MEOS C API
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

use std::fmt::Debug;

pub trait Collection: PartialEq + Debug + Clone {
    type Type;
    // Topological Operations

    /// Returns whether `self` is contained in `container`.
    ///
    /// ## Arguments
    ///
    /// * `container` - The container to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if contained, `false` otherwise.
    fn is_contained_in(&self, container: &Self) -> bool;

    /// Determines if the collection contains the specified item.
    ///
    /// # Arguments
    ///
    /// * `content` - The item to check for containment within the collection.
    ///
    /// # Returns
    ///
    /// * `true` if the collection contains the specified item, `false` otherwise.
    fn contains(&self, content: &Self::Type) -> bool;

    /// Returns whether `self` overlaps `other`. That is, both share at least an element.
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if overlaps, `false` otherwise.
    fn overlaps(&self, other: &Self) -> bool;

    // Position Operations

    /// Returns whether `self` is strictly before `other`. That is, `self` ends before `other` starts.
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if before, `false` otherwise.
    fn is_left(&self, other: &Self) -> bool;

    /// Returns whether `self` is before `other` allowing overlap. That is, `self` ends before `other` ends (or at the same time).
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if before, `false` otherwise.
    fn is_over_or_left(&self, other: &Self) -> bool;

    /// Returns whether `self` is after `other` allowing overlap. That is, `self` starts after `other` starts (or at the same time).
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if overlapping or after, `false` otherwise.
    fn is_over_or_right(&self, other: &Self) -> bool;

    /// Returns whether `self` is strictly after `other`. That is, `self` starts after `other` ends.
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if after, `false` otherwise.
    fn is_right(&self, other: &Self) -> bool;

    /// Returns whether `self` is adjacent to `other`. That is, `self` starts just after `other` ends.
    ///
    /// ## Arguments
    ///
    /// * `other` - The object to compare with.
    ///
    /// ## Returns
    ///
    /// * `true` if adjacent, `false` otherwise.
    fn is_adjacent(&self, other: &Self) -> bool;
}

// Rust doesn't support yet generating multiple blanket implementations for the same type: see https://stackoverflow.com/questions/73782573/why-do-blanket-implementations-for-two-different-traits-conflict.
// therefore, to avoid implementing manually per each specific instance of span, set, etc. we use this macro to generate some methods automatically.
// We can therefore just generate all of the collection functions with the kind of container (span, set, ect.), and the kind of element (int, float, etc.)

// Parameters:
//  $type: The type of the container: spanset, span, set, etc.
//  $subtype: The type of what is contained: float, int, geo, etc.
macro_rules! impl_collection {
    ($type:ident, $subtype_type:ty) => {
        type Type = $subtype_type;
        paste::paste! {
            fn is_contained_in(&self, container: &Self) -> bool {
                unsafe { meos_sys::[<contained _ $type _ $type>](self.inner(), container.inner()) }
            }

            fn overlaps(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<overlaps _ $type _ $type>](self.inner(), other.inner()) }
            }

            fn is_left(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<left _ $type _ $type>](self.inner(), other.inner()) }
            }

            fn is_over_or_left(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<overleft _ $type _ $type>](self.inner(), other.inner()) }
            }

            fn is_over_or_right(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<overright _ $type _ $type>](self.inner(), other.inner()) }
            }

            fn is_right(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<right _ $type _ $type>](self.inner(), other.inner()) }
            }

            fn is_adjacent(&self, other: &Self) -> bool {
                unsafe { meos_sys::[<adjacent _ $type _ $type>](self.inner(), other.inner()) }
            }
        }
    };
}

pub(crate) use impl_collection;