gdsr 0.0.1-alpha.3

A GDSII reader and writer for 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
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
use crate::config::gds_file_types::{GDSDataType, GDSRecord, combine_record_and_data_type};
use crate::error::GdsError;
use crate::traits::ToGds;
use crate::utils::io::{
    MAX_POINTS, MIN_POLYGON_POINTS, validate_data_type, validate_layer, write_element_tail_to_file,
    write_points_to_file, write_u16_array_to_file,
};
use crate::{DataType, Dimensions, Layer, LayerMapping, Movable, Point, Transformable, Unit};

fn are_points_closed(points: &[Point]) -> bool {
    let points_vec: Vec<Point> = points.to_vec();
    if points_vec.is_empty() {
        return true;
    }
    points_vec.first() == points_vec.last()
}

pub(crate) fn close_points(points: impl IntoIterator<Item = Point>) -> Vec<Point> {
    let mut points_vec = points.into_iter().collect::<Vec<_>>();
    if !are_points_closed(&points_vec) {
        if let Some(first) = points_vec.first().copied() {
            points_vec.push(first);
        }
    }
    points_vec
}

pub fn get_correct_polygon_points_format(points: impl IntoIterator<Item = Point>) -> Vec<Point> {
    close_points(points)
}

/// A closed polygon defined by a sequence of points on a specific layer.
#[derive(Clone, Debug, PartialEq, Default)]
pub struct Polygon {
    pub(crate) points: Vec<Point>,
    pub(crate) layer: Layer,
    pub(crate) data_type: DataType,
}

impl Polygon {
    /// Creates a new polygon from the given points, layer, and data type.
    /// The polygon is automatically closed if needed.
    pub fn new(points: impl IntoIterator<Item = Point>, layer: Layer, data_type: DataType) -> Self {
        Self {
            points: get_correct_polygon_points_format(points),
            layer,
            data_type,
        }
    }

    /// Returns the polygon's points (including the closing point).
    pub fn points(&self) -> &[Point] {
        &self.points
    }

    /// Returns the layer number.
    pub const fn layer(&self) -> Layer {
        self.layer
    }

    /// Returns the data type.
    pub const fn data_type(&self) -> DataType {
        self.data_type
    }

    /// Remaps the layer and data type using the given mapping.
    /// If the current (layer, `data_type`) pair is found in the mapping, it is replaced.
    pub fn remap_layers(&mut self, mapping: &LayerMapping) {
        if let Some(&(new_layer, new_data_type)) = mapping.get(&(self.layer, self.data_type)) {
            self.layer = new_layer;
            self.data_type = new_data_type;
        }
    }

    /// Computes the area of the polygon using the shoelace formula.
    pub fn area(&self) -> Unit {
        crate::geometry::area(&self.points)
    }

    /// Computes the perimeter of the polygon.
    pub fn perimeter(&self) -> Unit {
        crate::geometry::perimeter(&self.points)
    }

    /// Check if a point is inside the polygon
    pub fn is_point_inside(&self, point: &Point) -> bool {
        crate::geometry::is_point_inside(point, &self.points)
    }

    /// Converts all points to integer units.
    #[must_use]
    pub fn to_integer_unit(self) -> Self {
        Self {
            points: self.points.iter().map(Point::to_integer_unit).collect(),
            ..self
        }
    }

    /// Converts all points to float units.
    #[must_use]
    pub fn to_float_unit(self) -> Self {
        Self {
            points: self.points.iter().map(Point::to_float_unit).collect(),
            ..self
        }
    }

    /// Check if a point lies on the edge of the polygon
    pub fn is_point_on_edge(&self, point: &Point) -> bool {
        crate::geometry::is_point_on_edge(point, &self.points)
    }
}

impl std::fmt::Display for Polygon {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        if self.points().is_empty() {
            write!(
                f,
                "Polygon with 0 points on layer {}, data type {}",
                self.layer(),
                self.data_type()
            )
        } else {
            write!(
                f,
                "Polygon with {} point(s), starting at ({}, {}) on layer {}, data type {}",
                self.points().len(),
                self.points()[0].x(),
                self.points()[0].y(),
                self.layer(),
                self.data_type()
            )
        }
    }
}

