vecdisp, scalar, docs

1 files changed, 33 insertions, 5 deletions

diff --git a/lib/Data/Packed/Matrix.hs b/lib/Data/Packed/Matrix.hs
index 7e197d1..fc988af 100644
--- a/lib/Data/Packed/Matrix.hs
+++ b/lib/Data/Packed/Matrix.hs
@@ -29,7 +29,7 @@ module Data.Packed.Matrix (
     extractRows,
     ident, diag, diagRect, takeDiag,
     liftMatrix, liftMatrix2,
-    format, dispf, disps, vecdisp,
+    format, dispf, disps,
     loadMatrix, saveMatrix, fromFile, fileDimensions,
     readMatrix, fromArray2D
 ) where
@@ -230,7 +230,7 @@ this function the user can easily define any desired display function:
 
 @import Text.Printf(printf)@
 
-@disp = putStrLn . format \"  \" (printf \"%.2f\")@
+@disp = putStr . format \"  \" (printf \"%.2f\")@
 
 -}
 format :: (Element t) => String -> (t -> String) -> Matrix t -> String
@@ -249,11 +249,32 @@ dispC d m = disp m (shfc d)
 -------------------------------------------------------------------
 -- display utilities
 
--- | Print a matrix with \"autoscaling\" and a given number of decimal places.
+{- | Show a matrix with \"autoscaling\" and a given number of decimal places.
+
+@disp = putStr . disps 2
+
+\> disp $ 120 * (3><4) [1..]
+3x4  E3
+ 0.12  0.24  0.36  0.48
+ 0.60  0.72  0.84  0.96
+ 1.08  1.20  1.32  1.44
+@
+-}
 disps :: Int -> Matrix Double -> String
 disps d x = sdims x ++ "  " ++ formatScaled d x
 
--- | Print a matrix with a given number of decimal places.
+{- | Show a matrix with a given number of decimal places.
+
+@disp = putStr . dispf 3
+
+\> disp (1/3 + ident 4)
+4x4
+1.333  0.333  0.333  0.333
+0.333  1.333  0.333  0.333
+0.333  0.333  1.333  0.333
+0.333  0.333  0.333  1.333
+@
+-}
 dispf :: Int -> Matrix Double -> String
 dispf d x = sdims x ++ "\n" ++ formatFixed (if isInt x then 0 else d) x
 
@@ -272,7 +293,14 @@ formatScaled dec t = "E"++show o++"\n" ++ ss
           o = floor $ maximum $ map (logBase 10 . abs) $ toList $ flatten t
           fmt = '%':show (dec+3) ++ '.':show dec ++"f"
 
--- | Print a vector using a function for printing matrices.
+{- | Show a vector using a function for showing matrices.
+
+@disp = putStr . vecdisp (dispf 2)
+
+\> disp (linspace 10 (0,1))
+10 |> 0.00  0.11  0.22  0.33  0.44  0.56  0.67  0.78  0.89  1.00
+@
+-}
 vecdisp :: (Element t) => (Matrix t -> String) -> Vector t -> String
 vecdisp f v
     = ((show (dim v) ++ " |> ") ++) . (++"\n")