]> gitweb.michael.orlitzky.com - spline3.git/blobdiff - src/Tests/Tetrahedron.hs
Add six tests to ensure that the rotations don't affect faces perpendicular to them.
[spline3.git] / src / Tests / Tetrahedron.hs
index d4b7b9bb719a04653ecabb42f04b7a5d2cdf3ed4..159acd7f95bdb11a4a583c994fcd7a0ed350a2ee 100644 (file)
@@ -4,6 +4,7 @@ where
 import Test.HUnit
 import Test.QuickCheck
 
+import Cardinal
 import Comparisons
 import Point
 import FunctionValues
@@ -22,8 +23,10 @@ instance Arbitrary Tetrahedron where
 
 -- HUnit Tests
 
--- Since p0, p1, p2 are in clockwise order, we expect the volume here
--- to be negative.
+
+-- | Check the volume of a particular tetrahedron against the value
+--   computed by hand. Its vertices are in clockwise order, so the
+--   volume should be negative.
 test_volume1 :: Test
 test_volume1 =
     TestCase $ assertEqual "volume is correct" True (vol ~= (-1/3))
@@ -40,8 +43,9 @@ test_volume1 =
       vol = volume t
 
 
--- Now, p0, p1, and p2 are in counter-clockwise order. The volume
--- should therefore be positive.
+-- | Check the volume of a particular tetrahedron against the value
+--   computed by hand. Its vertices are in counter-clockwise order, so
+--   the volume should be positive.
 test_volume2 :: Test
 test_volume2 =
     TestCase $ assertEqual "volume is correct" True (vol ~= (1/3))
@@ -57,6 +61,9 @@ test_volume2 =
                         fv = empty_values }
       vol = volume t
 
+
+-- | Ensure that a tetrahedron contains a particular point chosen to
+--   be inside of it.
 test_contains_point1 :: Test
 test_contains_point1 =
     TestCase $ assertEqual "contains an inner point" True (contains_point t inner_point)
@@ -73,6 +80,8 @@ test_contains_point1 =
                         fv = empty_values }
 
 
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (first test).
 test_doesnt_contain_point1 :: Test
 test_doesnt_contain_point1 =
     TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
@@ -89,6 +98,8 @@ test_doesnt_contain_point1 =
                         fv = empty_values }
 
 
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (second test).
 test_doesnt_contain_point2 :: Test
 test_doesnt_contain_point2 =
     TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
@@ -104,6 +115,9 @@ test_doesnt_contain_point2 =
                         v3 = p3,
                         fv = empty_values }
 
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (third test).
 test_doesnt_contain_point3 :: Test
 test_doesnt_contain_point3 =
     TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
@@ -119,6 +133,9 @@ test_doesnt_contain_point3 =
                         v3 = p3,
                         fv = empty_values }
 
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (fourth test).
 test_doesnt_contain_point4 :: Test
 test_doesnt_contain_point4 =
     TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
@@ -134,6 +151,9 @@ test_doesnt_contain_point4 =
                         v3 = p3,
                         fv = empty_values }
 
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (fifth test).
 test_doesnt_contain_point5 :: Test
 test_doesnt_contain_point5 =
     TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
@@ -149,6 +169,7 @@ test_doesnt_contain_point5 =
                         v3 = p3,
                         fv = empty_values }
 
