improved documentation

4 files changed, 62 insertions, 23 deletions

diff --git a/lib/Numeric/LinearAlgebra/Algorithms.hs b/lib/Numeric/LinearAlgebra/Algorithms.hs
index 7223cd9..7c1c032 100644
--- a/lib/Numeric/LinearAlgebra/Algorithms.hs
+++ b/lib/Numeric/LinearAlgebra/Algorithms.hs
@@ -371,19 +371,21 @@ pinv = pinvTol 1
 
 {- | @pinvTol r@ computes the pseudoinverse of a matrix with tolerance @tol=r*g*eps*(max rows cols)@, where g is the greatest singular value.
 
-@\> let m = 'fromLists' [[1,0,    0]
-                    ,[0,1,    0]
-                    ,[0,0,1e-10]]
-\  --
-\> 'pinv' m
+@
+m = (3><3) [ 1, 0,    0
+           , 0, 1,    0
+           , 0, 0, 1e-10] :: Matrix Double
+@
+
+>>> pinv m
 1. 0.           0.
 0. 1.           0.
 0. 0. 10000000000.
-\  --
-\> pinvTol 1E8 m
+
+>>> pinvTol 1E8 m
 1. 0. 0.
 0. 1. 0.
-0. 0. 1.@
+0. 0. 1.
 
 -}
 
@@ -598,10 +600,11 @@ It only works with invertible matrices that have a real solution. For diagonaliz
 @m = (2><2) [4,9
            ,0,4] :: Matrix Double@
 
-@\>sqrtm m
+>>> sqrtm m
 (2><2)
  [ 2.0, 2.25
- , 0.0,  2.0 ]@
+ , 0.0,  2.0 ]
+
 -}
 sqrtm ::  Field t => Matrix t -> Matrix t
 sqrtm = sqrtmInv
diff --git a/lib/Numeric/LinearAlgebra/Data.hs b/lib/Numeric/LinearAlgebra/Data.hs
index 6e5dcef..a3639d5 100644
--- a/lib/Numeric/LinearAlgebra/Data.hs
+++ b/lib/Numeric/LinearAlgebra/Data.hs
@@ -12,6 +12,8 @@ Stability   :  provisional
 
 module Numeric.LinearAlgebra.Data(
     -- * Vector
+    -- | 1D arrays are storable vectors from the vector package.
+    
     Vector, (|>), dim, (@>),
     
     -- * Matrix
@@ -49,13 +51,13 @@ module Numeric.LinearAlgebra.Data(
 
     -- * Products
     
-    (<>), (·), scale, outer, kronecker, cross,
+    (<>), (·), outer, kronecker, cross,
     sumElements, prodElements, absSum,
     optimiseMult,
     
     corr, conv, corrMin, corr2, conv2,
     
-    LSDiv(..),
+    (<\>),
     
     -- * Random arrays
 
@@ -80,7 +82,8 @@ module Numeric.LinearAlgebra.Data(
     module Data.Complex,
 
     -- * Misc
-    meanCov, arctan2,
+    scale, meanCov, arctan2,
+    rows, cols,
     separable,
     fromArray2D
 
diff --git a/lib/Numeric/LinearAlgebra/Data/Devel.hs b/lib/Numeric/LinearAlgebra/Data/Devel.hs
index 6358d1f..88c980c 100644
--- a/lib/Numeric/LinearAlgebra/Data/Devel.hs
+++ b/lib/Numeric/LinearAlgebra/Data/Devel.hs
@@ -51,13 +51,13 @@ module Numeric.LinearAlgebra.Data.Devel(
     liftMatrix, liftMatrix2, liftMatrix2Auto,
 
     -- * Misc
-    Element, Container
+    Element, Container, Product, Contraction, LSDiv
 ) where
 
 import Data.Packed.Foreign
 import Data.Packed.Development
 import Data.Packed.ST
-import Numeric.Container(Container)
+import Numeric.Container(Container,Contraction,LSDiv,Product)
 import Data.Packed
 
 
diff --git a/lib/Numeric/LinearAlgebra/Util.hs b/lib/Numeric/LinearAlgebra/Util.hs
index be01bc1..21b6188 100644
--- a/lib/Numeric/LinearAlgebra/Util.hs
+++ b/lib/Numeric/LinearAlgebra/Util.hs
@@ -13,7 +13,7 @@ Stability   :  provisional
 {-# OPTIONS_HADDOCK hide #-}
 
 module Numeric.LinearAlgebra.Util(
-    
+
     -- * Convenience functions
     size, disp,
     zeros, ones,
@@ -65,8 +65,16 @@ import Numeric.LinearAlgebra.Util.Convolution
 import Graphics.Plot
 
 
+{- | print a real matrix with given number of digits after the decimal point
+
+>>> disp 5 $ ident 2 / 3
+2x2
+0.33333  0.00000
+0.00000  0.33333
+
+-}
 disp :: Int -> Matrix Double -> IO ()
--- ^ show a matrix with given number of digits after the decimal point
+
 disp n = putStrLn . dispf n
 
 -- | pseudorandom matrix with uniform elements between 0 and 1
@@ -82,7 +90,16 @@ randm d r c = do
 rand :: Int -> Int -> IO (Matrix Double)
 rand = randm Uniform
 
--- | pseudorandom matrix with normal elements
+{- | pseudorandom matrix with normal elements
+
+>>> x <- randn 3 5
+>>> disp 3 x
+3x5
+0.386  -1.141   0.491  -0.510   1.512
+0.069  -0.919   1.022  -0.181   0.745
+0.313  -0.670  -0.097  -1.575  -0.583
+
+-}
 randn :: Int -> Int -> IO (Matrix Double)
 randn = randm Gaussian
 
@@ -115,9 +132,17 @@ infixl 3 &
 (&) :: Vector Double -> Vector Double -> Vector Double
 a & b = vjoin [a,b]
 
--- | horizontal concatenation of real matrices
---
--- (0x00a6 broken bar)
+{- | horizontal concatenation of real matrices
+
+ (0x00a6 broken bar)
+
+>>> ident 3 ¦ konst 7 (3,4)
+(3><7)
+ [ 1.0, 0.0, 0.0, 7.0, 7.0, 7.0, 7.0
+ , 0.0, 1.0, 0.0, 7.0, 7.0, 7.0, 7.0
+ , 0.0, 0.0, 1.0, 7.0, 7.0, 7.0, 7.0 ]
+
+-}
 infixl 3 ¦
 (¦) :: Matrix Double -> Matrix Double -> Matrix Double
 a ¦ b = fromBlocks [[a,b]]
@@ -141,7 +166,15 @@ row = asRow . fromList
 col :: [Double] -> Matrix Double
 col = asColumn . fromList
 
--- | extract selected rows
+{- | extract selected rows
+
+>>> (20><4) [1..] ? [2,1,1]
+(3><4)
+ [ 9.0, 10.0, 11.0, 12.0
+ , 5.0,  6.0,  7.0,  8.0
+ , 5.0,  6.0,  7.0,  8.0 ]
+
+-}
 infixl 9 ?
 (?) :: Element t => Matrix t -> [Int] -> Matrix t
 (?) = flip extractRows
@@ -172,7 +205,7 @@ norm = pnorm PNorm2
 unitary :: Vector Double -> Vector Double
 unitary v = v / scalar (norm v)
 
--- | (rows &&& cols)
+-- | ('rows' &&& 'cols')
 size :: Matrix t -> (Int, Int)
 size m = (rows m, cols m)