X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FTests%2FTetrahedron.hs;h=a2a7b6ebdf54fdaf6e8cdf729e4fe49d05d41ee1;hb=ecb77f944fcba8c8cfe60ca782bc5d9c8ab68cf9;hp=d4b7b9bb719a04653ecabb42f04b7a5d2cdf3ed4;hpb=76ff394c3e5a551e2a6bbf51fbee4e91b90b1611;p=spline3.git

diff --git a/src/Tests/Tetrahedron.hs b/src/Tests/Tetrahedron.hs
index d4b7b9b..a2a7b6e 100644
--- a/src/Tests/Tetrahedron.hs
+++ b/src/Tests/Tetrahedron.hs
@@ -2,31 +2,24 @@ module Tests.Tetrahedron
 where
 
 import Test.HUnit
-import Test.QuickCheck
+import Test.QuickCheck (Property, (==>))
 
+import Cardinal
 import Comparisons
-import Point
 import FunctionValues
 import Tests.FunctionValues()
 import Tetrahedron
 import ThreeDimensional
 
-instance Arbitrary Tetrahedron where
-    arbitrary = do
-      rnd_v0 <- arbitrary :: Gen Point
-      rnd_v1 <- arbitrary :: Gen Point
-      rnd_v2 <- arbitrary :: Gen Point
-      rnd_v3 <- arbitrary :: Gen Point
-      rnd_fv <- arbitrary :: Gen FunctionValues
-      return (Tetrahedron rnd_fv rnd_v0 rnd_v1 rnd_v2 rnd_v3)
-
 -- HUnit Tests
 
--- Since p0, p1, p2 are in clockwise order, we expect the volume here
--- to be negative.
-test_volume1 :: Test
+
+-- | 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 :: Assertion
 test_volume1 =
-    TestCase $ assertEqual "volume is correct" True (vol ~= (-1/3))
+    assertEqual "volume is correct" True (vol ~= (-1/3))
     where
       p0 = (0, -0.5, 0)
       p1 = (0, 0.5, 0)
@@ -40,11 +33,12 @@ test_volume1 =
       vol = volume t
 
 
--- Now, p0, p1, and p2 are in counter-clockwise order. The volume
--- should therefore be positive.
-test_volume2 :: Test
+-- | 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 :: Assertion
 test_volume2 =
-    TestCase $ assertEqual "volume is correct" True (vol ~= (1/3))
+    assertEqual "volume is correct" True (vol ~= (1/3))
     where
       p0 = (0, -0.5, 0)
       p1 = (2, 0, 0)
@@ -57,9 +51,12 @@ test_volume2 =
                         fv = empty_values }
       vol = volume t
 
-test_contains_point1 :: Test
+
+-- | Ensure that a tetrahedron contains a particular point chosen to
+--   be inside of it.
+test_contains_point1 :: Assertion
 test_contains_point1 =
-    TestCase $ assertEqual "contains an inner point" True (contains_point t inner_point)
+    assertEqual "contains an inner point" True (contains_point t inner_point)
     where
       p0 = (0, -0.5, 0)
       p1 = (0, 0.5, 0)
@@ -73,9 +70,11 @@ test_contains_point1 =
                         fv = empty_values }
 
 
-test_doesnt_contain_point1 :: Test
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (first test).
+test_doesnt_contain_point1 :: Assertion
 test_doesnt_contain_point1 =
-    TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
+    assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
     where
       p0 = (0, -0.5, 0)
       p1 = (0, 0.5, 0)
@@ -89,9 +88,11 @@ test_doesnt_contain_point1 =
                         fv = empty_values }
 
 
-test_doesnt_contain_point2 :: Test
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (second test).
+test_doesnt_contain_point2 :: Assertion
 test_doesnt_contain_point2 =
-    TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
+    assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
     where
       p0 = (0, 1, 1)
       p1 = (1, 1, 1)
@@ -104,9 +105,12 @@ test_doesnt_contain_point2 =
                         v3 = p3,
                         fv = empty_values }
 
-test_doesnt_contain_point3 :: Test
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (third test).
+test_doesnt_contain_point3 :: Assertion
 test_doesnt_contain_point3 =
-    TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
+    assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
     where
       p0 = (1, 1, 1)
       p1 = (1, 0, 1)
@@ -119,9 +123,12 @@ test_doesnt_contain_point3 =
                         v3 = p3,
                         fv = empty_values }
 
-test_doesnt_contain_point4 :: Test
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (fourth test).
+test_doesnt_contain_point4 :: Assertion
 test_doesnt_contain_point4 =
-    TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
+    assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
     where
       p0 = (1, 0, 1)
       p1 = (0, 0, 1)
@@ -134,9 +141,12 @@ test_doesnt_contain_point4 =
                         v3 = p3,
                         fv = empty_values }
 
-test_doesnt_contain_point5 :: Test
+
+-- | Ensure that a tetrahedron does not contain a particular point chosen to
+--   be outside of it (fifth test).
+test_doesnt_contain_point5 :: Assertion
 test_doesnt_contain_point5 =
-    TestCase $ assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
+    assertEqual "doesn't contain an exterior point" False (contains_point t exterior_point)
     where
       p0 = (0, 0, 1)
       p1 = (0, 1, 1)
@@ -149,82 +159,105 @@ test_doesnt_contain_point5 =
                         v3 = p3,
                         fv = empty_values }
 
-tetrahedron_tests :: [Test]
-tetrahedron_tests = [test_volume1,
-                     test_volume2,
-                     test_contains_point1,
-                     test_doesnt_contain_point1,
-                     test_doesnt_contain_point2,
-                     test_doesnt_contain_point3,
-                     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 +288,84 @@ 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 cwx (Tetrahedron.fv t)
+      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 cwx (Tetrahedron.fv t)
+      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 cwy (Tetrahedron.fv t)
+      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 cwy (Tetrahedron.fv t)
+      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 cwz (Tetrahedron.fv t)
+      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 cwz (Tetrahedron.fv t)
+      expr1 = top fv0
+      expr2 = top fv1
+
+prop_swapping_vertices_doesnt_affect_coefficients1 :: Tetrahedron -> Bool
+prop_swapping_vertices_doesnt_affect_coefficients1 t =
+      c t 0 0 1 2 == c t' 0 0 1 2
+        where
+          t' = t { v0 = (v1 t), v1 = (v0 t) }
+
+prop_swapping_vertices_doesnt_affect_coefficients2 :: Tetrahedron -> Bool
+prop_swapping_vertices_doesnt_affect_coefficients2 t =
+      c t 0 1 1 1 == c t' 0 1 1 1
+        where
+          t' = t { v2 = (v3 t), v3 = (v2 t) }
+
+prop_swapping_vertices_doesnt_affect_coefficients3 :: Tetrahedron -> Bool
+prop_swapping_vertices_doesnt_affect_coefficients3 t =
+      c t 2 1 0 0 == c t' 2 1 0 0
+        where
+          t' = t { v2 = (v3 t), v3 = (v2 t) }
+
+prop_swapping_vertices_doesnt_affect_coefficients4 :: Tetrahedron -> Bool
+prop_swapping_vertices_doesnt_affect_coefficients4 t =
+      c t 2 0 0 1 == c t' 2 0 0 1
+        where
+          t' = t { v0 = (v3 t), v3 = (v0 t) }