impl Transformable for Polygon {
    fn transform_impl(mut self, transformation: &crate::Transformation) -> Self {
        self.points = self
            .points()
            .iter()
            .map(|point| point.transform(transformation))
            .collect();

        self
    }
}

impl Movable for Polygon {
    fn move_to(self, target: Point) -> Self {
        let Some(first_point) = self.points().first() else {
            return self;
        };
        let delta = target - *first_point;
        self.move_by(delta)
    }
}

impl Dimensions for Polygon {
    fn bounding_box(&self) -> (Point, Point) {
        crate::geometry::bounding_box(&self.points)
    }
}

impl ToGds for Polygon {
    fn to_gds_impl(&self, database_units: f64) -> Result<Vec<u8>, GdsError> {
        if self.points().len() > MAX_POINTS {
            return Err(GdsError::ValidationError {
                message: format!(
                    "Polygon has {} points, which exceeds the maximum of {}",
                    self.points().len(),
                    MAX_POINTS
                ),
            });
        }

        validate_layer(self.layer())?;
        validate_data_type(self.data_type())?;

        if self.points().len() < MIN_POLYGON_POINTS {
            return Err(GdsError::ValidationError {
                message: format!(
                    "Polygon must have at least {MIN_POLYGON_POINTS} points (3 vertices + closing point), got {}",
                    self.points().len()
                ),
            });
        }

        let mut buffer = Vec::new();

        let polygon_head = [
            4,
            combine_record_and_data_type(GDSRecord::Boundary, GDSDataType::NoData),
            6,
            combine_record_and_data_type(GDSRecord::Layer, GDSDataType::TwoByteSignedInteger),
            self.layer().value(),
            6,
            combine_record_and_data_type(GDSRecord::DataType, GDSDataType::TwoByteSignedInteger),
            self.data_type().value(),
        ];

        write_u16_array_to_file(&mut buffer, &polygon_head)?;

        write_points_to_file(&mut buffer, self.points(), database_units)?;

        write_element_tail_to_file(&mut buffer)?;

        Ok(buffer)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_close_points_not_closed() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(5, 0, 1e-9),
            Point::integer(5, 5, 1e-9),
        ];
        let closed = close_points(points.clone());

