From: Michael Orlitzky <michael@orlitzky.com>
Date: Sun, 8 May 2011 20:56:09 +0000 (-0400)
Subject: Add two more function comments.
X-Git-Tag: 0.0.1~301
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=60ff027e52faf66c111b3dc2779c3bf5c7dfb6b9;p=spline3.git

Add two more function comments.
---

diff --git a/src/Tetrahedron.hs b/src/Tetrahedron.hs
index 9d90f71..bcf9a0b 100644
--- a/src/Tetrahedron.hs
+++ b/src/Tetrahedron.hs
@@ -76,6 +76,11 @@ beta t i j k l
     b3_term = (b3 t) `fexp` l
 
 
+-- | The coefficient function. c t i j k l returns the coefficient
+--   c_ijkl with respect to the tetrahedron t. The definition uses
+--   pattern matching to mimic the definitions given in Sorokina and
+--   Zeilfelder, pp. 84-86. If incorrect indices are supplied, the
+--   function will simply error.
 c :: Tetrahedron -> Int -> Int -> Int -> Int -> Double
 c t 0 0 3 0 = eval (fv t) $
               (1/8) * (I + F + L + T + LT + FL + FT + FLT)
@@ -197,6 +202,8 @@ c _ _ _ _ _ = error "coefficient index out of bounds"
 
 
 
+-- | The matrix used in the tetrahedron volume calculation as given in
+--   Lai & Schumaker, Definition 15.4, page 436.
 vol_matrix :: Tetrahedron -> Matrix Double
 vol_matrix t = (4><4)
                [1,  1,  1,  1,