1 {-# LANGUAGE ExistentialQuantification #-}
2 {-# LANGUAGE FlexibleContexts #-}
3 {-# LANGUAGE FlexibleInstances #-}
4 {-# LANGUAGE MultiParamTypeClasses #-}
5 {-# LANGUAGE NoMonomorphismRestriction #-}
6 {-# LANGUAGE ScopedTypeVariables #-}
7 {-# LANGUAGE TypeFamilies #-}
8 {-# LANGUAGE RebindableSyntax #-}
10 -- | Boxed matrices; that is, boxed m-vectors of boxed n-vectors. We
11 -- assume that the underlying representation is
12 -- Data.Vector.Fixed.Boxed.Vec for simplicity. It was tried in
13 -- generality and failed.
18 import Data.List (intercalate)
20 import Data.Vector.Fixed (
28 import qualified Data.Vector.Fixed as V (
41 import Data.Vector.Fixed.Cont ( Arity, arity )
42 import Linear.Vector ( Vec, delete )
43 import Naturals ( N1, N2, N3, N4, N5, N6, N7, N8, N9, N10, S, Z )
44 import Normed ( Normed(..) )
46 import NumericPrelude hiding ( (*), abs )
47 import qualified NumericPrelude as NP ( (*) )
48 import qualified Algebra.Absolute as Absolute ( C )
49 import Algebra.Absolute ( abs )
50 import qualified Algebra.Additive as Additive ( C )
51 import qualified Algebra.Algebraic as Algebraic ( C )
52 import Algebra.Algebraic ( root )
53 import qualified Algebra.Field as Field ( C )
54 import qualified Algebra.Ring as Ring ( C )
55 import qualified Algebra.Module as Module ( C )
56 import qualified Algebra.RealRing as RealRing ( C )
57 import qualified Algebra.ToRational as ToRational ( C )
58 import qualified Algebra.Transcendental as Transcendental ( C )
59 import qualified Prelude as P ( map )
61 -- | Our main matrix type.
62 data Mat m n a = (Arity m, Arity n) => Mat (Vec m (Vec n a))
64 -- Type synonyms for n-by-n matrices.
65 type Mat1 a = Mat N1 N1 a
66 type Mat2 a = Mat N2 N2 a
67 type Mat3 a = Mat N3 N3 a
68 type Mat4 a = Mat N4 N4 a
69 type Mat5 a = Mat N5 N5 a
70 type Mat6 a = Mat N6 N6 a
71 type Mat7 a = Mat N7 N7 a
73 -- * Type synonyms for 1-by-n row "vectors".
75 -- | Type synonym for row vectors expressed as 1-by-n matrices.
76 type Row n a = Mat N1 n a
78 type Row1 a = Row N1 a
79 type Row2 a = Row N2 a
80 type Row3 a = Row N3 a
81 type Row4 a = Row N4 a
82 type Row5 a = Row N5 a
84 -- * Type synonyms for n-by-1 column "vectors".
86 -- | Type synonym for column vectors expressed as n-by-1 matrices.
87 type Col n a = Mat n N1 a
89 type Col1 a = Col N1 a
90 type Col2 a = Col N2 a
91 type Col3 a = Col N3 a
92 type Col4 a = Col N4 a
93 type Col5 a = Col N5 a
94 type Col6 a = Col N6 a
95 type Col7 a = Col N7 a
96 type Col8 a = Col N8 a
97 type Col9 a = Col N9 a
98 type Col10 a = Col N10 a -- We need a big column for Gaussian quadrature.
101 instance (Eq a) => Eq (Mat m n a) where
102 -- | Compare a row at a time.
106 -- >>> let m1 = fromList [[1,2],[3,4]] :: Mat2 Int
107 -- >>> let m2 = fromList [[1,2],[3,4]] :: Mat2 Int
108 -- >>> let m3 = fromList [[5,6],[7,8]] :: Mat2 Int
114 (Mat rows_one) == (Mat rows_two) =
115 V.and $ V.zipWith comp rows_one rows_two
117 -- Compare a row, one column at a time.
118 comp row1 row2 = V.and (V.zipWith (==) row1 row2)
121 instance (Show a) => Show (Mat m n a) where
122 -- | Display matrices and vectors as ordinary tuples. This is poor
123 -- practice, but these results are primarily displayed
124 -- interactively and convenience trumps correctness (said the guy
125 -- who insists his vector lengths be statically checked at
130 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
135 "(" ++ (intercalate "," (V.toList row_strings)) ++ ")"
137 row_strings = V.map show_vector rows
139 "(" ++ (intercalate "," element_strings) ++ ")"
142 element_strings = P.map show v1l
145 -- | Convert a matrix to a nested list.
146 toList :: Mat m n a -> [[a]]
147 toList (Mat rows) = map V.toList (V.toList rows)
150 -- | Create a matrix from a nested list.
151 fromList :: (Arity m, Arity n) => [[a]] -> Mat m n a
152 fromList vs = Mat (V.fromList $ map V.fromList vs)
155 -- | Unsafe indexing. Much faster than the safe indexing.
156 (!!!) :: (Arity m, Arity n) => Mat m n a -> (Int, Int) -> a
157 (!!!) (Mat rows) (i, j) = (rows ! i) ! j
164 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
192 (!!?) :: (Arity m, Arity n) => Mat m n a -> (Int, Int) -> Maybe a
194 ifoldl2 f Nothing matrix
196 f k l found cur = if (k,l) == idx then (Just cur) else found
199 -- | The number of rows in the matrix.
200 nrows :: forall m n a. (Arity m) => Mat m n a -> Int
201 nrows _ = arity (undefined :: m)
204 -- | The number of columns in the first row of the
205 -- matrix. Implementation stolen from Data.Vector.Fixed.length.
206 ncols :: forall m n a. (Arity n) => Mat m n a -> Int
207 ncols _ = arity (undefined :: n)
210 -- | Return the @i@th row of @m@ as a matrix. Unsafe.
211 row :: (Arity m, Arity n) => Mat m n a -> Int -> Row n a
215 lambda _ j = m !!! (i, j)
218 -- | Return the @j@th column of @m@ as a matrix. Unsafe.
219 column :: (Arity m, Arity n) => Mat m n a -> Int -> Col m a
223 lambda i _ = m !!! (i, j)
226 -- | Transpose @m@; switch it's columns and its rows. This is a dirty
227 -- implementation, but I don't see a better way.
229 -- TODO: Don't cheat with fromList.
233 -- >>> let m = fromList [[1,2], [3,4]] :: Mat2 Int
237 transpose :: (Arity m, Arity n) => Mat m n a -> Mat n m a
241 lambda i j = matrix !!! (j,i)
244 -- | Is @m@ symmetric?
248 -- >>> let m1 = fromList [[1,2], [2,1]] :: Mat2 Int
252 -- >>> let m2 = fromList [[1,2], [3,1]] :: Mat2 Int
256 symmetric :: (Eq a, Arity m) => Mat m m a -> Bool
261 -- | Construct a new matrix from a function @lambda@. The function
262 -- @lambda@ should take two parameters i,j corresponding to the
263 -- entries in the matrix. The i,j entry of the resulting matrix will
264 -- have the value returned by lambda i j.
268 -- >>> let lambda i j = i + j
269 -- >>> construct lambda :: Mat3 Int
270 -- ((0,1,2),(1,2,3),(2,3,4))
272 construct :: forall m n a. (Arity m, Arity n)
273 => (Int -> Int -> a) -> Mat m n a
274 construct lambda = Mat $ generate make_row
276 make_row :: Int -> Vec n a
277 make_row i = generate (lambda i)
280 -- | Create an identity matrix with the right dimensions.
284 -- >>> identity_matrix :: Mat3 Int
285 -- ((1,0,0),(0,1,0),(0,0,1))
286 -- >>> identity_matrix :: Mat3 Double
287 -- ((1.0,0.0,0.0),(0.0,1.0,0.0),(0.0,0.0,1.0))
289 identity_matrix :: (Arity m, Ring.C a) => Mat m m a
291 construct (\i j -> if i == j then (fromInteger 1) else (fromInteger 0))
294 -- | Given a positive-definite matrix @m@, computes the
295 -- upper-triangular matrix @r@ with (transpose r)*r == m and all
296 -- values on the diagonal of @r@ positive.
300 -- >>> let m1 = fromList [[20,-1], [-1,20]] :: Mat2 Double
301 -- >>> let r = cholesky m1
302 -- >>> frobenius_norm ((transpose r)*r - m1) < 1e-10
304 -- >>> is_upper_triangular r
307 -- >>> let k1 = [6, -3, 0, 0, 0, 0, 0] :: [Double]
308 -- >>> let k2 = [-3, 10.5, -7.5, 0, 0, 0, 0] :: [Double]
309 -- >>> let k3 = [0, -7.5, 12.5, 0, 0, 0, 0] :: [Double]
310 -- >>> let k4 = [0, 0, 0, 6, 0, 0, 0] :: [Double]
311 -- >>> let k5 = [0, 0, 0, 0, 6, 0, 0] :: [Double]
312 -- >>> let k6 = [0, 0, 0, 0, 0, 6, 0] :: [Double]
313 -- >>> let k7 = [0, 0, 0, 0, 0, 0, 15] :: [Double]
314 -- >>> let big_K = fromList [k1,k2,k3,k4,k5,k6,k7] :: Mat N7 N7 Double
316 -- >>> let e1 = [2.449489742783178,0,0,0,0,0,0] :: [Double]
317 -- >>> let e2 = [-1.224744871391589,3,0,0,0,0,0] :: [Double]
318 -- >>> let e3 = [0,-5/2,5/2,0,0,0,0] :: [Double]
319 -- >>> let e4 = [0,0,0,2.449489742783178,0,0,0] :: [Double]
320 -- >>> let e5 = [0,0,0,0,2.449489742783178,0,0] :: [Double]
321 -- >>> let e6 = [0,0,0,0,0,2.449489742783178,0] :: [Double]
322 -- >>> let e7 = [0,0,0,0,0,0,3.872983346207417] :: [Double]
323 -- >>> let expected = fromList [e1,e2,e3,e4,e5,e6,e7] :: Mat N7 N7 Double
325 -- >>> let r = cholesky big_K
326 -- >>> frobenius_norm (r - (transpose expected)) < 1e-12
329 cholesky :: forall m n a. (Algebraic.C a, Arity m, Arity n)
330 => (Mat m n a) -> (Mat m n a)
331 cholesky m = construct r
334 r i j | i == j = sqrt(m !!! (i,j) - sum [(r k i)^2 | k <- [0..i-1]])
336 (((m !!! (i,j)) - sum [(r k i) NP.* (r k j) | k <- [0..i-1]]))/(r i i)
340 -- | Returns True if the given matrix is upper-triangular, and False
341 -- otherwise. The parameter @epsilon@ lets the caller choose a
346 -- >>> let m = fromList [[1,1],[1e-12,1]] :: Mat2 Double
347 -- >>> is_upper_triangular m
349 -- >>> is_upper_triangular' 1e-10 m
352 is_upper_triangular' :: forall m n a.
353 (Ord a, Ring.C a, Absolute.C a, Arity m, Arity n)
354 => a -- ^ The tolerance @epsilon@.
357 is_upper_triangular' epsilon matrix =
358 ifoldl2 f True matrix
360 f :: Int -> Int -> Bool -> a -> Bool
361 f _ _ False _ = False
364 -- use "less than or equal to" so zero is a valid epsilon
365 | otherwise = abs x <= epsilon
368 -- | Returns True if the given matrix is upper-triangular, and False
369 -- otherwise. We don't delegate to the general
370 -- 'is_upper_triangular'' here because it imposes additional
371 -- typeclass constraints throughout the library.
375 -- >>> let m = fromList [[1,0],[1,1]] :: Mat2 Int
376 -- >>> is_upper_triangular m
379 -- >>> let m = fromList [[1,2],[0,3]] :: Mat2 Int
380 -- >>> is_upper_triangular m
383 is_upper_triangular :: forall m n a.
384 (Eq a, Ring.C a, Arity m, Arity n)
386 is_upper_triangular matrix =
387 ifoldl2 f True matrix
389 f :: Int -> Int -> Bool -> a -> Bool
390 f _ _ False _ = False
397 -- | Returns True if the given matrix is lower-triangular, and False
402 -- >>> let m = fromList [[1,0],[1,1]] :: Mat2 Int
403 -- >>> is_lower_triangular m
406 -- >>> let m = fromList [[1,2],[0,3]] :: Mat2 Int
407 -- >>> is_lower_triangular m
410 is_lower_triangular :: (Eq a,
416 is_lower_triangular = is_upper_triangular . transpose
419 -- | Returns True if the given matrix is lower-triangular, and False
420 -- otherwise. The parameter @epsilon@ lets the caller choose a
425 -- >>> let m = fromList [[1,1e-12],[1,1]] :: Mat2 Double
426 -- >>> is_lower_triangular m
428 -- >>> is_lower_triangular' 1e-12 m
431 is_lower_triangular' :: (Ord a,
436 => a -- ^ The tolerance @epsilon@.
439 is_lower_triangular' epsilon = (is_upper_triangular' epsilon) . transpose
442 -- | Returns True if the given matrix is triangular, and False
447 -- >>> let m = fromList [[1,0],[1,1]] :: Mat2 Int
448 -- >>> is_triangular m
451 -- >>> let m = fromList [[1,2],[0,3]] :: Mat2 Int
452 -- >>> is_triangular m
455 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
456 -- >>> is_triangular m
459 is_triangular :: (Ord a,
466 is_triangular m = is_upper_triangular m || is_lower_triangular m
469 -- | Delete the @i@th row and @j@th column from the matrix. The name
470 -- \"preminor\" is made up, but is meant to signify that this is
471 -- usually used in the computationof a minor. A minor is simply the
472 -- determinant of a preminor in that case.
476 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
477 -- >>> preminor m 0 0 :: Mat2 Int
479 -- >>> preminor m 1 1 :: Mat2 Int
482 preminor :: (Arity m, Arity n)
487 preminor (Mat rows) i j = m
489 rows' = delete rows i
490 m = Mat $ V.map ((flip delete) j) rows'
493 -- | Compute the i,jth minor of a @matrix@.
497 -- >>> let m1 = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Double
501 minor :: (Arity m, Determined (Mat m m) a)
506 minor matrix i j = determinant (preminor matrix i j)
508 class (Eq a, Ring.C a) => Determined p a where
509 determinant :: (p a) -> a
511 instance (Eq a, Ring.C a) => Determined (Mat (S Z) (S Z)) a where
512 determinant = unscalar
518 Determined (Mat (S n) (S n)) a)
519 => Determined (Mat (S (S n)) (S (S n))) a where
520 -- | The recursive definition with a special-case for triangular matrices.
524 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
529 | is_triangular m = product [ m !!! (i,i) | i <- [0..(nrows m)-1] ]
530 | otherwise = determinant_recursive
534 determinant_recursive =
535 sum [ (-1)^(toInteger j) NP.* (m' 0 j) NP.* (minor m 0 j)
536 | j <- [0..(ncols m)-1] ]
540 -- | Matrix multiplication.
544 -- >>> let m1 = fromList [[1,2,3], [4,5,6]] :: Mat N2 N3 Int
545 -- >>> let m2 = fromList [[1,2],[3,4],[5,6]] :: Mat N3 N2 Int
550 (*) :: (Ring.C a, Arity m, Arity n, Arity p)
554 (*) m1 m2 = construct lambda
556 lambda i j = (transpose $ row m1 i) `dot` (column m2 j)
560 instance (Ring.C a, Arity m, Arity n) => Additive.C (Mat m n a) where
562 (Mat rows_one) + (Mat rows_two) =
563 Mat $ V.zipWith (V.zipWith (+)) rows_one rows_two
565 (Mat rows_one) - (Mat rows_two) =
566 Mat $ V.zipWith (V.zipWith (-)) rows_one rows_two
568 zero = Mat (V.replicate $ V.replicate (fromInteger 0))
571 instance (Ring.C a, Arity m, Arity n, m ~ n) => Ring.C (Mat (S m) (S n) a) where
572 -- The first * is ring multiplication, the second is matrix
577 instance (Ring.C a, Arity m, Arity n) => Module.C a (Mat m n a) where
578 -- We can multiply a matrix by a scalar of the same type as its
580 x *> (Mat rows) = Mat $ V.map (V.map (NP.* x)) rows
583 instance (Absolute.C a,
587 => Normed (Col (S m) a) where
588 -- | Generic p-norms for vectors in R^n that are represented as n-by-1
593 -- >>> let v1 = vec2d (3,4)
599 -- >>> let v1 = vec2d (-1,1) :: Col2 Double
600 -- >>> norm_p 1 v1 :: Double
603 norm_p p (Mat rows) =
604 (root p') $ sum [fromRational' (toRational $ abs x)^p' | x <- xs]
607 xs = concat $ V.toList $ V.map V.toList rows
609 -- | The infinity norm.
613 -- >>> let v1 = vec3d (1,5,2)
617 norm_infty (Mat rows) =
618 fromRational' $ toRational $ V.maximum $ V.map V.maximum rows
621 -- | Compute the Frobenius norm of a matrix. This essentially treats
622 -- the matrix as one long vector containing all of its entries (in
623 -- any order, it doesn't matter).
627 -- >>> let m = fromList [[1, 2, 3],[4,5,6],[7,8,9]] :: Mat3 Double
628 -- >>> frobenius_norm m == sqrt 285
631 -- >>> let m = fromList [[1, -1, 1],[-1,1,-1],[1,-1,1]] :: Mat3 Double
632 -- >>> frobenius_norm m == 3
635 frobenius_norm :: (Arity m, Arity n, Algebraic.C a, Ring.C a)
638 frobenius_norm matrix =
639 sqrt $ element_sum2 $ squares
641 squares = map2 (^2) matrix
644 -- Vector helpers. We want it to be easy to create low-dimension
645 -- column vectors, which are nx1 matrices.
647 -- | Convenient constructor for 2D vectors.
651 -- >>> import Roots.Simple
652 -- >>> let fst m = m !!! (0,0)
653 -- >>> let snd m = m !!! (1,0)
654 -- >>> let h = 0.5 :: Double
655 -- >>> let g1 m = 1.0 + h NP.* exp(-((fst m)^2))/(1.0 + (snd m)^2)
656 -- >>> let g2 m = 0.5 + h NP.* atan((fst m)^2 + (snd m)^2)
657 -- >>> let g u = vec2d ((g1 u), (g2 u))
658 -- >>> let u0 = vec2d (1.0, 1.0)
659 -- >>> let eps = 1/(10^9)
660 -- >>> fixed_point g eps u0
661 -- ((1.0728549599342185),(1.0820591495686167))
663 vec1d :: (a) -> Col1 a
664 vec1d (x) = Mat (mk1 (mk1 x))
666 vec2d :: (a,a) -> Col2 a
667 vec2d (x,y) = Mat (mk2 (mk1 x) (mk1 y))
669 vec3d :: (a,a,a) -> Col3 a
670 vec3d (x,y,z) = Mat (mk3 (mk1 x) (mk1 y) (mk1 z))
672 vec4d :: (a,a,a,a) -> Col4 a
673 vec4d (w,x,y,z) = Mat (mk4 (mk1 w) (mk1 x) (mk1 y) (mk1 z))
675 vec5d :: (a,a,a,a,a) -> Col5 a
676 vec5d (v,w,x,y,z) = Mat (mk5 (mk1 v) (mk1 w) (mk1 x) (mk1 y) (mk1 z))
679 -- Since we commandeered multiplication, we need to create 1x1
680 -- matrices in order to multiply things.
681 scalar :: a -> Mat1 a
682 scalar x = Mat (mk1 (mk1 x))
684 -- Get the scalar value out of a 1x1 matrix.
685 unscalar :: Mat1 a -> a
686 unscalar (Mat rows) = V.head $ V.head rows
689 dot :: (Ring.C a, Arity m)
693 v1 `dot` v2 = element_sum2 $ zipwith2 (NP.*) v1 v2
696 -- | The angle between @v1@ and @v2@ in Euclidean space.
700 -- >>> let v1 = vec2d (1.0, 0.0)
701 -- >>> let v2 = vec2d (0.0, 1.0)
702 -- >>> angle v1 v2 == pi/2.0
705 angle :: (Transcendental.C a,
716 theta = (recip norms) NP.* (v1 `dot` v2)
717 norms = (norm v1) NP.* (norm v2)
720 -- | Retrieve the diagonal elements of the given matrix as a \"column
721 -- vector,\" i.e. a m-by-1 matrix. We require the matrix to be
722 -- square to avoid ambiguity in the return type which would ideally
723 -- have dimension min(m,n) supposing an m-by-n matrix.
727 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
731 diagonal :: (Arity m) => Mat m m a -> Col m a
735 lambda i _ = matrix !!! (i,i)
738 -- | Given a square @matrix@, return a new matrix of the same size
739 -- containing only the on-diagonal entries of @matrix@. The
740 -- off-diagonal entries are set to zero.
744 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
745 -- >>> diagonal_part m
746 -- ((1,0,0),(0,5,0),(0,0,9))
748 diagonal_part :: (Arity m, Ring.C a)
751 diagonal_part matrix =
754 lambda i j = if i == j then matrix !!! (i,j) else 0
757 -- | Given a square @matrix@, return a new matrix of the same size
758 -- containing only the on-diagonal and below-diagonal entries of
759 -- @matrix@. The above-diagonal entries are set to zero.
763 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
765 -- ((1,0,0),(4,5,0),(7,8,9))
767 lt_part :: (Arity m, Ring.C a)
773 lambda i j = if i >= j then matrix !!! (i,j) else 0
776 -- | Given a square @matrix@, return a new matrix of the same size
777 -- containing only the below-diagonal entries of @matrix@. The on-
778 -- and above-diagonal entries are set to zero.
782 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
783 -- >>> lt_part_strict m
784 -- ((0,0,0),(4,0,0),(7,8,0))
786 lt_part_strict :: (Arity m, Ring.C a)
789 lt_part_strict matrix =
792 lambda i j = if i > j then matrix !!! (i,j) else 0
795 -- | Given a square @matrix@, return a new matrix of the same size
796 -- containing only the on-diagonal and above-diagonal entries of
797 -- @matrix@. The below-diagonal entries are set to zero.
801 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
803 -- ((1,2,3),(0,5,6),(0,0,9))
805 ut_part :: (Arity m, Ring.C a)
808 ut_part = transpose . lt_part . transpose
811 -- | Given a square @matrix@, return a new matrix of the same size
812 -- containing only the above-diagonal entries of @matrix@. The on-
813 -- and below-diagonal entries are set to zero.
817 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
818 -- >>> ut_part_strict m
819 -- ((0,2,3),(0,0,6),(0,0,0))
821 ut_part_strict :: (Arity m, Ring.C a)
824 ut_part_strict = transpose . lt_part_strict . transpose
827 -- | Compute the trace of a square matrix, the sum of the elements
828 -- which lie on its diagonal. We require the matrix to be
829 -- square to avoid ambiguity in the return type which would ideally
830 -- have dimension min(m,n) supposing an m-by-n matrix.
834 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
838 trace :: (Arity m, Ring.C a) => Mat m m a -> a
839 trace = element_sum2 . diagonal
843 -- | Zip together two matrices.
845 -- TODO: don't cheat with construct (map V.zips instead).
849 -- >>> let m1 = fromList [[1],[1],[1]] :: Col3 Int
850 -- >>> let m2 = fromList [[1],[2],[3]] :: Col3 Int
852 -- (((1,1)),((1,2)),((1,3)))
854 -- >>> let m1 = fromList [[1,2],[3,4]] :: Mat2 Int
855 -- >>> let m2 = fromList [[1,1],[1,1]] :: Mat2 Int
857 -- (((1,1),(2,1)),((3,1),(4,1)))
859 zip2 :: (Arity m, Arity n) => Mat m n a -> Mat m n b -> Mat m n (a,b)
863 lambda i j = (m1 !!! (i,j), m2 !!! (i,j))
866 -- | Zip together three matrices.
868 -- TODO: don't cheat with construct (map V.zips instead).
872 -- >>> let m1 = fromList [[1],[1],[1]] :: Col3 Int
873 -- >>> let m2 = fromList [[1],[2],[3]] :: Col3 Int
874 -- >>> let m3 = fromList [[4],[5],[6]] :: Col3 Int
875 -- >>> zip2three m1 m2 m3
876 -- (((1,1,4)),((1,2,5)),((1,3,6)))
878 -- >>> let m1 = fromList [[1,2],[3,4]] :: Mat2 Int
879 -- >>> let m2 = fromList [[1,1],[1,1]] :: Mat2 Int
880 -- >>> let m3 = fromList [[8,2],[6,3]] :: Mat2 Int
881 -- >>> zip2three m1 m2 m3
882 -- (((1,1,8),(2,1,2)),((3,1,6),(4,1,3)))
884 zip2three :: (Arity m, Arity n)
892 lambda i j = (m1 !!! (i,j), m2 !!! (i,j), m3 !!! (i,j))
895 -- | Zip together two matrices using the supplied function.
899 -- >>> let c1 = fromList [[1],[2],[3]] :: Col3 Integer
900 -- >>> let c2 = fromList [[4],[5],[6]] :: Col3 Integer
901 -- >>> zipwith2 (^) c1 c2
904 zipwith2 :: (Arity m, Arity n)
912 lambda i j = f (c1 !!! (i,j)) (c2 !!! (i,j))
915 -- | Map a function over a matrix of any dimensions.
919 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
923 map2 :: (a -> b) -> Mat m n a -> Mat m n b
930 -- | Fold over the entire matrix passing the coordinates @i@ and @j@
931 -- (of the row/column) to the accumulation function. The fold occurs
932 -- from top-left to bottom-right.
936 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
937 -- >>> ifoldl2 (\i j cur _ -> cur + i + j) 0 m
940 ifoldl2 :: forall a b m n.
941 (Int -> Int -> b -> a -> b)
945 ifoldl2 f initial (Mat rows) =
946 V.ifoldl row_function initial rows
948 -- | The order that we need this in (so that @g idx@ makes sense)
949 -- is a little funny. So that we don't need to pass weird
950 -- functions into ifoldl2, we swap the second and third
951 -- arguments of @f@ calling the result @g@.
952 g :: Int -> b -> Int -> a -> b
955 row_function :: b -> Int -> Vec n a -> b
956 row_function rowinit idx r = V.ifoldl (g idx) rowinit r
959 -- | Left fold over the entries of a matrix (top-left to bottom-right).
961 foldl2 :: forall a b m n.
966 foldl2 f initial matrix =
967 -- Use the index fold but ignore the index arguments.
968 let g _ _ = f in ifoldl2 g initial matrix
971 -- | Fold over the entire matrix passing the coordinates @i@ and @j@
972 -- (of the row/column) to the accumulation function. The fold occurs
973 -- from bottom-right to top-left.
975 -- The order of the arguments in the supplied function are different
976 -- from those in V.ifoldr; we keep them similar to ifoldl2.
980 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
981 -- >>> ifoldr2 (\i j cur _ -> cur + i + j) 0 m
984 ifoldr2 :: forall a b m n.
985 (Int -> Int -> b -> a -> b)
989 ifoldr2 f initial (Mat rows) =
990 V.ifoldr row_function initial rows
992 -- | Swap the order of arguments in @f@ so that it agrees with the
993 -- @f@ passed to ifoldl2.
994 g :: Int -> Int -> a -> b -> b
995 g w x y z = f w x z y
997 row_function :: Int -> Vec n a -> b -> b
998 row_function idx r rowinit = V.ifoldr (g idx) rowinit r
1001 -- | Map a function over a matrix of any dimensions, passing the
1002 -- coordinates @i@ and @j@ to the function @f@.
1006 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
1007 -- >>> imap2 (\i j _ -> i+j) m
1010 imap2 :: (Int -> Int -> a -> b) -> Mat m n a -> Mat m n b
1011 imap2 f (Mat rows) =
1017 -- | Reverse the order of elements in a matrix.
1021 -- >>> let m1 = fromList [[1,2,3]] :: Row3 Int
1025 -- >>> let m1 = vec3d (1,2,3 :: Int)
1029 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
1031 -- ((9,8,7),(6,5,4),(3,2,1))
1033 reverse2 :: (Arity m, Arity n) => Mat m n a -> Mat m n a
1034 reverse2 (Mat rows) = Mat $ V.reverse $ V.map V.reverse rows
1037 -- | Unsafely set the (i,j) element of the given matrix.
1041 -- >>> let m = fromList [[1,2,3],[4,5,6],[7,8,9]] :: Mat3 Int
1042 -- >>> set_idx m (1,1) 17
1043 -- ((1,2,3),(4,17,6),(7,8,9))
1045 set_idx :: forall m n a.
1051 set_idx matrix (i,j) newval =
1052 imap2 updater matrix
1054 updater :: Int -> Int -> a -> a
1055 updater k l existing =
1061 -- | Compute the i,jth cofactor of the given @matrix@. This simply
1062 -- premultiplues the i,jth minor by (-1)^(i+j).
1063 cofactor :: (Arity m, Determined (Mat m m) a)
1064 => Mat (S m) (S m) a
1068 cofactor matrix i j =
1069 (-1)^(toInteger i + toInteger j) NP.* (minor matrix i j)
1072 -- | Compute the inverse of a matrix using cofactor expansion
1073 -- (generalized Cramer's rule).
1077 -- >>> let m1 = fromList [[37,22],[17,54]] :: Mat2 Double
1078 -- >>> let e1 = [54/1624, -22/1624] :: [Double]
1079 -- >>> let e2 = [-17/1624, 37/1624] :: [Double]
1080 -- >>> let expected = fromList [e1, e2] :: Mat2 Double
1081 -- >>> let actual = inverse m1
1082 -- >>> frobenius_norm (actual - expected) < 1e-12
1085 inverse :: (Arity m,
1086 Determined (Mat (S m) (S m)) a,
1087 Determined (Mat m m) a,
1089 => Mat (S m) (S m) a
1090 -> Mat (S m) (S m) a
1092 (1 / (determinant matrix)) *> (transpose $ construct lambda)
1094 lambda i j = cofactor matrix i j
1098 -- | Retrieve the rows of a matrix as a column matrix. If the given
1099 -- matrix is m-by-n, the result would be an m-by-1 column whose
1100 -- entries are 1-by-n row matrices.
1104 -- >>> let m = fromList [[1,2],[3,4]] :: Mat2 Int
1105 -- >>> (rows2 m) !!! (0,0)
1107 -- >>> (rows2 m) !!! (1,0)
1110 rows2 :: (Arity m, Arity n)
1114 Mat $ V.map (mk1. Mat . mk1) rows
1118 -- | Sum the elements of a matrix.
1122 -- >>> let m = fromList [[1,-1],[3,4]] :: Mat2 Int
1123 -- >>> element_sum2 m
1126 element_sum2 :: (Arity m, Arity n, Additive.C a) => Mat m n a -> a
1127 element_sum2 = foldl2 (+) zero