]> gitweb.michael.orlitzky.com - spline3.git/blobdiff - src/Cube.hs
src/{Cube,FunctionValues}.hs: add explicit Cardinal imports.
[spline3.git] / src / Cube.hs
index d863c290f2084ef8c79c0dc944dbb7c0c5c6c191..8596b11846838b91f0b4db3667d130ac4152b7ed 100644 (file)
@@ -3,11 +3,10 @@ module Cube (
   cube_properties,
   find_containing_tetrahedron,
   tetrahedra,
-  tetrahedron
-  )
+  tetrahedron )
 where
 
-import Data.Maybe (fromJust)
+import Data.Maybe ( fromJust )
 import qualified Data.Vector as V (
   Vector,
   findIndex,
@@ -15,23 +14,36 @@ import qualified Data.Vector as V (
   minimum,
   singleton,
   snoc,
-  unsafeIndex
-  )
-import Prelude hiding (LT)
-import Test.Framework (Test, testGroup)
-import Test.Framework.Providers.QuickCheck2 (testProperty)
-import Test.QuickCheck (Arbitrary(..), Gen, Positive(..), choose)
-
-import Cardinal
-import Comparisons ((~=), (~~=))
-import qualified Face (Face(..), center)
-import FunctionValues (FunctionValues, eval, rotate)
-import Misc (all_equal, disjoint)
-import Point (Point(..), dot)
-import Tetrahedron (Tetrahedron(..), barycenter, c, volume)
-
-data Cube = Cube { h  :: !Double,
-                   i  :: !Int,
+  unsafeIndex)
+import Prelude hiding ( LT )
+import Test.Tasty ( TestTree, testGroup )
+import Test.Tasty.QuickCheck (
+  Arbitrary( arbitrary ),
+  Gen,
+  Positive( Positive ),
+  choose,
+  testProperty )
+import Cardinal (
+  Cardinal(F, B, L, R, D, T, FL, FR, FD, FT,
+           BL, BR, BD, BT, LD, LT, RD, RT, I),
+  ccwx,
+  ccwy,
+  ccwz,
+  cwx,
+  cwy,
+  cwz )
+import Comparisons ( (~=), (~~=) )
+import qualified Face ( Face(..), center )
+import FunctionValues ( FunctionValues, eval, rotate )
+import Misc ( all_equal, disjoint )
+import Point ( Point( Point ), dot )
+import Tetrahedron (
+  Tetrahedron(Tetrahedron, function_values, v0, v1, v2, v3),
+  barycenter,
+  c,
+  volume )
+
+data Cube = Cube { i  :: !Int,
                    j  :: !Int,
                    k  :: !Int,
                    fv :: !FunctionValues,
@@ -41,26 +53,24 @@ data Cube = Cube { h  :: !Double,
 
 instance Arbitrary Cube where
     arbitrary = do
-      (Positive h') <- arbitrary :: Gen (Positive Double)
       i' <- choose (coordmin, coordmax)
       j' <- choose (coordmin, coordmax)
       k' <- choose (coordmin, coordmax)
       fv' <- arbitrary :: Gen FunctionValues
       (Positive tet_vol) <- arbitrary :: Gen (Positive Double)
-      return (Cube h' i' j' k' fv' tet_vol)
+      return (Cube i' j' k' fv' tet_vol)
       where
         -- The idea here is that, when cubed in the volume formula,
         -- these numbers don't overflow 64 bits. This number is not
         -- magic in any other sense than that it does not cause test
         -- failures, while 2^23 does.
-        coordmax = 4194304 -- 2^22
+        coordmax = 4194304 :: Int -- 2^22
         coordmin = -coordmax
 
 
 instance Show Cube where
     show cube =
         "Cube_" ++ subscript ++ "\n" ++
-        " h: " ++ (show (h cube)) ++ "\n" ++
         " Center: " ++ (show (center cube)) ++ "\n" ++
         " xmin: " ++ (show (xmin cube)) ++ "\n" ++
         " xmax: " ++ (show (xmax cube)) ++ "\n" ++
@@ -76,65 +86,55 @@ instance Show Cube where
 -- | The left-side boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 xmin :: Cube -> Double
-xmin cube = (i' - 1/2)*delta
+xmin cube = (i' - 1/2)
     where
       i' = fromIntegral (i cube) :: Double
-      delta = h cube
 
 -- | The right-side boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 xmax :: Cube -> Double
-xmax cube = (i' + 1/2)*delta
+xmax cube = (i' + 1/2)
     where
       i' = fromIntegral (i cube) :: Double
-      delta = h cube
 
 -- | The front boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 ymin :: Cube -> Double
-ymin cube = (j' - 1/2)*delta
+ymin cube = (j' - 1/2)
     where
       j' = fromIntegral (j cube) :: Double
-      delta = h cube
 
 -- | The back boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 ymax :: Cube -> Double
-ymax cube = (j' + 1/2)*delta
+ymax cube = (j' + 1/2)
     where
       j' = fromIntegral (j cube) :: Double
-      delta = h cube
 
 -- | The bottom boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 zmin :: Cube -> Double
-zmin cube = (k' - 1/2)*delta
+zmin cube = (k' - 1/2)
     where
       k' = fromIntegral (k cube) :: Double
-      delta = h cube
 
 -- | The top boundary of the cube. See Sorokina and Zeilfelder,
 --   p. 76.
 zmax :: Cube -> Double
-zmax cube = (k' + 1/2)*delta
+zmax cube = (k' + 1/2)
     where
       k' = fromIntegral (k cube) :: Double
-      delta = h cube
 
 
 -- | The center of Cube_ijk coincides with v_ijk at
---   (ih, jh, kh). See Sorokina and Zeilfelder, p. 76.
+--   (i, j, k). See Sorokina and Zeilfelder, p. 76.
 center :: Cube -> Point
 center cube =
   Point x y z
   where
-    delta = h cube
-    i' = fromIntegral (i cube) :: Double
-    j' = fromIntegral (j cube) :: Double
-    k' = fromIntegral (k cube) :: Double
-    x = delta * i'
-    y = delta * j'
-    z = delta * k'
+    x = fromIntegral (i cube) :: Double
+    y = fromIntegral (j cube) :: Double
+    z = fromIntegral (k cube) :: Double
 
 
 -- Face stuff.
@@ -143,7 +143,7 @@ center cube =
 top_face :: Cube -> Face.Face
 top_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point delta (-delta) delta )
       v1' = cc + ( Point delta delta delta )
@@ -156,7 +156,7 @@ top_face cube = Face.Face v0' v1' v2' v3'
 back_face :: Cube -> Face.Face
 back_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point delta (-delta) (-delta) )
       v1' = cc + ( Point delta delta (-delta) )
@@ -168,7 +168,7 @@ back_face cube = Face.Face v0' v1' v2' v3'
 down_face :: Cube -> Face.Face
 down_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point (-delta) (-delta) (-delta) )
       v1' = cc + ( Point (-delta) delta (-delta) )
@@ -181,7 +181,7 @@ down_face cube = Face.Face v0' v1' v2' v3'
 front_face :: Cube -> Face.Face
 front_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point (-delta) (-delta) delta )
       v1' = cc + ( Point (-delta) delta delta )
@@ -192,7 +192,7 @@ front_face cube = Face.Face v0' v1' v2' v3'
 left_face :: Cube -> Face.Face
 left_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point delta (-delta) delta )
       v1' = cc + ( Point (-delta) (-delta) delta )
@@ -204,7 +204,7 @@ left_face cube = Face.Face v0' v1' v2' v3'
 right_face :: Cube -> Face.Face
 right_face cube = Face.Face v0' v1' v2' v3'
     where
-      delta = (1/2)*(h cube)
+      delta = (1/2) :: Double
       cc  = center cube
       v0' = cc + ( Point (-delta) delta delta)
       v1' = cc + ( Point delta  delta delta )
@@ -616,9 +616,8 @@ find_containing_tetrahedron cube p =
     left_half = in_left_half cube p
 
     candidates :: V.Vector Tetrahedron
-    candidates =
-      if front_half then
-
+    candidates
+      | front_half =
         if left_half then
           if top_half then
             front_left_top_tetrahedra cube
@@ -630,8 +629,7 @@ find_containing_tetrahedron cube p =
           else
             front_right_down_tetrahedra cube
 
-      else -- bottom half
-
+      | otherwise = -- back half
         if left_half then
           if top_half then
             back_left_top_tetrahedra cube
@@ -667,9 +665,7 @@ find_containing_tetrahedron cube p =
 
 
 
--- Tests
-
--- Quickcheck tests.
+-- * Tests
 
 prop_opposite_octant_tetrahedra_disjoint1 :: Cube -> Bool
 prop_opposite_octant_tetrahedra_disjoint1 cube =
@@ -709,12 +705,10 @@ prop_all_volumes_positive cube =
 
 -- | In fact, since all of the tetrahedra are identical, we should
 --   already know their volumes. There's 24 tetrahedra to a cube, so
---   we'd expect the volume of each one to be (1/24)*h^3.
+--   we'd expect the volume of each one to be 1/24.
 prop_all_volumes_exact :: Cube -> Bool
 prop_all_volumes_exact cube =
-    and [volume t ~~= (1/24)*(delta^(3::Int)) | t <- tetrahedra cube]
-    where
-      delta = h cube
+    and [volume t ~~= 1/24 | t <- tetrahedra cube]
 
 -- | All tetrahedron should have their v0 located at the center of the
 --   cube.
@@ -991,7 +985,7 @@ prop_interior_values_all_identical cube =
 --   This test checks the rotation works as expected.
 prop_c_tilde_2100_rotation_correct :: Cube -> Bool
 prop_c_tilde_2100_rotation_correct cube =
-    expr1 == expr2
+    expr1 ~= expr2
     where
       t0 = tetrahedron cube 0
       t6 = tetrahedron cube 6
@@ -1025,7 +1019,7 @@ prop_c_tilde_2100_rotation_correct cube =
 --   even meaningful!
 prop_c_tilde_2100_correct :: Cube -> Bool
 prop_c_tilde_2100_correct cube =
-    c t6 2 1 0 0 == expected
+    c t6 2 1 0 0 ~= expected
     where
       t0 = tetrahedron cube 0
       t6 = tetrahedron cube 6
@@ -1147,9 +1141,9 @@ prop_t7_shares_edge_with_t20 cube =
         t20 = tetrahedron cube 20
 
 
-p79_26_properties :: Test.Framework.Test
+p79_26_properties :: TestTree
 p79_26_properties =
-    testGroup "p. 79, Section (2.6) Properties" [
+    testGroup "p. 79, Section (2.6) properties" [
       testProperty "c0120 identity1" prop_c0120_identity1,
       testProperty "c0120 identity2" prop_c0120_identity2,
       testProperty "c0120 identity3" prop_c0120_identity3,
@@ -1163,9 +1157,9 @@ p79_26_properties =
       testProperty "c1200 identity1" prop_c1200_identity1,
       testProperty "c2100 identity1" prop_c2100_identity1]
 
-p79_27_properties :: Test.Framework.Test
+p79_27_properties :: TestTree
 p79_27_properties =
-    testGroup "p. 79, Section (2.7) Properties" [
+    testGroup "p. 79, Section (2.7) properties" [
       testProperty "c0102 identity1" prop_c0102_identity1,
       testProperty "c0201 identity1" prop_c0201_identity1,
       testProperty "c0300 identity2" prop_c0300_identity2,
@@ -1174,9 +1168,9 @@ p79_27_properties =
       testProperty "c2100 identity2" prop_c2100_identity2 ]
 
 
-p79_28_properties :: Test.Framework.Test
+p79_28_properties :: TestTree
 p79_28_properties =
-  testGroup "p. 79, Section (2.8) Properties" [
+  testGroup "p. 79, Section (2.8) properties" [
     testProperty "c3000 identity" prop_c3000_identity,
     testProperty "c2010 identity" prop_c2010_identity,
     testProperty "c2001 identity" prop_c2001_identity,
@@ -1185,9 +1179,9 @@ p79_28_properties =
     testProperty "c1011 identity" prop_c1011_identity ]
 
 
-edge_incidence_tests :: Test.Framework.Test
+edge_incidence_tests :: TestTree
 edge_incidence_tests =
-    testGroup "Edge Incidence Tests" [
+    testGroup "Edge incidence tests" [
       testProperty "t0 shares edge with t6" prop_t0_shares_edge_with_t6,
       testProperty "t0 shares edge with t1" prop_t0_shares_edge_with_t1,
       testProperty "t0 shares edge with t3" prop_t0_shares_edge_with_t3,
@@ -1204,9 +1198,9 @@ edge_incidence_tests =
       testProperty "t6 shares edge with t7" prop_t6_shares_edge_with_t7,
       testProperty "t7 shares edge with t20" prop_t7_shares_edge_with_t20 ]
 
-cube_properties :: Test.Framework.Test
+cube_properties :: TestTree
 cube_properties =
-  testGroup "Cube Properties" [
+  testGroup "Cube properties" [
     p79_26_properties,
     p79_27_properties,
     p79_28_properties,