nsys-mat 0.5.4

Dynamically sized 2d storage with rectangular iterators and in-place resizing
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

#[cfg(feature="serde")]
use serde::{Deserialize, Serialize};

use super::{Coordinate, Rectangle};

/// Non-zero rectangle dimensions
///
/// ```
/// # use mat::{Dimensions, Rectangle};
/// let d = Dimensions::from ((3, 2));
/// assert_eq!(d.rows, 3);
/// assert_eq!(d.columns,  2);
/// assert_eq!(d.area(), 6);
/// assert!( d.contains ((1, 1).into()));
/// assert!(!d.contains ((4, 1).into()));
/// assert!(!d.contains ((1, 3).into()));
/// let rect = Rectangle::from (d);
/// assert_eq!(rect.min(), (0, 0).into());
/// assert_eq!(rect.max(), (2, 1).into());
/// ```
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct Dimensions {
  pub rows    : usize,
  pub columns : usize
}

impl Dimensions {
  /// Rows * columns
  #[inline]
  pub const fn area (&self) -> usize {
    self.rows * self.columns
  }
  /// Return true if the coordinate fits within `self`'s columns and rows, false
  /// otherwise
  #[inline]
  pub fn contains (&self, Coordinate { row, column } : Coordinate) -> bool {
    self.contains_rc (row, column)
  }
  #[inline]
  pub fn contains_rc (&self, row : usize, column : usize) -> bool {
    row < self.rows && column < self.columns
  }
  #[inline]
  pub fn row (&self, row : usize) -> Option <Rectangle> {
    Rectangle::from (*self).row (row)
  }
  #[inline]
  pub fn column (&self, column : usize) -> Option <Rectangle> {
    Rectangle::from (*self).column (column)
  }
  /// Top row
  #[inline]
  pub fn top (&self) -> Option <Rectangle> {
    self.row (0)
  }
  /// Bottom row
  #[inline]
  pub fn bottom (&self) -> Option <Rectangle> {
    self.row (self.rows-1)
  }
  /// Left column
  #[inline]
  pub fn left (&self) -> Option <Rectangle> {
    self.column (0)
  }
  /// Right column
  #[inline]
  pub fn right (&self) -> Option <Rectangle> {
    self.column (self.columns-1)
  }
}
impl From <(usize, usize)> for Dimensions {
  fn from ((rows, columns) : (usize, usize)) -> Self {
    Dimensions { rows, columns }
  }
}
impl From <Dimensions> for (usize, usize) {
  fn from (Dimensions { rows, columns } : Dimensions) -> Self {
    (rows, columns)
  }
}
impl From <[usize; 2]> for Dimensions {
  fn from ([rows, columns] : [usize; 2]) -> Self {
    Dimensions { rows, columns }
  }
}
impl From <Dimensions> for [usize; 2] {
  fn from (Dimensions { rows, columns } : Dimensions) -> Self {
    [rows, columns]
  }
}
impl std::ops::Add for Dimensions {
  type Output = Dimensions;
  fn add (self, rhs : Dimensions) -> Dimensions {
    (self.rows + rhs.rows, self.columns + rhs.columns).into()
  }
}
impl std::ops::Sub for Dimensions {
  type Output = Dimensions;
  fn sub (self, rhs : Dimensions) -> Dimensions {
    (self.rows - rhs.rows, self.columns - rhs.columns).into()
  }
}