documentation

4 files changed, 31 insertions, 13 deletions

diff --git a/packages/base/src/Numeric/LinearAlgebra.hs b/packages/base/src/Numeric/LinearAlgebra.hs
index dd4cc67..9cab635 100644
--- a/packages/base/src/Numeric/LinearAlgebra.hs
+++ b/packages/base/src/Numeric/LinearAlgebra.hs
@@ -8,11 +8,16 @@ License     :  BSD3
 Maintainer  :  Alberto Ruiz
 Stability   :  provisional
 
+
 -}
 -----------------------------------------------------------------------------
 module Numeric.LinearAlgebra (
 
-    -- * Basic types and data processing
+    -- * Basic Types and data manipulation
+    -- | This package works with 2D ('Matrix') and 1D ('Vector')
+    -- arrays of real ('R') or complex ('C') double precision numbers.
+    -- Single precision and machine integers are also supported for
+    -- basic arithmetic and data manipulation.
     module Numeric.LinearAlgebra.Data,
 
     -- * Numeric classes
@@ -51,9 +56,9 @@ module Numeric.LinearAlgebra (
     -- ** dot
     dot, (<.>),
     -- ** matrix-vector
-    app, (#>), (<#), (!#>),
+    (#>), (<#), (!#>),
     -- ** matrix-matrix
-    mul, (<>),
+    (<>),
     -- | The matrix product is also implemented in the "Data.Monoid" instance, where
     -- single-element matrices (created from numeric literals or using 'scalar')
     -- are used for scaling.
@@ -172,7 +177,7 @@ import Internal.Sparse((!#>))
 import Internal.CG
 import Internal.Conversion
 
-{- | infix synonym of 'mul'
+{- | dense matrix product
 
 >>> let a = (3><5) [1..]
 >>> a
diff --git a/packages/base/src/Numeric/LinearAlgebra/Data.hs b/packages/base/src/Numeric/LinearAlgebra/Data.hs
index d2843c2..a389aac 100644
--- a/packages/base/src/Numeric/LinearAlgebra/Data.hs
+++ b/packages/base/src/Numeric/LinearAlgebra/Data.hs
@@ -8,21 +8,29 @@ License     :  BSD3
 Maintainer  :  Alberto Ruiz
 Stability   :  provisional
 
-Basic data processing.
+This module provides functions for creation and manipulation of vectors and matrices, IO, and other utilities.
 
 -}
 --------------------------------------------------------------------------------
 
 module Numeric.LinearAlgebra.Data(
 
+    -- * Elements
+    R,C,I,Z,type(./.),
+
     -- * Vector
-    -- | 1D arrays are storable vectors from the vector package. There is no distinction
-    --   between row and column vectors.
+    {- | 1D arrays are storable vectors directly reexported from the vector package.
+    -}
 
     fromList, toList, (|>), vector, range, idxs,
 
     -- * Matrix
 
+    {- | The main data type of hmatrix is a 2D dense array defined on top of
+         a storable vector. The internal representation is suitable for direct
+         interface with standard numeric libraries.
+    -}
+
     (><), matrix, tr, tr',
 
     -- * Dimensions
@@ -56,8 +64,9 @@ module Numeric.LinearAlgebra.Data(
     -- * Matrix extraction
     Extractor(..), (??),
 
-    takeRows, dropRows, takeColumns, dropColumns,
-    subMatrix, (?), (¿), fliprl, flipud,
+    (?), (¿), fliprl, flipud,
+
+    subMatrix, takeRows, dropRows, takeColumns, dropColumns,
 
     remap,
 
@@ -92,7 +101,7 @@ module Numeric.LinearAlgebra.Data(
     separable,
     fromArray2D,
     module Data.Complex,
-    R,C,I,Z,Mod, type(./.),
+    Mod,
     Vector, Matrix, GMatrix, nRows, nCols
 
 ) where
diff --git a/packages/base/src/Numeric/LinearAlgebra/HMatrix.hs b/packages/base/src/Numeric/LinearAlgebra/HMatrix.hs
index 8adaaaf..bac1c0c 100644
--- a/packages/base/src/Numeric/LinearAlgebra/HMatrix.hs
+++ b/packages/base/src/Numeric/LinearAlgebra/HMatrix.hs
@@ -13,7 +13,7 @@ compatibility with previous version, to be removed
 
 module Numeric.LinearAlgebra.HMatrix (
     module Numeric.LinearAlgebra,
-    (¦),(——),ℝ,ℂ,(<·>)
+    (¦),(——),ℝ,ℂ,(<·>),app,mul
 ) where
 
 import Numeric.LinearAlgebra
@@ -23,3 +23,7 @@ infixr 8 <·>
 (<·>) :: Numeric t => Vector t -> Vector t -> t
 (<·>) = dot
 
+app m v = m #> v
+
+mul a b = a <> b
+
diff --git a/packages/base/src/Numeric/LinearAlgebra/Static.hs b/packages/base/src/Numeric/LinearAlgebra/Static.hs
index d0a790d..0dab0e6 100644
--- a/packages/base/src/Numeric/LinearAlgebra/Static.hs
+++ b/packages/base/src/Numeric/LinearAlgebra/Static.hs
@@ -22,7 +22,7 @@ Stability   :  experimental
 
 Experimental interface with statically checked dimensions.
 
-This module is under active development and the interface is subject to changes.
+See code examples at http://dis.um.es/~alberto/hmatrix/static.html.
 
 -}
 
@@ -65,7 +65,7 @@ import Numeric.LinearAlgebra hiding (
     row,col,vector,matrix,linspace,toRows,toColumns,
     (<\>),fromList,takeDiag,svd,eig,eigSH,eigSH',
     eigenvalues,eigenvaluesSH,eigenvaluesSH',build,
-    qr,size,app,mul,dot,chol,range,R,C)
+    qr,size,dot,chol,range,R,C)
 import qualified Numeric.LinearAlgebra as LA
 import Data.Proxy(Proxy)
 import Internal.Static