1 files changed, 31 insertions, 12 deletions

diff --git a/lib/Numeric/HMatrix.hs b/lib/Numeric/HMatrix.hs
index 8e0b4a2..a2f09df 100644
--- a/lib/Numeric/HMatrix.hs
+++ b/lib/Numeric/HMatrix.hs
@@ -16,25 +16,45 @@ module Numeric.HMatrix (
     -- * Basic types and data processing    
     module Numeric.HMatrix.Data,
     
-    -- | The standard numeric classes are defined elementwise.
+    -- | The standard numeric classes are defined elementwise:
     --
     -- >>> fromList [1,2,3] * fromList [3,0,-2 :: Double]
     -- fromList [3.0,0.0,-6.0]
     -- 
-    -- In arithmetic operations single-element vectors and matrices automatically
-    -- expand to match the dimensions of the other operand.
+    -- >>> (3><3) [1..9] * ident 3 :: Matrix Double
+    -- (3><3)
+    --  [ 1.0, 0.0, 0.0
+    --  , 0.0, 5.0, 0.0
+    --  , 0.0, 0.0, 9.0 ]
+    --
+    -- In arithmetic operations single-element vectors and matrices
+    -- (created from numeric literals or using 'scalar') automatically
+    -- expand to match the dimensions of the other operand:
     -- 
-    -- >>> 2 * ident 3
-    -- 2 * ident 3 :: Matrix Double
+    -- >>> 5 + 2*ident 3 :: Matrix Double
     -- (3><3)
-    -- [ 2.0, 0.0, 0.0
-    -- , 0.0, 2.0, 0.0
-    -- , 0.0, 0.0, 2.0 ]
+    --  [ 7.0, 5.0, 5.0
+    --  , 5.0, 7.0, 5.0
+    --  , 5.0, 5.0, 7.0 ]
     --
 
     -- * Products
-    (<>), (·), outer, kronecker, cross,
-    optimiseMult, scale,
+    (×),
+    
+    -- | The matrix product is also implemented in the "Data.Monoid" instance for Matrix, where
+    -- single-element matrices (created from numeric literals or using 'scalar')
+    -- are used for scaling.
+    --
+    -- >>> let m = (2><3)[1..] :: Matrix Double
+    -- >>> m <> 2 <> diagl[0.5,1,0]
+    -- (2><3)
+    -- [ 1.0,  4.0, 0.0
+    -- , 4.0, 10.0, 0.0 ]
+    --
+    -- mconcat uses 'optimiseMult' to get the optimal association order.
+ 
+    (·), outer, kronecker, cross,
+    scale,
     sumElements, prodElements, absSum,
     
     -- * Linear Systems
@@ -103,7 +123,7 @@ module Numeric.HMatrix (
     rand, randn, RandDist(..), randomVector, gaussianSample, uniformSample,
     
     -- * Misc
-    meanCov, peps, relativeError, haussholder
+    meanCov, peps, relativeError, haussholder, optimiseMult, udot, cdot, mmul
 ) where
 
 import Numeric.HMatrix.Data
@@ -114,4 +134,3 @@ import Numeric.Container
 import Numeric.LinearAlgebra.Algorithms
 import Numeric.LinearAlgebra.Util
 
-