change names: Herm, unSym, mTm, and rnf instances

5 files changed, 43 insertions, 40 deletions

diff --git a/packages/base/CHANGELOG b/packages/base/CHANGELOG
index 5b0adc1..581d2ac 100644
--- a/packages/base/CHANGELOG
+++ b/packages/base/CHANGELOG
@@ -2,9 +2,9 @@
 --------
 
     * 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"
+      now take a special "Herm" 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.
+      use "trustSym" to create the Herm type when the matrix is known to be Hermitian/symmetric.
 
     * Improved matrix extraction (??) and rectangular matrix slices without data copy
 
diff --git a/packages/base/src/Internal/Algorithms.hs b/packages/base/src/Internal/Algorithms.hs
index ee3ddff..c4f1a60 100644
--- a/packages/base/src/Internal/Algorithms.hs
+++ b/packages/base/src/Internal/Algorithms.hs
@@ -4,12 +4,6 @@
 {-# LANGUAGE UndecidableInstances #-}
 {-# LANGUAGE TypeFamilies #-}
 
-{-# LANGUAGE FlexibleContexts, FlexibleInstances #-}
-{-# LANGUAGE CPP #-}
-{-# LANGUAGE MultiParamTypeClasses #-}
-{-# LANGUAGE UndecidableInstances #-}
-{-# LANGUAGE TypeFamilies #-}
-
 -----------------------------------------------------------------------------
 {- |
 Module      :  Internal.Algorithms
@@ -376,8 +370,8 @@ ldlPackedSH x = {-# SCC "ldlPacked" #-} LDL m p
    (m,p) = ldlPacked' x
 
 -- | Obtains the LDL decomposition of a matrix in a compact data structure suitable for 'ldlSolve'.
-ldlPacked :: Field t => Her t -> LDL t
-ldlPacked (Her m) = ldlPackedSH m
+ldlPacked :: Field t => Herm t -> LDL t
+ldlPacked (Herm m) = ldlPackedSH m
 
 -- | Solution of a linear system (for several right hand sides) from a precomputed LDL factorization obtained by 'ldlPacked'.
 --
@@ -461,18 +455,23 @@ fromList [11.344814282762075,0.17091518882717918,-0.5157294715892575]
 3.000  5.000  6.000
 
 -}
-eigSH :: Field t => Her t -> (Vector Double, Matrix t)
-eigSH (Her m) = eigSH' m
+eigSH :: Field t => Herm t -> (Vector Double, Matrix t)
+eigSH (Herm m) = eigSH' m
 
 -- | Eigenvalues (in descending order) of a complex hermitian or real symmetric matrix.
-eigenvaluesSH :: Field t => Her t -> Vector Double
-eigenvaluesSH (Her m) = eigenvaluesSH' m
+eigenvaluesSH :: Field t => Herm t -> Vector Double
+eigenvaluesSH (Herm m) = eigenvaluesSH' m
 
 --------------------------------------------------------------
 
 -- | QR decomposition of a matrix in compact form. (The orthogonal matrix is not explicitly formed.)
 data QR t = QR (Matrix t) (Vector t)
 
+instance (NFData t, Numeric t) => NFData (QR t)
+  where
+    rnf (QR m _) = rnf m
+
+
 -- | QR factorization.
 --
 -- If @(q,r) = qr m@ then @m == q \<> r@, where q is unitary and r is upper triangular.
@@ -533,12 +532,12 @@ cholSH = cholSH'
 -- | Cholesky factorization of a positive definite hermitian or symmetric matrix.
 --
 -- If @c = chol m@ then @c@ is upper triangular and @m == tr c \<> c@.
-chol :: Field t => Her t ->  Matrix t
-chol (Her m) = {-# SCC "chol" #-} cholSH' m
+chol :: Field t => Herm t ->  Matrix t
+chol (Herm m) = {-# SCC "chol" #-} cholSH' m
 
 -- | Similar to 'chol', but instead of an error (e.g., caused by a matrix not positive definite) it returns 'Nothing'.
-mbChol :: Field t => Her t -> Maybe (Matrix t)
-mbChol (Her m) = {-# SCC "mbChol" #-} mbCholSH' m
+mbChol :: Field t => Herm t -> Maybe (Matrix t)
+mbChol (Herm m) = {-# SCC "mbChol" #-} mbCholSH' m
 
 
 
@@ -977,10 +976,10 @@ relativeError norm a b = r
 -- | Generalized symmetric positive definite eigensystem Av = lBv,
 -- for A and B symmetric, B positive definite.
 geigSH :: Field t
-        => Her t -- ^ A
-        -> Her t -- ^ B
+        => Herm t -- ^ A
+        -> Herm t -- ^ B
         -> (Vector Double, Matrix t)
-geigSH (Her a) (Her b) = geigSH' a b
+geigSH (Herm a) (Herm b) = geigSH' a b
 
 geigSH' :: Field t
         => Matrix t -- ^ A
@@ -999,29 +998,33 @@ geigSH' a b = (l,v')
 
 -- | A matrix that, by construction, it is known to be complex Hermitian or real symmetric.
 --
---   It can be created using 'sym', 'xTx', or 'trustSym', and the matrix can be extracted using 'her'.
-data Her t = Her (Matrix t) deriving Show
+--   It can be created using 'sym', 'mTm', or 'trustSym', and the matrix can be extracted using 'unSym'.
+newtype Herm t = Herm (Matrix t) deriving Show
+
+instance (NFData t, Numeric t) => NFData (Herm t)
+  where
+    rnf (Herm m) = rnf m
 
--- | Extract the general matrix from a 'Her' structure, forgetting its symmetric or Hermitian property.
-her :: Her t -> Matrix t
-her (Her x) = x
+-- | Extract the general matrix from a 'Herm' structure, forgetting its symmetric or Hermitian property.
+unSym :: Herm t -> Matrix t
+unSym (Herm x) = x
 
 -- | Compute the complex Hermitian or real symmetric part of a square matrix (@(x + tr x)/2@).
-sym :: Field t => Matrix t -> Her t
-sym x = Her (scale 0.5 (tr x `add` x))
+sym :: Field t => Matrix t -> Herm t
+sym x = Herm (scale 0.5 (tr x `add` x))
 
 -- | Compute the contraction @tr x <> x@ of a general matrix.
-xTx :: Numeric t => Matrix t -> Her t
-xTx x = Her (tr x `mXm` x)
+mTm :: Numeric t => Matrix t -> Herm t
+mTm x = Herm (tr x `mXm` x)
 
-instance Field t => Linear t Her where
-    scale  x (Her m) = Her (scale x m)
+instance Field t => Linear t Herm where
+    scale  x (Herm m) = Herm (scale x m)
 
-instance Field t => Additive (Her t) where
-    add    (Her a) (Her b) = Her (a `add` b)
+instance Field t => Additive (Herm t) where
+    add (Herm a) (Herm b) = Herm (a `add` b)
 
 -- | At your own risk, declare that a matrix is complex Hermitian or real symmetric
 --   for usage in 'chol', 'eigSH', etc. Only a triangular part of the matrix will be used.
-trustSym :: Matrix t -> Her t
-trustSym x = (Her x)
+trustSym :: Matrix t -> Herm t
+trustSym x = (Herm x)
 
diff --git a/packages/base/src/Internal/Util.hs b/packages/base/src/Internal/Util.hs
index 36b7855..cf42961 100644
--- a/packages/base/src/Internal/Util.hs
+++ b/packages/base/src/Internal/Util.hs
@@ -462,7 +462,7 @@ null1 :: Matrix R -> Vector R
 null1 = last . toColumns . snd . rightSV
 
 -- | solution of overconstrained homogeneous symmetric linear system
-null1sym :: Her R -> Vector R
+null1sym :: Herm R -> Vector R
 null1sym = last . toColumns . snd . eigSH
 
 --------------------------------------------------------------------------------
diff --git a/packages/base/src/Numeric/LinearAlgebra.hs b/packages/base/src/Numeric/LinearAlgebra.hs
index ea54932..6a9c33a 100644
--- a/packages/base/src/Numeric/LinearAlgebra.hs
+++ b/packages/base/src/Numeric/LinearAlgebra.hs
@@ -154,9 +154,9 @@ module Numeric.LinearAlgebra (
     -- * Misc
     meanCov, rowOuters, pairwiseD2, unitary, peps, relativeError, magnit,
     haussholder, optimiseMult, udot, nullspaceSVD, orthSVD, ranksv,
-    iC, sym, xTx, trustSym, her,
+    iC, sym, mTm, trustSym, unSym,
     -- * Auxiliary classes
-    Element, Container, Product, Numeric, LSDiv, Her,
+    Element, Container, Product, Numeric, LSDiv, Herm,
     Complexable, RealElement,
     RealOf, ComplexOf, SingleOf, DoubleOf,
     IndexOf,
diff --git a/packages/base/src/Numeric/LinearAlgebra/Static.hs b/packages/base/src/Numeric/LinearAlgebra/Static.hs
index ded69fa..843c727 100644
--- a/packages/base/src/Numeric/LinearAlgebra/Static.hs
+++ b/packages/base/src/Numeric/LinearAlgebra/Static.hs
@@ -65,7 +65,7 @@ import Numeric.LinearAlgebra hiding (
     row,col,vector,matrix,linspace,toRows,toColumns,
     (<\>),fromList,takeDiag,svd,eig,eigSH,
     eigenvalues,eigenvaluesSH,build,
-    qr,size,dot,chol,range,R,C,Her,her,sym)
+    qr,size,dot,chol,range,R,C,sym,mTm,unSym)
 import qualified Numeric.LinearAlgebra as LA
 import Data.Proxy(Proxy)
 import Internal.Static