cell-map 0.5.3

Many-layered 2D cellular generic map
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
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
165
166
167
168

//! Tests for iterators

// ------------------------------------------------------------------------------------------------
// IMPORTS
// ------------------------------------------------------------------------------------------------

use super::*;
use crate::{cell_map::Bounds, test_utils::TestLayers, CellMapParams};

/// Check that iterator constructors return the right ok or error.
#[test]
fn construction() {
    // Dummy map
    let mut map = CellMap::<TestLayers, f64>::new_from_elem(
        CellMapParams {
            cell_size: Vector2::new(1.0, 1.0),
            cell_bounds: Bounds::new((0, 5), (0, 5)).unwrap(),
            ..Default::default()
        },
        1.0,
    );

    // Try to build new iterators, checking we don't panic
    let _ = map.iter();
    let _ = map.iter_mut();
    assert!(map.window_iter(Vector2::new(2, 2)).is_ok());
    assert!(map.window_iter_mut(Vector2::new(2, 2)).is_ok());

    // Check that window builds return errors when we use a big window
    assert!(map.window_iter(Vector2::new(3, 3)).is_err());
    assert!(map.window_iter_mut(Vector2::new(3, 3)).is_err());
}

#[test]
fn counts() -> Result<(), Error> {
    // Dummy map
    let mut map = CellMap::<TestLayers, f64>::new_from_elem(
        CellMapParams {
            cell_size: Vector2::new(1.0, 1.0),
            cell_bounds: Bounds::new((0, 5), (0, 5)).unwrap(),
            ..Default::default()
        },
        1.0,
    );

    assert_eq!(map.iter().count(), 75);
    assert_eq!(map.iter().layer(TestLayers::Layer0).count(), 25);
    assert_eq!(
        map.iter()
            .layers(&[TestLayers::Layer0, TestLayers::Layer2])
            .count(),
        50
    );
    assert_eq!(map.iter_mut().count(), 75);
    assert_eq!(map.iter_mut().layer(TestLayers::Layer0).count(), 25);
    assert_eq!(
        map.iter_mut()
            .layers(&[TestLayers::Layer0, TestLayers::Layer2])
            .count(),
        50
    );

    assert_eq!(map.window_iter(Vector2::new(1, 1))?.count(), 27);
    assert_eq!(map.window_iter_mut(Vector2::new(1, 1))?.count(), 27);

    assert_eq!(map.window_iter(Vector2::new(2, 2))?.count(), 3);
    assert_eq!(map.window_iter(Vector2::new(2, 2))?.count(), 3);

    Ok(())
}

#[test]
fn window() -> Result<(), Error> {
    // Dummy map
    let map = CellMap::<TestLayers, f64>::new_from_elem(
        CellMapParams {
            cell_size: Vector2::new(1.0, 1.0),
            cell_bounds: Bounds::new((0, 5), (0, 6)).unwrap(),
            ..Default::default()
        },
        1.0,
    );

    // Check shape is correct
    let first = map
        .window_iter(Vector2::new(1, 1))?
        .layer(TestLayers::Layer0)
        .next();

    assert_eq!(first.unwrap().shape(), &[3, 3]);

    // Check the order of cells produced is correct
    let indices: Vec<(usize, usize)> = map
        .window_iter(Vector2::new(1, 1))?
        .layer(TestLayers::Layer0)
        .indexed()
        .map(|((_, idx), _)| (idx.x, idx.y))
        .collect();

    assert_eq!(
        indices,
        vec![
            (1, 1),
            (2, 1),
            (3, 1),
            // (4, 1),
            (1, 2),
            (2, 2),
            (3, 2),
            // (4, 2),
            (1, 3),
            (2, 3),
            (3, 3),
            // (4, 3),
            (1, 4),
            (2, 4),
            (3, 4),
            // (4, 4),
        ]
    );

    Ok(())
}

#[test]
fn line() -> Result<(), Error> {
    // Dummy map
    let map = CellMap::<TestLayers, f64>::new_from_elem(
        CellMapParams {
            cell_size: Vector2::new(1.0, 1.0),
            cell_bounds: Bounds::new((0, 6), (0, 6)).unwrap(),
            ..Default::default()
        },
        1.0,
    );

    // Create new line iterator between two points which should be a straight line
    let indexes: Vec<(usize, usize)> = map
        .line_iter(Point2::new(1.1, 1.1), Point2::new(3.3, 1.1))?
        .layer(TestLayers::Layer0)
        .indexed()
        .map(|((_, i), _)| (i.x, i.y))
        .collect();

    assert_eq!(indexes, vec![(1, 1), (2, 1), (3, 1)]);

    // Create a off diaganal iterator, should produce more points
    let indexes: Vec<(usize, usize)> = map
        .line_iter(Point2::new(1.1, 1.1), Point2::new(4.3, 2.1))?
        .layer(TestLayers::Layer0)
        .indexed()
        .map(|((_, i), _)| (i.x, i.y))
        .collect();

    assert_eq!(indexes, vec![(1, 1), (2, 1), (3, 1), (3, 2), (4, 2)]);

    // Create negative direction vector
    let indexes: Vec<(usize, usize)> = map
        .line_iter(Point2::new(4.3, 2.1), Point2::new(1.1, 1.1))?
        .layer(TestLayers::Layer0)
        .indexed()
        .map(|((_, i), _)| (i.x, i.y))
        .collect();

    assert_eq!(indexes, vec![(4, 2), (3, 2), (3, 1), (2, 1), (1, 1)]);

    Ok(())
}