diff options
author | Alberto Ruiz <aruiz@um.es> | 2015-07-13 12:00:09 +0200 |
---|---|---|
committer | Alberto Ruiz <aruiz@um.es> | 2015-07-13 12:00:09 +0200 |
commit | a3b28fdf0b6a335b4905c25413cf82438383319e (patch) | |
tree | af1bc27333e57b426858005b5f6dd1358b5d0c0f /packages/base/src/Numeric | |
parent | b4873dbd201e0e887fb9cb5b5fe55774fa6fbe78 (diff) |
minor doc changes
Diffstat (limited to 'packages/base/src/Numeric')
-rw-r--r-- | packages/base/src/Numeric/LinearAlgebra.hs | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/packages/base/src/Numeric/LinearAlgebra.hs b/packages/base/src/Numeric/LinearAlgebra.hs index 9cab635..9a924e0 100644 --- a/packages/base/src/Numeric/LinearAlgebra.hs +++ b/packages/base/src/Numeric/LinearAlgebra.hs | |||
@@ -13,7 +13,7 @@ Stability : provisional | |||
13 | ----------------------------------------------------------------------------- | 13 | ----------------------------------------------------------------------------- |
14 | module Numeric.LinearAlgebra ( | 14 | module Numeric.LinearAlgebra ( |
15 | 15 | ||
16 | -- * Basic Types and data manipulation | 16 | -- * Basic types and data manipulation |
17 | -- | This package works with 2D ('Matrix') and 1D ('Vector') | 17 | -- | This package works with 2D ('Matrix') and 1D ('Vector') |
18 | -- arrays of real ('R') or complex ('C') double precision numbers. | 18 | -- arrays of real ('R') or complex ('C') double precision numbers. |
19 | -- Single precision and machine integers are also supported for | 19 | -- Single precision and machine integers are also supported for |
@@ -78,7 +78,7 @@ module Numeric.LinearAlgebra ( | |||
78 | scale, | 78 | scale, |
79 | sumElements, prodElements, | 79 | sumElements, prodElements, |
80 | 80 | ||
81 | -- * Linear Systems | 81 | -- * Linear systems |
82 | (<\>), | 82 | (<\>), |
83 | linearSolve, | 83 | linearSolve, |
84 | linearSolveLS, | 84 | linearSolveLS, |
@@ -105,14 +105,14 @@ module Numeric.LinearAlgebra ( | |||
105 | orth, | 105 | orth, |
106 | nullspace, null1, null1sym, | 106 | nullspace, null1, null1sym, |
107 | 107 | ||
108 | -- * SVD | 108 | -- * Singular value decomposition |
109 | svd, | 109 | svd, |
110 | thinSVD, | 110 | thinSVD, |
111 | compactSVD, | 111 | compactSVD, |
112 | singularValues, | 112 | singularValues, |
113 | leftSV, rightSV, | 113 | leftSV, rightSV, |
114 | 114 | ||
115 | -- * Eigensystems | 115 | -- * Eigendecomposition |
116 | eig, eigSH, eigSH', | 116 | eig, eigSH, eigSH', |
117 | eigenvalues, eigenvaluesSH, eigenvaluesSH', | 117 | eigenvalues, eigenvaluesSH, eigenvaluesSH', |
118 | geigSH', | 118 | geigSH', |
@@ -206,10 +206,6 @@ import Internal.Conversion | |||
206 | (<>) = mXm | 206 | (<>) = mXm |
207 | infixr 8 <> | 207 | infixr 8 <> |
208 | 208 | ||
209 | -- | dense matrix product | ||
210 | mul :: Numeric t => Matrix t -> Matrix t -> Matrix t | ||
211 | mul = mXm | ||
212 | |||
213 | 209 | ||
214 | {- | Solve a linear system (for square coefficient matrix and several right-hand sides) using the LU decomposition, returning Nothing for a singular system. For underconstrained or overconstrained systems use 'linearSolveLS' or 'linearSolveSVD'. | 210 | {- | Solve a linear system (for square coefficient matrix and several right-hand sides) using the LU decomposition, returning Nothing for a singular system. For underconstrained or overconstrained systems use 'linearSolveLS' or 'linearSolveSVD'. |
215 | 211 | ||