+-- | A list of all HUnit tests defined in this module.
 tetrahedron_tests :: [Test]
 tetrahedron_tests = [test_volume1,
                      test_volume2,
@@ -159,72 +180,105 @@ tetrahedron_tests = [test_volume1,
                      test_doesnt_contain_point4,
                      test_doesnt_contain_point5 ]
 
+
+-- | The barycentric coordinate of v0 with respect to itself should
+--   be one.
 prop_b0_v0_always_unity :: Tetrahedron -> Property
 prop_b0_v0_always_unity t =
     (volume t) > 0 ==> (b0 t) (v0 t) ~= 1.0
 
+-- | The barycentric coordinate of v1 with respect to v0 should
+--   be zero.
 prop_b0_v1_always_zero :: Tetrahedron -> Property
 prop_b0_v1_always_zero t =
     (volume t) > 0 ==> (b0 t) (v1 t) ~= 0
 
+-- | The barycentric coordinate of v2 with respect to v0 should
+--   be zero.
 prop_b0_v2_always_zero :: Tetrahedron -> Property
 prop_b0_v2_always_zero t =
     (volume t) > 0 ==> (b0 t) (v2 t) ~= 0
 
+-- | The barycentric coordinate of v3 with respect to v0 should
+--   be zero.
 prop_b0_v3_always_zero :: Tetrahedron -> Property
 prop_b0_v3_always_zero t =
     (volume t) > 0 ==> (b0 t) (v3 t) ~= 0
 
+-- | The barycentric coordinate of v1 with respect to itself should
+--   be one.
 prop_b1_v1_always_unity :: Tetrahedron -> Property
 prop_b1_v1_always_unity t =
     (volume t) > 0 ==> (b1 t) (v1 t) ~= 1.0
 
+-- | The barycentric coordinate of v0 with respect to v1 should
+--   be zero.
 prop_b1_v0_always_zero :: Tetrahedron -> Property
 prop_b1_v0_always_zero t =
     (volume t) > 0 ==> (b1 t) (v0 t) ~= 0
 
+-- | The barycentric coordinate of v2 with respect to v1 should
+--   be zero.
 prop_b1_v2_always_zero :: Tetrahedron -> Property
 prop_b1_v2_always_zero t =
     (volume t) > 0 ==> (b1 t) (v2 t) ~= 0
 
+-- | The barycentric coordinate of v3 with respect to v1 should
+--   be zero.
 prop_b1_v3_always_zero :: Tetrahedron -> Property
 prop_b1_v3_always_zero t =
     (volume t) > 0 ==> (b1 t) (v3 t) ~= 0
 
+-- | The barycentric coordinate of v2 with respect to itself should
+--   be one.
 prop_b2_v2_always_unity :: Tetrahedron -> Property
 prop_b2_v2_always_unity t =
     (volume t) > 0 ==> (b2 t) (v2 t) ~= 1.0
 
+-- | The barycentric coordinate of v0 with respect to v2 should
+--   be zero.
 prop_b2_v0_always_zero :: Tetrahedron -> Property
 prop_b2_v0_always_zero t =
     (volume t) > 0 ==> (b2 t) (v0 t) ~= 0
 
+-- | The barycentric coordinate of v1 with respect to v2 should
+--   be zero.
 prop_b2_v1_always_zero :: Tetrahedron -> Property
 prop_b2_v1_always_zero t =
     (volume t) > 0 ==> (b2 t) (v1 t) ~= 0
 
+-- | The barycentric coordinate of v3 with respect to v2 should
+--   be zero.
 prop_b2_v3_always_zero :: Tetrahedron -> Property
 prop_b2_v3_always_zero t =
     (volume t) > 0 ==> (b2 t) (v3 t) ~= 0
 
+-- | The barycentric coordinate of v3 with respect to itself should
+--   be one.
 prop_b3_v3_always_unity :: Tetrahedron -> Property
 prop_b3_v3_always_unity t =
     (volume t) > 0 ==> (b3 t) (v3 t) ~= 1.0
 
+-- | The barycentric coordinate of v0 with respect to v3 should
+--   be zero.
 prop_b3_v0_always_zero :: Tetrahedron -> Property
 prop_b3_v0_always_zero t =
     (volume t) > 0 ==> (b3 t) (v0 t) ~= 0
 
+-- | The barycentric coordinate of v1 with respect to v3 should
+--   be zero.
 prop_b3_v1_always_zero :: Tetrahedron -> Property
 prop_b3_v1_always_zero t =
     (volume t) > 0 ==> (b3 t) (v1 t) ~= 0
 
+-- | The barycentric coordinate of v2 with respect to v3 should
+--   be zero.
 prop_b3_v2_always_zero :: Tetrahedron -> Property
 prop_b3_v2_always_zero t =
     (volume t) > 0 ==> (b3 t) (v2 t) ~= 0
 
 
--- Used for convenience in the next few tests.
+-- | Used for convenience in the next few tests; not a test itself.
 p :: Tetrahedron -> Int -> Int -> Int -> Int -> Double
 p t i j k l = (polynomial t) (xi t i j k l)
 
@@ -255,3 +309,60 @@ prop_c1110_identity t =
           term2 = (9/2)*(p t 1 1 1 0)
           term3 = (3/4)*((p t 2 1 0 0) + (p t 1 2 0 0) + (p t 2 0 1 0))
           term4 = (3/4)*((p t 1 0 2 0) + (p t 0 2 1 0) + (p t 0 1 2 0))
+
+prop_x_rotation_doesnt_affect_front :: Tetrahedron -> Bool
+prop_x_rotation_doesnt_affect_front t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwx
+      expr1 = front $ fv0
+      expr2 = front $ fv1
+
+prop_x_rotation_doesnt_affect_back :: Tetrahedron -> Bool
+prop_x_rotation_doesnt_affect_back t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwx
+      expr1 = back $ fv0
+      expr2 = back $ fv1
+
+
+prop_y_rotation_doesnt_affect_left :: Tetrahedron -> Bool
+prop_y_rotation_doesnt_affect_left t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwy
+      expr1 = left $ fv0
+      expr2 = left $ fv1
+
+prop_y_rotation_doesnt_affect_right :: Tetrahedron -> Bool
+prop_y_rotation_doesnt_affect_right t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwy
+      expr1 = right $ fv0
+      expr2 = right $ fv1
+
+
+prop_z_rotation_doesnt_affect_down :: Tetrahedron -> Bool
+prop_z_rotation_doesnt_affect_down t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwz
+      expr1 = down $ fv0
+      expr2 = down $ fv1
+
+
+prop_z_rotation_doesnt_affect_top :: Tetrahedron -> Bool
+prop_z_rotation_doesnt_affect_top t =
+    expr1 == expr2
+    where
+      fv0 = Tetrahedron.fv t
+      fv1 = rotate (Tetrahedron.fv t) cwz
+      expr1 = top $ fv0
+      expr2 = top $ fv1