        assert_eq!(closed.len(), 4);
        assert_eq!(closed[0], points[0]);
        assert_eq!(closed[closed.len() - 1], points[0]);
    }

    #[test]
    fn test_close_points_already_closed() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(5, 0, 1e-9),
            Point::integer(5, 5, 1e-9),
            Point::integer(0, 0, 1e-9),
        ];
        let closed = close_points(points.clone());

        assert_eq!(closed.len(), points.len());
    }

    #[test]
    fn test_close_points_empty() {
        let points: Vec<Point> = vec![];
        let closed = close_points(points);

        assert_eq!(closed.len(), 0);
    }

    #[test]
    fn test_polygon_creation() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));

        assert_eq!(polygon.layer(), Layer::new(1));
        assert_eq!(polygon.data_type(), DataType::new(0));
        // Should be closed automatically
        assert_eq!(polygon.points().len(), 4);
    }

    #[test]
    fn test_polygon_default() {
        let polygon = Polygon::default();
        assert_eq!(polygon.points().len(), 0);
        assert_eq!(polygon.layer(), Layer::new(0));
        assert_eq!(polygon.data_type(), DataType::new(0));
    }

    #[test]
    fn test_polygon_display() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(5, 0, 1e-9),
            Point::integer(5, 5, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(2), DataType::new(1));

        insta::assert_snapshot!(polygon.to_string(), @"Polygon with 4 point(s), starting at (0 (1.000e-9), 0 (1.000e-9)) on layer 2, data type 1");
    }

    #[test]
    fn test_polygon_display_empty() {
        let polygon = Polygon::new(vec![], Layer::new(1), DataType::new(0));
        insta::assert_snapshot!(polygon.to_string(), @"Polygon with 0 points on layer 1, data type 0");
    }

    #[test]
    fn test_polygon_area() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        assert_eq!(polygon.area(), Unit::float(100.0, 1e-9));

        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(5, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        assert_eq!(polygon.area(), Unit::float(50.0, 1e-9));

        let polygon = Polygon::new(vec![], Layer::new(1), DataType::new(0));
        assert_eq!(polygon.area(), Unit::float(0.0, 1e-9));
    }

    #[test]
    fn test_polygon_perimeter() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        assert_eq!(polygon.perimeter(), Unit::float(40.0, 1e-9));

        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(3, 0, 1e-9),
            Point::integer(0, 4, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        assert_eq!(polygon.perimeter(), Unit::float(12.0, 1e-9));

        let polygon = Polygon::new(vec![], Layer::new(1), DataType::new(0));
        assert_eq!(polygon.perimeter(), Unit::float(0.0, 1e-9));
    }

    #[test]
    fn test_is_point_inside() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));

        assert!(polygon.is_point_inside(&Point::integer(5, 5, 1e-9)));
        assert!(!polygon.is_point_inside(&Point::integer(15, 15, 1e-9)));
        assert!(!polygon.is_point_inside(&Point::integer(-5, 5, 1e-9)));
    }

    #[test]
    fn test_is_point_on_edge() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));

        assert!(polygon.is_point_on_edge(&Point::integer(5, 0, 1e-9)));
        assert!(polygon.is_point_on_edge(&Point::integer(10, 5, 1e-9)));
        assert!(polygon.is_point_on_edge(&Point::integer(0, 0, 1e-9)));
        assert!(!polygon.is_point_on_edge(&Point::integer(5, 5, 1e-9)));
        assert!(!polygon.is_point_on_edge(&Point::integer(15, 15, 1e-9)));
        assert!(!polygon.is_point_on_edge(&Point::integer(-5, 5, 1e-9)));
    }

    #[test]
    fn test_polygon_bounding_box() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        let (min, max) = polygon.bounding_box();
        assert_eq!(min, Point::integer(0, 0, 1e-9));
        assert_eq!(max, Point::integer(10, 10, 1e-9));

        let points = vec![
            Point::integer(-5, -3, 1e-9),
            Point::integer(7, 2, 1e-9),
            Point::integer(3, 8, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        let (min, max) = polygon.bounding_box();
        assert_eq!(min, Point::integer(-5, -3, 1e-9));
        assert_eq!(max, Point::integer(7, 8, 1e-9));
    }

    #[test]
    fn test_polygon_move_to() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
            Point::integer(0, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        let target = Point::integer(5, 5, 1e-9);
        let moved = polygon.move_to(target);

        assert_eq!(moved.points()[0], Point::integer(5, 5, 1e-9));
        assert_eq!(moved.points()[1], Point::integer(15, 5, 1e-9));
        assert_eq!(moved.points()[2], Point::integer(15, 15, 1e-9));
        assert_eq!(moved.points()[3], Point::integer(5, 15, 1e-9));
        assert_eq!(moved.points()[4], Point::integer(5, 5, 1e-9));
    }

    #[test]
    fn test_polygon_to_integer_unit() {
        let points = vec![
            Point::float(1.5, 2.5, 1e-6),
            Point::float(10.0, 0.0, 1e-6),
            Point::float(10.0, 10.0, 1e-6),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        let converted = polygon.to_integer_unit();

        for point in converted.points() {
            assert_eq!(*point, point.to_integer_unit());
        }
    }

    #[test]
    fn test_polygon_to_float_unit() {
        let points = vec![
            Point::integer(0, 0, 1e-9),
            Point::integer(10, 0, 1e-9),
            Point::integer(10, 10, 1e-9),
        ];
        let polygon = Polygon::new(points, Layer::new(1), DataType::new(0));
        let converted = polygon.to_float_unit();

        for point in converted.points() {
            assert_eq!(*point, point.to_float_unit());
        }
    }

    #[test]
    fn test_polygon_move_to_empty() {
        let polygon = Polygon::new(vec![], Layer::new(1), DataType::new(0));
        let moved = polygon.move_to(Point::integer(5, 5, 1e-9));
        assert_eq!(moved.points().len(), 0);
    }
}