Merge pull request #1 from bvssvni/master

Moved in traits from vecmath

Author: bvssvni

.gitignore

@@ -0,0 +1,31 @@
+.DS_Store
+*~
+*#
+*.o
+*.so
+*.swp
+*.old
+*.bak
+*.kate-swp
+*.dylib
+*.dSYM
+*.dll
+*.rlib
+*.dummy
+*.exe
+*-test
+/bin/main
+/bin/test-internal
+/bin/test-external
+/doc/
+/target/
+/build/
+/.rust/
+rusti.sh
+watch.sh
+/examples/**
+!/examples/*.rs
+!/examples/assets/
+!/bin/assets/
+
+Cargo.lock

Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+
+name = "piston-float"
+version = "0.0.0"
+authors = ["bvssvni <bvssvni@gmail.com>"]
+keywords = ["float", "piston"]
+description = "Traits for generic floats in game development"
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/pistondevelopers/float.git"
+homepage = "https://github.com/pistondevelopers/float"
+
+[lib]
+name = "float"

src/lib.rs

@@ -0,0 +1,317 @@
+#![deny(missing_docs)]
+
+//! Traits for generic floats in game programming
+use std::ops::*;
+
+/// Convenience trait for floats.
+pub trait Float:
+    Copy + Radians + One + Zero + Sqrt
+    + FromPrimitive
+    + Min + Max + Signum
+    + Trig
+    + PartialEq
+    + Add<Self, Output = Self>
+    + Mul<Self, Output = Self>
+    + Sub<Self, Output = Self>
+    + Div<Self, Output = Self>
+    + Rem<Self, Output = Self>
+    + Neg<Output = Self>
+    + Trig {}
+
+impl<T> Float for T where
+    T: Copy + Radians + One + Zero + Sqrt
+    + FromPrimitive
+    + Min + Max + Signum
+    + Trig
+    + PartialEq
+    + Add<T, Output = T>
+    + Mul<T, Output = T>
+    + Sub<T, Output = T>
+    + Div<T, Output = T>
+    + Rem<T, Output = T>
+    + Neg<Output = T>
+    + Trig {}
+
+/// Minimum value.
+pub trait Min {
+    /// Returns the minimum value of self or other.
+    fn min(self, other: Self) -> Self;
+}
+
+impl Min for f32 {
+    #[inline(always)]
+    fn min(self, other: Self) -> Self { self.min(other) }
+}
+
+impl Min for f64 {
+    #[inline(always)]
+    fn min(self, other: Self) -> Self { self.min(other) }
+}
+
+/// Maximum value.
+pub trait Max {
+    /// Returns the maximum value of self or other.
+    fn max(self, other: Self) -> Self;
+}
+
+impl Max for f32 {
+    #[inline(always)]
+    fn max(self, other: Self) -> Self { self.max(other) }
+}
+
+impl Max for f64 {
+    #[inline(always)]
+    fn max(self, other: Self) -> Self { self.max(other) }
+}
+
+/// The sign of the number.
+pub trait Signum {
+    /// Returns number representing the sign of self
+    fn signum(self) -> Self;
+}
+
+impl Signum for f32 {
+    #[inline(always)]
+    fn signum(self) -> Self { self.signum() }
+}
+
+impl Signum for f64 {
+    #[inline(always)]
+    fn signum(self) -> Self { self.signum() }
+}
+
+/// Useful constants for radians.
+pub trait Radians {
+    /// Returns radians corresponding to 90 degrees.
+    fn _90() -> Self;
+
+    /// Returns radians corresponding to 180 degrees.
+    fn _180() -> Self;
+
+    /// Returns radians corresponding to 360 degrees.
+    fn _360() -> Self;
+
+    /// Convert a value to radians from degrees.
+    /// Equivalent to ```value * (π / 180)```.
+    fn deg_to_rad(self) -> Self;
+
+    /// Convert a value to degrees from radians.
+    /// Equivalent to ```value * (180 / π)```.
+    fn rad_to_deg(self) -> Self;
+}
+
+impl Radians for f32 {
+    #[inline(always)]
+    fn _90() -> f32 {
+        ::std::f32::consts::FRAC_PI_2
+    }
+
+    #[inline(always)]
+    fn _180() -> f32 {
+        ::std::f32::consts::PI
+    }
+
+    #[inline(always)]
+    fn _360() -> f32 {
+        <Self as Radians>::_180() * 2.0
+    }
+
+    #[inline(always)]
+    fn deg_to_rad(self) -> Self {
+        self * (::std::f32::consts::PI / 180.0f32)
+    }
+
+    #[inline(always)]
+    fn rad_to_deg(self) -> Self {
+        self * (180.0f32 / ::std::f32::consts::PI)
+    }
+}
+
+impl Radians for f64 {
+    #[inline(always)]
+    fn _90() -> f64 {
+        ::std::f64::consts::FRAC_PI_2
+    }
+
+    #[inline(always)]
+    fn _180() -> f64 {
+        ::std::f64::consts::PI
+    }
+
+    #[inline(always)]
+    fn _360() -> f64 {
+        <Self as Radians>::_180() * 2.0
+    }
+
+    #[inline(always)]
+    fn deg_to_rad(self) -> Self {
+        self * (::std::f64::consts::PI / 180.0f64)
+    }
+
+    #[inline(always)]
+    fn rad_to_deg(self) -> Self {
+        self * (180.0f64 / ::std::f64::consts::PI)
+    }
+}
+
+/// Number 1.
+pub trait One {
+    /// Returns 1.
+    fn one() -> Self;
+}
+
+/// Number 0.
+pub trait Zero {
+    /// Returns 0.
+    fn zero() -> Self;
+}
+
+impl One for f32 {
+    #[inline(always)]
+    fn one() -> f32 { 1.0 }
+}
+
+impl One for f64 {
+    #[inline(always)]
+    fn one() -> f64 { 1.0 }
+}
+
+impl Zero for f32 {
+    #[inline(always)]
+    fn zero() -> f32 { 0.0 }
+}
+
+impl Zero for f64 {
+    #[inline(always)]
+    fn zero() -> f64 { 0.0 }
+}
+
+/// Square root.
+pub trait Sqrt {
+    /// Returns square root.
+    fn sqrt(self) -> Self;
+}
+
+impl Sqrt for f32 {
+    #[inline(always)]
+    fn sqrt(self) -> f32 { self.sqrt() }
+}
+
+impl Sqrt for f64 {
+    #[inline(always)]
+    fn sqrt(self) -> f64 { self.sqrt() }
+}
+
+/// Basic trigonometry functions
+pub trait Trig {
+    /// Returns sine of self
+    fn sin(self) -> Self;
+    /// Returns cosine of self
+    fn cos(self) -> Self;
+    /// Returns tangent of self
+    fn tan(self) -> Self;
+}
+
+impl Trig for f32 {
+    #[inline(always)]
+    fn sin(self) -> f32 { self.sin() }
+
+    #[inline(always)]
+    fn cos(self) -> f32 { self.cos() }
+
+    #[inline(always)]
+    fn tan(self) -> f32 { self.tan() }
+}
+
+impl Trig for f64 {
+    #[inline(always)]
+    fn sin(self) -> f64 { self.sin() }
+
+    #[inline(always)]
+    fn cos(self) -> f64 { self.cos() }
+
+    #[inline(always)]
+    fn tan(self) -> f64 { self.tan() }
+}
+
+/// Casts into another type.
+pub trait Cast<T> {
+    /// Casts into other type.
+    fn cast(self) -> T;
+}
+
+impl Cast<f32> for f64 {
+    #[inline(always)]
+    fn cast(self) -> f32 { self as f32 }
+}
+
+impl Cast<f64> for f32 {
+    #[inline(always)]
+    fn cast(self) -> f64 { self as f64 }
+}
+
+impl Cast<f32> for f32 {
+    #[inline(always)]
+    fn cast(self) -> f32 { self }
+}
+
+impl Cast<f64> for f64 {
+    #[inline(always)]
+    fn cast(self) -> f64 { self }
+}
+
+/// Trait for converting from different numeric types
+pub trait FromPrimitive {
+    /// from a f64
+    fn from_f64(t: f64) -> Self;
+    /// from a f32
+    fn from_f32(t: f32) -> Self;
+    /// from a isze
+    fn from_isize(t: isize) -> Self;
+    // Add more as needed..
+}
+
+impl FromPrimitive for f64 {
+    fn from_f64(t: f64) -> Self { t }
+    fn from_f32(t: f32) -> Self { t as f64 }
+    fn from_isize(t: isize) -> Self { t as f64 }
+}
+
+impl FromPrimitive for f32 {
+    fn from_f64(t: f64) -> Self { t as f32 }
+    fn from_f32(t: f32) -> Self { t }
+    fn from_isize(t: isize) -> Self { t as f32 }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_f32_sqrt() {
+        let a = 4.0f32;
+        let b = <f32 as Sqrt>::sqrt(a);
+        assert_eq!(b, 2.0f32);
+    }
+
+    #[test]
+    fn test_f64_sqrt() {
+        let a = 4.0f64;
+        let b = <f64 as Sqrt>::sqrt(a);
+        assert_eq!(b, 2.0f64);
+    }
+
+    #[test]
+    fn test_f32_deg_to_rad() {
+        let degrees = 23.0f32;
+        let radians = degrees.deg_to_rad();
+        assert!(f32::abs_sub(radians, 0.401425) > ::std::f32::EPSILON);
+    }
+
+    #[test]
+    fn test_f64_deg_to_rad() {
+        let degrees = 60.0f64;
+        let radians = degrees.deg_to_rad();
+        assert!(f64::abs_sub(radians, 1.047197)  > ::std::f64::EPSILON);
+    }
+}