documentation

4 files changed, 7 insertions, 7 deletions

diff --git a/packages/base/src/Internal/Algorithms.hs b/packages/base/src/Internal/Algorithms.hs
index c8b2d3e..99c90aa 100644
--- a/packages/base/src/Internal/Algorithms.hs
+++ b/packages/base/src/Internal/Algorithms.hs
@@ -470,14 +470,14 @@ rq m =  {-# SCC "rq" #-} (r,q) where
 
 -- | Hessenberg factorization.
 --
--- If @(p,h) = hess m@ then @m == p \<> h \<> ctrans p@, where p is unitary
+-- If @(p,h) = hess m@ then @m == p \<> h \<> tr p@, where p is unitary
 -- and h is in upper Hessenberg form (it has zero entries below the first subdiagonal).
 hess        :: Field t => Matrix t -> (Matrix t, Matrix t)
 hess = hess'
 
 -- | Schur factorization.
 --
--- If @(u,s) = schur m@ then @m == u \<> s \<> ctrans u@, where u is unitary
+-- If @(u,s) = schur m@ then @m == u \<> s \<> tr u@, where u is unitary
 -- and s is a Shur matrix. A complex Schur matrix is upper triangular. A real Schur matrix is
 -- upper triangular in 2x2 blocks.
 --
@@ -497,7 +497,7 @@ cholSH = {-# SCC "cholSH" #-} cholSH'
 
 -- | Cholesky factorization of a positive definite hermitian or symmetric matrix.
 --
--- If @c = chol m@ then @c@ is upper triangular and @m == ctrans c \<> c@.
+-- If @c = chol m@ then @c@ is upper triangular and @m == tr c \<> c@.
 chol :: Field t => Matrix t ->  Matrix t
 chol m | exactHermitian m = cholSH m
        | otherwise = error "chol requires positive definite complex hermitian or real symmetric matrix"
diff --git a/packages/base/src/Internal/Container.hs b/packages/base/src/Internal/Container.hs
index 8926fac..307c6a8 100644
--- a/packages/base/src/Internal/Container.hs
+++ b/packages/base/src/Internal/Container.hs
@@ -72,7 +72,7 @@ infixr 8 <.>
 
 
 
-{- | infix synonym for 'app'
+{- | dense matrix-vector product
 
 >>> let m = (2><3) [1..]
 >>> m
diff --git a/packages/base/src/Internal/Element.hs b/packages/base/src/Internal/Element.hs
index 6d86f3d..a459678 100644
--- a/packages/base/src/Internal/Element.hs
+++ b/packages/base/src/Internal/Element.hs
@@ -325,9 +325,9 @@ takeDiag m = fromList [flatten m @> (k*cols m+k) | k <- [0 .. min (rows m) (cols
 
 ------------------------------------------------------------
 
-{- | create a general matrix
+{- | Create a matrix from a list of elements
 
->>> (2><3) [2, 4, 7+2*𝑖,   -3, 11, 0]
+>>> (2><3) [2, 4, 7+2*iC,   -3, 11, 0]
 (2><3)
  [       2.0 :+ 0.0,  4.0 :+ 0.0, 7.0 :+ 2.0
  , (-3.0) :+ (-0.0), 11.0 :+ 0.0, 0.0 :+ 0.0 ]
diff --git a/packages/base/src/Internal/Vector.hs b/packages/base/src/Internal/Vector.hs
index 29b6797..de4e670 100644
--- a/packages/base/src/Internal/Vector.hs
+++ b/packages/base/src/Internal/Vector.hs
@@ -127,7 +127,7 @@ n |> l
     l' = take n l
 
 
--- | Create a vector of indexes, useful for matrix extraction using '??'
+-- | Create a vector of indexes, useful for matrix extraction using '(??)'
 idxs :: [Int] -> Vector I
 idxs js = fromList (map fromIntegral js) :: Vector I