jagua-rs 0.6.2

A fast and fearless Collision Detection Engine for 2D irregular Cutting and Packing problems
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

use crate::collision_detection::hazards::HazKey;
use crate::collision_detection::hazards::filter::HazardFilter;
use crate::collision_detection::quadtree::QTHazPresence;
use crate::collision_detection::quadtree::QTHazard;
use std::cmp::Ordering;
use std::ops::Not;

/// Vector of `QTHazard`s, which always remains sorted by presence.
/// <br>
/// This is a performance optimization to be able to quickly return the "strongest" hazard
/// Strongest meaning the highest [`QTHazPresence`] (`Entire` > `Partial` > `None`)
#[derive(Clone, Debug, Default)]
pub struct QTHazardVec {
    hazards: Vec<QTHazard>,
    /// Number of edges from active hazards in the vector
    n_active_edges: usize,
}

impl QTHazardVec {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add(&mut self, haz: QTHazard) {
        debug_assert!(!matches!(haz.presence, QTHazPresence::None));
        debug_assert!(
            self.hazards
                .iter()
                .filter(|other| other.entity == haz.entity || other.hkey == haz.hkey)
                .count()
                == 0,
            "More than one hazard from same entity or key in the vector! (This should never happen!)"
        );
        match self
            .hazards
            .binary_search_by(|probe| order_by_descending_strength(probe, &haz))
        {
            Ok(pos) | Err(pos) => {
                self.n_active_edges += haz.n_edges();
                self.hazards.insert(pos, haz);
            }
        }
    }

    pub fn remove(&mut self, hkey: HazKey) -> Option<QTHazard> {
        let pos = self.hazards.iter().position(|ch| ch.hkey == hkey);
        match pos {
            Some(pos) => {
                let haz = self.hazards.remove(pos);
                self.n_active_edges -= haz.n_edges();
                Some(haz)
            }
            None => None,
        }
    }

    #[inline(always)]
    /// Returns the strongest hazard (if any) (`Entire` > `Partial` > `None`)
    /// Ignores any hazards that are deemed irrelevant by the filter.
    pub fn strongest(&self, filter: &impl HazardFilter) -> Option<&QTHazard> {
        debug_assert!(assert_caches_correct(self));
        self.iter().find(|hz| !filter.is_irrelevant(hz.hkey))
    }

    pub fn is_empty(&self) -> bool {
        self.hazards.is_empty()
    }

    pub fn len(&self) -> usize {
        self.hazards.len()
    }
    pub fn no_partial_hazards(&self) -> bool {
        self.hazards
            .iter()
            .any(|hz| matches!(hz.presence, QTHazPresence::Partial(_)))
            .not()
    }

    pub fn iter(&self) -> impl Iterator<Item = &QTHazard> {
        self.hazards.iter()
    }

    pub fn n_active_edges(&self) -> usize {
        debug_assert!(assert_caches_correct(self));
        self.n_active_edges
    }
}

fn order_by_descending_strength(qth1: &QTHazard, qth2: &QTHazard) -> Ordering {
    let qth_presence_sortkey = |qth: &QTHazard| match qth.presence {
        QTHazPresence::None => 0,
        QTHazPresence::Partial(_) => 1,
        QTHazPresence::Entire => 2,
    };

    //sort by presence (Entire > Partial > None)
    qth_presence_sortkey(qth1)
        .cmp(&qth_presence_sortkey(qth2))
        .reverse()
}

fn assert_caches_correct(qthazard_vec: &QTHazardVec) -> bool {
    assert!(
        qthazard_vec
            .hazards
            .windows(2)
            .all(|w| order_by_descending_strength(&w[0], &w[1]) != Ordering::Greater),
        "Hazards are not sorted correctly!"
    );
    assert_eq!(
        qthazard_vec
            .hazards
            .iter()
            .map(|hz| hz.n_edges())
            .sum::<usize>(),
        qthazard_vec.n_active_edges,
        "Active edges count is not correct!"
    );
    true
}