aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorJulian T <julian@jtle.dk>2021-02-02 20:39:32 +0100
committerJulian T <julian@jtle.dk>2021-02-03 14:30:21 +0100
commit32e719a517a6fea113f3e66e350c9aa60ddd98b9 (patch)
tree3db7367b59a981dd51135122254d72dc9299eb74 /src/lib.rs
parentdf6a266e5823a7fc4cca3060ec86d35f2125cd0d (diff)
Added documentation for many of the modules
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 05fbff3..df9bc1d 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -5,6 +5,9 @@ mod scene;
use std::ops::{Add, Sub, Mul, DivAssign};
use std::cmp;
+/// Trait used to implement generics
+///
+/// This is used in Bound and Vectors
pub trait Number:
Copy +
cmp::PartialOrd +
@@ -14,9 +17,10 @@ pub trait Number:
DivAssign
{}
-impl Number for usize {}
impl Number for i32 {}
impl Number for f32 {}
-// Used throughout the program
-type Float = f32;
+/// Used for representing floating point values throughout the program
+///
+/// A higher precision type will require more ram
+pub type Float = f32;