documentation

3 files changed, 28 insertions, 18 deletions

diff --git a/packages/base/CHANGELOG b/packages/base/CHANGELOG
index 0336a28..5b0adc1 100644
--- a/packages/base/CHANGELOG
+++ b/packages/base/CHANGELOG
@@ -1,24 +1,32 @@
 0.17.0.0
 --------
 
-    * improved matrix extraction (??) and rectangular matrix slices without data copy
+    * eigSH, chol, and other functions that work with Hermitian or symmetric matrices
+      now take a special "Sym" argument that can be created by means of "sym"
+      or "mTm". The unchecked versions of those functions have been removed and we
+      use "trustSym" to create the Sym type when the matrix is known to be Hermitian/symmetric.
+
+    * Improved matrix extraction (??) and rectangular matrix slices without data copy
+
+    * Basic support of Int32 and Int64 elements
 
-    * basic support of Int32 and Int64 elements
-    
     * remap, more general cond, sortIndex
 
-    * experimental support of type safe modular arithmetic, including linear
-      systems and lu factorization
-    
-    * elementary row operations and inplace matrix slice products in the ST monad
+    * Experimental support of type safe modular arithmetic, including linear
+      system solver and LU factorization
+
+    * Elementary row operations and inplace matrix slice products in the ST monad
 
     * Improved development tools.
 
-    * old compatibility modules removed, simpler organization of internal modules
+    * Old compatibility modules removed, simpler organization of internal modules
 
     * unitary, pairwiseD2, tr'
 
-    * ldlPacked, ldlSolve
+    * ldlPacked, ldlSolve for indefinite symmetric systems (apparently not faster
+      than the general solver based on the LU)
+
+    * LU, LDL, and QR types for these compact decompositions.
 
 0.16.1.0
 --------
diff --git a/packages/base/hmatrix.cabal b/packages/base/hmatrix.cabal
index 7b25349..31bea3e 100644
--- a/packages/base/hmatrix.cabal
+++ b/packages/base/hmatrix.cabal
@@ -9,9 +9,9 @@ Homepage:           https://github.com/albertoruiz/hmatrix
 Synopsis:           Numeric Linear Algebra
 Description:        Linear systems, matrix decompositions, and other numerical computations based on BLAS and LAPACK.
                     .
-                    The standard interface is provided by the module "Numeric.LinearAlgebra".
+                    Standard interface: "Numeric.LinearAlgebra".
                     .
-                    A safer interface with statically checked dimensions is provided by "Numeric.LinearAlgebra.Static".
+                    Safer interface with statically checked dimensions: "Numeric.LinearAlgebra.Static".
                     .
                     Code examples: <http://dis.um.es/~alberto/hmatrix/hmatrix.html>
 
diff --git a/packages/base/src/Numeric/LinearAlgebra.hs b/packages/base/src/Numeric/LinearAlgebra.hs
index a1c0158..ea54932 100644
--- a/packages/base/src/Numeric/LinearAlgebra.hs
+++ b/packages/base/src/Numeric/LinearAlgebra.hs
@@ -35,8 +35,9 @@ module Numeric.LinearAlgebra (
 
     -- * Autoconformable dimensions
     -- |
-    -- In arithmetic operations single-element vectors and matrices
-    -- (created from numeric literals or using 'scalar') automatically
+    -- In most operations, single-element vectors and matrices
+    -- (created from numeric literals or using 'scalar'), and matrices
+    -- with just one row or column, automatically
     -- expand to match the dimensions of the other operand:
     --
     -- >>> 5 + 2*ident 3 :: Matrix Double
@@ -45,11 +46,12 @@ module Numeric.LinearAlgebra (
     --  , 5.0, 7.0, 5.0
     --  , 5.0, 5.0, 7.0 ]
     --
-    -- >>> matrix 3 [1..9] + matrix 1 [10,20,30]
-    -- (3><3)
-    --  [ 11.0, 12.0, 13.0
-    --  , 24.0, 25.0, 26.0
-    --  , 37.0, 38.0, 39.0 ]
+    -- >>> (4><3) [1..] + row [10,20,30]
+    -- (4><3)
+    --  [ 11.0, 22.0, 33.0
+    --  , 14.0, 25.0, 36.0
+    --  , 17.0, 28.0, 39.0
+    --  , 20.0, 31.0, 42.0 ]
     --
 
     -- * Products