i_shape 5.0.0

iShape is a compact and efficient library specifically designed for representing 2D data structures using IntPoint.
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

use crate::source::int::resource::IntShapeResource;
use i_float::int::number::int::IntNumber;
use i_float::int::point::IntPoint;

/// Checks the coordinate range of points in an integer shape resource.
pub trait IntSafeRange<I: IntNumber> {
    /// Returns whether every visited point satisfies [`IntPoint::is_in_safe_range`].
    ///
    /// Each coordinate must be strictly between `-2^(I::BITS - 2)` and
    /// `2^(I::BITS - 2)`. Empty resources and empty contours return `true`.
    /// The check stops at the first point outside the range without allocating.
    ///
    /// This checks only coordinate bounds. It does not validate geometry or
    /// guarantee that an accumulated area fits in the wide integer type.
    /// Points are visited through [`IntShapeResource::iter_paths`]; any traversal
    /// preconditions of the resource still apply.
    ///
    /// ```
    /// use i_shape::int::{IntPoint, safe_range::IntSafeRange};
    ///
    /// let contour = vec![IntPoint::new(0_i32, 0), IntPoint::new(10, 20)];
    /// assert!(contour.is_in_safe_range());
    /// let shape = vec![contour];
    /// assert!(shape.is_in_safe_range());
    /// let shapes = vec![shape];
    /// assert!(shapes.is_in_safe_range());
    /// ```
    fn is_in_safe_range(&self) -> bool;
}

impl<I: IntNumber, R: IntShapeResource<I> + ?Sized> IntSafeRange<I> for R {
    #[inline]
    fn is_in_safe_range(&self) -> bool {
        self.iter_paths()
            .all(|path| path.iter().all(IntPoint::is_in_safe_range))
    }
}