lowdim/
lib.rs

1//! Affine geometry for discrete 2d, 3d and 4d worlds.
2//!
3//! Provides vectors, matrices, points and more to simplify
4//! programming for 2d to 4d worlds.
5//! Features include:
6//! * Vector and point arithmetic
7//! * Bounding boxes and iterators over the points inside them
8//! * Arrays indexed by points in bounding boxes
9//! * Taxicab (L1) and maximum (L∞) metrics
10//! * Iterators over orthogonal and king's move neighbourhoods
11//! * Rotations and reflections (currently only implemented for 2d)
12//!
13//! This was originally motivated by
14//! [Advent of Code](https://adventofcode.com/)
15//! (yes, Santa's elves use the 4th dimension, for example for
16//! [time travel](https://adventofcode.com/2018/day/25)).
17//!
18//! ## Crate Status
19//!
20//! Experimental
21//!
22//! ### Limitations
23//! - Rotations and reflections are only implemented for the 2d case.
24//!
25//! ## Crate Feature Flags
26//!
27//! - `random`
28//!   - Off by default.
29//!   - Adds a dependency to the `rand` crate.
30//!   - Adds the method [`random_point`](BBox2d::random_point)
31//!     to generate random points in a bounding box.
32
33#![warn(missing_docs)]
34
35pub mod integer;
36#[doc(inline)]
37pub use integer::Integer;
38
39pub mod vector;
40#[doc(inline)]
41pub use vector::Vector;
42#[doc(inline)]
43pub use vector::VectorOps;
44
45pub mod vec2d;
46#[doc(inline)]
47pub use crate::vec2d::v2d;
48#[doc(inline)]
49pub use crate::vec2d::Vec2d;
50
51pub mod vec3d;
52#[doc(inline)]
53pub use crate::vec3d::v3d;
54#[doc(inline)]
55pub use crate::vec3d::Vec3d;
56
57pub mod vec4d;
58#[doc(inline)]
59pub use crate::vec4d::v4d;
60#[doc(inline)]
61pub use crate::vec4d::Vec4d;
62
63pub mod matrix;
64#[doc(inline)]
65pub use matrix::Matrix;
66#[doc(inline)]
67pub use matrix::MatrixOps;
68
69pub mod matrix2d;
70#[doc(inline)]
71pub use crate::matrix2d::Matrix2d;
72
73pub mod matrix3d;
74#[doc(inline)]
75pub use crate::matrix3d::Matrix3d;
76
77pub mod matrix4d;
78#[doc(inline)]
79pub use crate::matrix4d::Matrix4d;
80
81pub mod point;
82#[doc(inline)]
83pub use crate::point::p2d;
84#[doc(inline)]
85pub use crate::point::p3d;
86#[doc(inline)]
87pub use crate::point::p4d;
88#[doc(inline)]
89pub use crate::point::Point;
90#[doc(inline)]
91pub use crate::point::Point2d;
92#[doc(inline)]
93pub use crate::point::Point3d;
94#[doc(inline)]
95pub use crate::point::Point4d;
96
97pub mod bbox;
98#[doc(inline)]
99pub use crate::bbox::bb2d;
100#[doc(inline)]
101pub use crate::bbox::bb3d;
102#[doc(inline)]
103pub use crate::bbox::bb4d;
104#[doc(inline)]
105pub use crate::bbox::BBox;
106#[doc(inline)]
107pub use crate::bbox::BBox2d;
108#[doc(inline)]
109pub use crate::bbox::BBox3d;
110#[doc(inline)]
111pub use crate::bbox::BBox4d;
112
113pub mod sym2d;
114#[doc(inline)]
115pub use crate::sym2d::Sym2d;
116
117pub mod affine_transformation;
118#[doc(inline)]
119pub use crate::affine_transformation::AffineTransformation;
120#[doc(inline)]
121pub use crate::affine_transformation::AffineTransformation2d;
122#[doc(inline)]
123pub use crate::affine_transformation::AffineTransformation3d;
124#[doc(inline)]
125pub use crate::affine_transformation::AffineTransformation4d;
126
127pub mod array;
128#[doc(inline)]
129pub use crate::array::Array;
130#[doc(inline)]
131pub use crate::array::Array2d;
132#[doc(inline)]
133pub use crate::array::Array3d;
134#[doc(inline)]
135pub use crate::array::Array4d;
136
137mod layout;
138use crate::layout::Layout;
139use crate::layout::Layout2d;
140use crate::layout::Layout3d;
141use crate::layout::Layout4d;
142
143mod util;
144use crate::util::lex_then;
145use crate::util::partial_then;
lowdim/lib.rs

lowdim/
lib.rs
