on master help sign in
31 files changed+2037−1558
since splitsnapshots
unifiedsplit
.ghc.environment.x86_64-linux-8.6.5−17 .github/workflows/ci.yml+43 .gitignore+54−2 .travis.yml+47 CHANGELOG.md+17 ChangeLog.md−3 LICENSE+17−26 README.md+35−27 Setup.hs−2 appveyor.yml+34 benchmark/Main.hs+175 hackage.sh−10 laop-0.1.0.0-docs.tar.gz laop.cabal+89 package.yaml−48 src/LAoP/Dist.hs+10 src/LAoP/Dist/Internal.hs+87−36 src/LAoP/Matrix/Internal.hs+437−429 src/LAoP/Matrix/Nat.hs+194−187 src/LAoP/Matrix/Type.hs+283−240 src/LAoP/Relation.hs+15−6 src/LAoP/Relation/Internal.hs+302−336 src/LAoP/Utils.hs+5−2 src/LAoP/Utils/Internal.hs+41−83 stack-8.8.3.yaml+1 stack.yaml+1−66 stack.yaml.lock+4−4 test/Examples/Quantum.hs+31 app/Main.hs → test/Examples/Readme.hs+61−33 test/Examples/Spreadsheets.hs+47 test/Spec.hs+7−1
.ghc.environment.x86_64-linux-8.6.5deleted−17
@@ -1,17 +0,0 @@
1−-- This is a GHC environment file written by cabal. This means you can
2−-- run ghc or ghci and get the environment of the project as a whole.
3−-- But you still need to use cabal repl $target to get the environment
4−-- of specific components (libs, exes, tests etc) because each one can
5−-- have its own source dirs, cpp flags etc.
6−--
7−clear-package-db
8−global-package-db
9−package-db /home/bolt/.cabal/store/ghc-8.6.5/package.db
10−package-db packagedb/ghc-8.6.5
11−package-id laop-0.1.0.0-inplace
12−package-id base-4.12.0.0
13−package-id ghc-prim-0.5.3
14−package-id rts
15−package-id integer-gmp-1.0.2.0
16−package-id deepseq-1.4.4.0
17−package-id array-0.5.3.0
.github/workflows/ci.ymlnew file+43
@@ -0,0 +1,43 @@
1+name: CI
2+
3+# Trigger the workflow on push or pull request, but only for the master branch
4+on:
5+ pull_request:
6+ push:
7+ branches: [master]
8+
9+jobs:
10+ build:
11+ name: ghc ${{ matrix.ghc }}
12+ runs-on: ubuntu-16.04
13+ strategy:
14+ matrix:
15+ cabal: ["3.0"]
16+ ghc:
17+ - "8.6.5"
18+ - "8.8.3"
19+
20+ steps:
21+ - uses: actions/checkout@v2
22+ if: github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.ref == 'refs/heads/master'
23+
24+ - uses: actions/setup-haskell@v1
25+ name: Setup Haskell
26+ with:
27+ ghc-version: ${{ matrix.ghc }}
28+ cabal-version: ${{ matrix.cabal }}
29+
30+ - uses: actions/cache@v1
31+ name: Cache ~/.cabal/store
32+ with:
33+ path: ~/.cabal/store
34+ key: ${{ runner.os }}-${{ matrix.ghc }}-cabal
35+
36+ - name: Build
37+ run: |
38+ cabal v2-update
39+ cabal v2-build --enable-tests --enable-benchmarks
40+
41+ - name: Test
42+ run: |
43+ cabal v2-test --enable-tests
.gitignore+54−2
@@ -1,3 +1,55 @@
1+### Haskell
2+dist
3+dist-*
4+cabal-dev
5+*.o
6+*.hi
7+*.chi
8+*.chs.h
9+*.dyn_o
10+*.dyn_hi
11+*.prof
12+*.aux
13+*.hp
14+*.eventlog
15+.virtualenv
16+.hsenv
17+.hpc
18+.cabal-sandbox/
19+cabal.sandbox.config
20+cabal.config
21+cabal.project.local
22+.ghc.environment.*
23+.HTF/
24+# Stack
125.stack-work/
2−laop.cabal
3−*~
26+stack.yaml.lock
27+
28+### IDE/support
29+# Vim
30+[._]*.s[a-v][a-z]
31+[._]*.sw[a-p]
32+[._]s[a-v][a-z]
33+[._]sw[a-p]
34+*~
35+tags
36+
37+# IntellijIDEA
38+.idea/
39+.ideaHaskellLib/
40+*.iml
41+
42+# Atom
43+.haskell-ghc-mod.json
44+
45+# VS
46+.vscode/
47+
48+# Emacs
49+*#
50+.dir-locals.el
51+TAGS
52+
53+# other
54+.DS_Store
55+hackage.sh
.travis.ymlnew file+47
@@ -0,0 +1,47 @@
1+sudo: true
2+language: haskell
3+
4+git:
5+ depth: 5
6+
7+cabal: "3.0"
8+
9+cache:
10+ directories:
11+ - "$HOME/.cabal/store"
12+ - "$HOME/.stack"
13+ - "$TRAVIS_BUILD_DIR/.stack-work"
14+
15+matrix:
16+ include:
17+ - ghc: 8.6.5
18+ - ghc: 8.8.3
19+
20+ - ghc: 8.8.3
21+ env: STACK_YAML="$TRAVIS_BUILD_DIR/stack-8.8.3.yaml"
22+
23+ - ghc: 8.6.5
24+ env: STACK_YAML="$TRAVIS_BUILD_DIR/stack.yaml"
25+
26+
27+install:
28+ - |
29+ if [ -z "$STACK_YAML" ]; then
30+ cabal v2-update
31+ cabal v2-build --enable-tests --enable-benchmarks
32+ else
33+ curl -sSL https://get.haskellstack.org/ | sh
34+ stack --version
35+ stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks
36+ fi
37+
38+script:
39+ - |
40+ if [ -z "$STACK_YAML" ]; then
41+ cabal v2-test --enable-tests
42+ else
43+ stack test --system-ghc
44+ fi
45+
46+notifications:
47+ email: false
CHANGELOG.mdnew file+17
@@ -0,0 +1,17 @@
1+# Changelog
2+
3+`laop` uses [PVP Versioning][1].
4+The changelog is available [on GitHub][2].
5+
6+## 0.1.1.1
7+
8+* Bump base version to work with cabal
9+
10+## 0.1.1.0
11+
12+* Package is more organized and now has tests and benchmarks separated
13+* Repository is more organized and clean
14+* Added CI
15+
16+[1]: https://pvp.haskell.org
17+[2]: https://github.com/bolt12/laop2/releases
ChangeLog.mddeleted−3
@@ -1,3 +0,0 @@
1−# Changelog for laop
2−
3−## Unreleased changes
LICENSE+17−26
@@ -1,30 +1,21 @@
1−Copyright Armando Santos (c) 2019
1+MIT License
22
3−All rights reserved.
3+Copyright (c) 2020 Armando Santos
44
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
5+Permission is hereby granted, free of charge, to any person obtaining a copy
6+of this software and associated documentation files (the "Software"), to deal
7+in the Software without restriction, including without limitation the rights
8+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+copies of the Software, and to permit persons to whom the Software is
10+furnished to do so, subject to the following conditions:
711
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
12+The above copyright notice and this permission notice shall be included in all
13+copies or substantial portions of the Software.
1014
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Armando Santos nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+SOFTWARE.
README.md+35−27
@@ -1,5 +1,11 @@
11# laop - Linear Algebra of Programming library
22
3+[![GitHub CI](https://github.com/bolt12/laop/workflows/CI/badge.svg)](https://github.com/bolt12/laop/actions)
4+[![Build status](https://img.shields.io/travis/bolt12/laop.svg?logo=travis)](https://travis-ci.org/bolt12/laop)
5+[![Hackage](https://img.shields.io/hackage/v/laop.svg?logo=haskell)](https://hackage.haskell.org/package/laop)
6+[![Stackage Lts](http://stackage.org/package/laop/badge/lts)](http://stackage.org/lts/package/laop)
7+[![Stackage Nightly](http://stackage.org/package/laop/badge/nightly)](http://stackage.org/nightly/package/laop)
8+
39The LAoP discipline generalises relations and functions treating them as
410Boolean matrices and in turn consider these as arrows.
511
@@ -10,36 +16,38 @@ motivation behind the library, the underlying theory, and implementation details
1016This module offers many of the combinators mentioned in the work of
1117[Macedo (2012)](https://repositorium.sdum.uminho.pt/handle/1822/22894) and [Oliveira (2012)](https://pdfs.semanticscholar.org/ccf5/27fa9179081223bffe8067edd81948644fc0.pdf).
1218
13−See the candidate package in hackage [here](https://hackage.haskell.org/package/laop-0.1.0.0/candidate)
19+See the package in hackage [here](https://hackage.haskell.org/package/laop-0.1.1.0)
20+
21+A Functional Pearl has been written and can be regarded as the [reference document](https://github.com/bolt12/tymfgg-pearl) for this library.
1422
1523## Features
1624
17−This library offers:
18−
19−- An internal module representation that uses normal datatypes (`Void`, `()`, `Either`) for matrix dimensions and two
20− type families `FromNat` and `Count` to make it easier to work with these type of matrices.
21−- An interfacing module that uses generalised types for the dimensions and is just a newtype wrapper
22− around the internal matrix data type.
23−- An interfacing module that uses type level naturals for the dimensions and is just a newtype wrapper
24− around the internal matrix data type.
25−- An interfacing module that restricts the matrix contents to being only 0's or 1's (True
26− and False). This module is called 'Relation' and offers many of the combinators seen in
27− AoP and Relational Calculus/Algebra.
28−- A very simple Probabilistic Programming module and several functions and data types to
29− make it easier to deal with sample space.
30−
31−Given this, this new matrix formulation compared to other libraries one has much more advantages, such as:
32−
33−- Has an inductive definition enabling writing matrix manipulation functions in a much more elegant and calculational way;
34−- Statically typed dimensions;
35−- Polymorphic data type dimensions;
36−- Polymorphic matrix content;
37−- Awesome dimension type inference;
38−- Fast type natural conversion via `FromNat` type family;
39−- Matrix `Junc` and `Split`-ing in O(1);
40−- Matrix composition takes advantage of divide-and-conquer and fusion laws.
41−
42−Unfortunately, this approach does not solve the issue of type dimensions being in some way constrainted making it impossible to write Arrow instances, for example. Type inference isn't perfect, when it comes to infer the types of matrices which dimensions are computed using type level naturals multiplication, the compiler needs type annotations in order to succeed.
25+This library offers 3 main matrix programming modules:
26+
27+- One in which matrices are typed with type level natural numbers;
28+- One in which matrices are typed with arbitrary generic data types;
29+- One in which matrices are regarded as relations, i.e. boolean matrices;
30+
31+There's also an experimental module that uses matrices to represent probability
32+distributions.
33+
34+The most interesting feature is that matrices are represented as an inductive data type.
35+Given this formulation, matrix algorithms can be expressed in a much more elegant and
36+calculational style than the traditional vector of vectors representation. This data type
37+guarantees that a matrix will always have valid dimensions. It can also express block matrix
38+computations naturally, which leads to total, efficient and statically typed manipulation
39+and transformation functions.
40+
41+Like matrix multiplication, other common operations, such as matrix transposition, benefit from a block-oriented structure that leads to a simple and natural divide-and-conquer algorithmic solution. Performance wise, this means that without much effort we can obtain optimal cache-oblivious algorithms.
42+
43+Given this, this new matrix formulation compared to other libraries:
44+
45+- Is more compositional and polymorphic and does not have partial matrix manipulation functions (hence less chances for usage errors);
46+- Our implementation of matrices enables simple manipulation of submatrices, making it particularly suitable for formal verification and equation reasoning, using the mathematical framework defined by the linear algebra of programming. Furthermore, the data type constructors ensure that the matrices of this kind are sound, i.e. malformed matrices with incorrect dimensions of the sort, can not be constructed.
47+
48+## Known issues
49+
50+Unfortunately, due to the use of type-level programming features, this approach sometimes requires type dimensions to be constrainted, in some way, impossible to write idiomatic Arrow instances, for example. Type inference isn't perfect, when it comes to infer the types of matrices which dimensions are computed using type level naturals multiplication, the compiler needs type annotations in order to succeed. And not all kinds of programs can be modeled using matrices, namely programs that deal with arbitrary infinite data types such as lists or integers (although there are some workarounds).
4351
4452## Notes
4553
Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
appveyor.ymlnew file+34
@@ -0,0 +1,34 @@
1+clone_folder: "c:\\WORK"
2+clone_depth: 5
3+
4+# Do not build feature branch with open Pull Requests
5+skip_branch_with_pr: true
6+
7+platform:
8+ - x86_64
9+
10+cache:
11+ - "C:\\SR"
12+ - dist-newstyle
13+
14+environment:
15+ global:
16+ CABOPTS: --store-dir=C:\\SR
17+
18+ matrix:
19+ - GHCVER: 8.6.5
20+
21+install:
22+ - choco source add -n mistuke -s https://www.myget.org/F/mistuke/api/v2
23+ - choco install -y cabal --version 2.4.1.0
24+ - choco install -y ghc --version 8.6.3
25+ - refreshenv
26+
27+before_build:
28+ - cabal --version
29+ - ghc --version
30+ - cabal %CABOPTS% v2-update
31+
32+build_script:
33+ - cabal %CABOPTS% v2-build --enable-tests
34+ - cabal %CABOPTS% v2-test --enable-tests
benchmark/Main.hsnew file+175
@@ -0,0 +1,175 @@
1+{-# LANGUAGE KindSignatures #-}
2+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+{-# LANGUAGE DerivingVia #-}
4+{-# LANGUAGE DataKinds #-}
5+{-# LANGUAGE BangPatterns #-}
6+{-# LANGUAGE TypeApplications #-}
7+{-# LANGUAGE FlexibleContexts #-}
8+{-# LANGUAGE AllowAmbiguousTypes #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+
11+module Main (main) where
12+
13+import LAoP.Dist.Internal
14+import LAoP.Utils
15+import LAoP.Matrix.Type hiding (CountableN, Countable, FLN)
16+import qualified LAoP.Matrix.Type as T (FLN)
17+import Criterion.Main
18+import Control.DeepSeq
19+import Test.QuickCheck
20+import GHC.TypeLits
21+import Data.Proxy
22+import Prelude hiding (id, (.))
23+
24+selectM2 ::
25+ ( Num e,
26+ T.FLN b b,
27+ CountableN b
28+ ) => Matrix e cols (Either a b) -> Matrix e a b -> Matrix e cols b
29+selectM2 m y = join y iden `comp` m
30+
31+selectD2 ::
32+ ( FLN b b,
33+ CountableN b
34+ ) => Dist (Either a b) -> Matrix Prob a b -> Dist b
35+selectD2 (D d) m = D (join m iden `comp` d)
36+
37+-- Composition with iden
38+compId m = comp iden m
39+
40+randomDist :: forall a . (Countable a, FLN () a) => Gen (Dist a)
41+randomDist = do
42+ let size = fromInteger (natVal (Proxy :: Proxy (Count a)))
43+ l <- vectorOf size (arbitrary :: Gen Prob)
44+ let ln = normalize l
45+ lr = map (:[]) ln
46+ m = fromLists lr
47+ return (D m)
48+
49+randomMatrix :: forall a b . (CountableDims a b, FLN a b) => Gen (Matrix Prob a b)
50+randomMatrix = do
51+ let cols = fromInteger (natVal (Proxy :: Proxy (Count a)))
52+ rows = fromInteger (natVal (Proxy :: Proxy (Count b)))
53+ l <- vectorOf (cols * rows) arbitrary
54+ let lr = buildList l cols
55+ m = fromLists lr
56+ return m
57+
58+buildList [] _ = []
59+buildList l r = take r l : buildList (drop r l) r
60+
61+normalize :: [Prob] -> [Prob]
62+normalize l = let l' = map abs l
63+ s = sum l'
64+ in map (/ s) l'
65+
66+-- Probability
67+newtype Probability = P Double
68+ deriving (Num, Show, Fractional, NFData) via Double
69+newtype Dist' a = D' { unD :: [(a,Probability)] }
70+ deriving (Show, NFData)
71+
72+instance Functor Dist' where
73+ fmap f (D' d) = D' [(f x,p) | (x,p) <- d]
74+
75+instance Applicative Dist' where
76+ pure x = D' [(x, 1)]
77+ fm <*> m = D' [(f x,q*p) | (f,p) <- unD fm, (x,q) <- unD m]
78+
79+class Applicative f => Selective f where
80+ select :: f (Either a b) -> f (a -> b) -> f b
81+
82+instance Selective Dist' where
83+ select x y = (\e f -> either f id e) <$> x <*> y -- selectA
84+
85+instance Monad Dist' where
86+ return = pure
87+ (D' d) >>= f = D' [(y,q*p) | (x,p) <- d, (y,q) <- unD (f x)]
88+
89+normalize2 :: forall a . (Enum a, Bounded a) => [Probability] -> [(a, Probability)]
90+normalize2 l = let l' = map abs l
91+ as = [minBound .. maxBound]
92+ s = sum l'
93+ probs = map (/ s) l'
94+ in zip as probs
95+
96+randomDist2 :: forall a . (Countable a, Enum a, Bounded a) => Gen (Dist' a)
97+randomDist2 = do
98+ let size = fromInteger (natVal (Proxy :: Proxy (Count a)))
99+ l <- vectorOf size (arbitrary :: Gen Prob)
100+ let ln = normalize2 @a (map P l)
101+ return (D' ln)
102+
103+normalize3 :: forall a . [a] -> [Probability] -> [(a, Probability)]
104+normalize3 as l = let s = sum l
105+ probs = map (/ s) l
106+ in zip as probs
107+
108+randomDistF :: forall a b . (CountableDims a b, CoArbitrary a, Arbitrary b) => Gen (Dist' (a -> b))
109+randomDistF = do
110+ let a = fromInteger (natVal (Proxy :: Proxy (Count a)))
111+ b = fromInteger (natVal (Proxy :: Proxy (Count b)))
112+ size = a * b
113+ l <- vectorOf size (arbitrary :: Gen Prob)
114+ l2 <- vectorOf size (arbitrary :: Gen (a -> b))
115+ let !ln = normalize3 l2 (map P l)
116+ return (D' ln)
117+
118+instance CoArbitrary (Natural a b)
119+
120+instance forall (a :: Nat) (b :: Nat). (KnownNat a, KnownNat b) => Arbitrary (Natural a b)
121+ where
122+ arbitrary =
123+ let bottom = fromInteger (natVal (Proxy :: Proxy a))
124+ top = fromInteger (natVal (Proxy :: Proxy b))
125+ in do
126+ x <- arbitrary `suchThat` (\n -> n >= bottom && n <= top)
127+ return (nat x)
128+
129+setupEnv = do
130+ m11 <- generate (resize 1 (randomMatrix @(Natural 0 10) @(Natural 0 10) ))
131+ m12 <- generate (resize 1 (randomMatrix @(Natural 0 10) @(Natural 0 10) ))
132+ m21 <- generate (resize 1 (randomMatrix @(Natural 0 100) @(Natural 0 100) ))
133+ m22 <- generate (resize 1 (randomMatrix @(Natural 0 100) @(Natural 0 100) ))
134+ m31 <- generate (resize 1 (randomMatrix @(Natural 0 200) @(Natural 0 200) ))
135+ m32 <- generate (resize 1 (randomMatrix @(Natural 0 200) @(Natural 0 200) ))
136+ return (m11, m12, m21, m22, m31, m32)
137+
138+setupEnv2 = do
139+ m21 <- generate (resize 1 (randomMatrix @(Natural 0 100) @(Natural 0 100) ))
140+ m40 <- generate (resize 1 (randomMatrix @(Natural 0 100) @(Either (Natural 0 100) (Natural 0 100) )))
141+ dist <- generate (resize 1 (randomDist @(Either (Natural 0 100) (Natural 0 100)) ))
142+ dist2 <- generate (resize 1 (randomMatrix @(Natural 0 100) @(Natural 0 100) ))
143+ distList1 <- generate (resize 1 (randomDist2 @(Either (Natural 0 100) (Natural 0 100))))
144+ distList2 <- generate (resize 1 (randomDistF @(Natural 0 100) @(Natural 0 100)))
145+ return (m21, m40, dist, dist2, distList1, distList2)
146+
147+main :: IO ()
148+main = defaultMain [
149+ env setupEnv $ \ ~(m11, m12, m21, m22, m31, m32) -> bgroup "Matrix Composition" [
150+ bgroup "10x10" [
151+ bench "WHNF - 10x10" $ whnf (comp m11) m12
152+ , bench "NF - 10x10" $ nf (comp m11) m12
153+ ],
154+ bgroup "100x100" [
155+ bench "WHNF - 100x100" $ whnf (comp m21) m22
156+ , bench "NF - 100x100" $ nf (comp m21) m22
157+ ],
158+ bgroup "200x200" [
159+ bench "WHNF - 200x200" $ whnf (comp m31) m32
160+ , bench "NF - 200x200" $ nf (comp m31) m32
161+ ],
162+ bgroup "200x200 - RULES" [
163+ bench "No rules - 200x200" $ nf (comp m21) iden
164+ , bench "Rules - 200x200" $ nf compId m21
165+ ] ],
166+ env setupEnv2 $ \ ~(m21, m40, dist, dist2, dl1, dl2) -> bgroup "Matrix vs List - `select`" [
167+ bgroup "Distribution `select` - 100+100 / 100x100" [
168+ bench "List Distribution - Applicative version" $ nf (select dl1) dl2
169+ , bench "Matrix Distribution - Applicative version" $ nf (selectD2 dist) dist2
170+ , bench "Matrix Distribution - Selective version" $ nf (selectD dist) dist2
171+ ],
172+ bgroup "Matrix `select` - 100x(100+100) / 100x100" [
173+ bench "Applicative version" $ nf (selectM2 m40) m21
174+ , bench "Selective version" $ nf (selectM m40) m21
175+ ] ] ]
hackage.shdeleted−10
@@ -1,10 +0,0 @@
1−#!/bin/sh
2−set -e
3−
4−dir=$(mktemp -d dist-docs.XXXXXX)
5−trap 'rm -r "$dir"' EXIT
6−
7−# assumes cabal 2.4 or later
8−cabal v2-haddock --builddir="$dir" --haddock-for-hackage --enable-doc
9−
10−cabal upload -d $dir/*-docs.tar.gz
laop-0.1.0.0-docs.tar.gzdeleted

Binary file not shown.

laop.cabalnew file+89
@@ -0,0 +1,89 @@
1+cabal-version: 2.4
2+name: laop
3+version: 0.1.1.1
4+synopsis: Matrix programming library
5+description: Matrix programming library that uses a type-safe inductive definition
6+ inspired by the Linear Algebra of Programming
7+homepage: https://github.com/bolt12/laop
8+bug-reports: https://github.com/bolt12/laop/issues
9+license: MIT
10+license-file: LICENSE
11+author: Armando Santos
12+maintainer: Armando Santos <armandoifsantos@gmail.com>
13+copyright: 2020 Armando Santos
14+category: Data
15+build-type: Simple
16+extra-doc-files: README.md
17+ CHANGELOG.md
18+tested-with: GHC == 8.6.5
19+ GHC == 8.8.3
20+
21+source-repository head
22+ type: git
23+ location: https://github.com/bolt12/laop.git
24+
25+common common-options
26+ build-depends: base >= 4.12.0.0 && < 5,
27+ deepseq
28+
29+ ghc-options: -Wall
30+ -Wcompat
31+ -Widentities
32+ -Wincomplete-uni-patterns
33+ -Wincomplete-record-updates
34+ if impl(ghc >= 8.0)
35+ ghc-options: -Wredundant-constraints
36+ if impl(ghc >= 8.2)
37+ ghc-options: -fhide-source-paths
38+ if impl(ghc >= 8.4)
39+ ghc-options: -Wmissing-export-lists
40+ -Wpartial-fields
41+ if impl(ghc >= 8.8)
42+ ghc-options: -Wmissing-deriving-strategies
43+
44+ default-language: Haskell2010
45+
46+library
47+ import: common-options
48+ hs-source-dirs: src
49+ exposed-modules: LAoP.Dist
50+ LAoP.Dist.Internal
51+ LAoP.Matrix.Internal
52+ LAoP.Matrix.Nat
53+ LAoP.Matrix.Type
54+ LAoP.Relation
55+ LAoP.Relation.Internal
56+ LAoP.Utils
57+ LAoP.Utils.Internal
58+
59+test-suite laop-test
60+ import: common-options
61+ type: exitcode-stdio-1.0
62+ hs-source-dirs: test
63+ other-modules: Examples.Readme
64+ main-is: Spec.hs
65+ build-depends: laop
66+ ghc-options: -threaded
67+ -rtsopts
68+ -with-rtsopts=-N
69+ -funfolding-use-threshold=16
70+ -fexcess-precision
71+ -optc-O3
72+ -optc-ffast-math
73+
74+benchmark laop-benchmark
75+ import: common-options
76+ type: exitcode-stdio-1.0
77+ hs-source-dirs: benchmark
78+ main-is: Main.hs
79+ build-depends: criterion
80+ , QuickCheck
81+ , deepseq
82+ , laop
83+ ghc-options: -threaded
84+ -rtsopts
85+ -with-rtsopts=-N
86+ -funfolding-use-threshold=16
87+ -fexcess-precision
88+ -optc-O3
89+ -optc-ffast-math
package.yamldeleted−48
@@ -1,48 +0,0 @@
1−name: laop
2−version: 0.1.0.0
3−github: "bolt12/laop"
4−license: BSD3
5−author: "Armando Santos"
6−maintainer: "armandoifsantos@gmail.com"
7−copyright: "MIT"
8−
9−extra-source-files:
10−- README.md
11−- ChangeLog.md
12−
13−# Metadata used when publishing your package
14−# synopsis: Short description of your package
15−# category: Web
16−
17−# To avoid duplicated efforts in documentation and dealing with the
18−# complications of embedding Haddock markup inside cabal files, it is
19−# common to point users to the README.md file.
20−description: Please see the README on GitHub at <https://github.com/bolt12/laop#readme>
21−
22−dependencies:
23−- base >= 4.7 && < 5
24−
25−library:
26− source-dirs: src
27−
28−#executables:
29−# laop-exe:
30−# main: Main.hs
31−# source-dirs: app
32−# ghc-options:
33−# - -threaded
34−# - -rtsopts
35−# - -with-rtsopts=-N
36−# dependencies:
37−# - laop
38−
39−tests:
40− laop-test:
41− main: Spec.hs
42− source-dirs: test
43− ghc-options:
44− - -threaded
45− - -rtsopts
46− - -with-rtsopts=-N
47− dependencies:
48− - laop
src/LAoP/Dist.hs+10
@@ -36,6 +36,14 @@ module LAoP.Dist
3636 Dist (..),
3737 Prob,
3838
39+ -- * Constraint type synonyms
40+ Countable,
41+ CountableN,
42+ CountableDimsN,
43+ FLN,
44+ Liftable,
45+ TrivialP,
46+
3947 -- * Functor instance equivalent functions
4048 fmapD,
4149
@@ -45,6 +53,8 @@ module LAoP.Dist
4553
4654 -- * Selective equivalent functions
4755 selectD,
56+ branchD,
57+ ifD,
4858
4959 -- * Monad equivalent functions
5060 returnD,
src/LAoP/Dist/Internal.hs+87−36
@@ -1,3 +1,5 @@
1+{-# LANGUAGE DerivingVia #-}
2+{-# LANGUAGE ConstraintKinds #-}
13{-# LANGUAGE GADTs #-}
24{-# LANGUAGE AllowAmbiguousTypes #-}
35{-# LANGUAGE TypeApplications #-}
@@ -8,18 +10,27 @@
810{-# LANGUAGE RankNTypes #-}
911
1012module LAoP.Dist.Internal
11− (
13+ (
1214 Dist(..),
1315 Prob,
1416
17+ Countable,
18+ CountableN,
19+ CountableDimsN,
20+ FLN,
21+ Liftable,
22+ TrivialP,
23+
1524 fmapD,
1625 unitD,
1726 multD,
1827 selectD,
28+ branchD,
29+ ifD,
1930 returnD,
2031 bindD,
2132 (??),
22−
33+
2334 choose,
2435 shape,
2536 linear,
@@ -32,11 +43,15 @@ module LAoP.Dist.Internal
3243 )
3344 where
3445
35−import LAoP.Matrix.Type
46+import LAoP.Matrix.Type hiding (TrivialP, Countable, CountableDims, CountableN, CountableDimsN, Liftable, FLN)
47+import Prelude hiding (id, (.))
48+import qualified LAoP.Matrix.Internal as I
3649import LAoP.Utils
3750import GHC.TypeLits
3851import Data.Proxy
3952import Data.List (sortBy)
53+import Control.DeepSeq
54+import Data.Bool
4055
4156-- | Type synonym for probability value
4257type Prob = Double
@@ -44,17 +59,21 @@ type Prob = Double
4459-- | Type synonym for column vector matrices. This represents a probability
4560-- distribution.
4661newtype Dist a = D (Matrix Prob () a)
62+ deriving (Show, Num, Eq, Ord, NFData) via (Matrix Prob () a)
63+
64+-- | Constraint type synonyms to keep the type signatures less convoluted
65+type Countable a = KnownNat (I.Count a)
66+type CountableN a = KnownNat (I.Count (I.Normalize a))
67+type CountableDimsN a b = (CountableN a, CountableN b)
68+type FLN a b = I.FL (I.Normalize a) (I.Normalize b)
69+type Liftable a b = (Bounded a, Bounded b, Enum a, Enum b, Eq b, Num Prob, Ord Prob)
70+type TrivialP a b = Normalize (a, b) ~ Normalize (Normalize a, Normalize b)
4771
4872-- | Functor instance
4973fmapD ::
50− ( Bounded a,
51− Bounded b,
52− Enum a,
53− Enum b,
54− Eq b,
55− KnownNat (Count (Normalize a)),
56− KnownNat (Count (Normalize b)),
57− FromLists Prob (Normalize b) (Normalize a)
74+ ( Liftable a b,
75+ CountableDimsN a b,
76+ FLN b a
5877 )
5978 =>
6079 (a -> b) -> Dist a -> Dist b
@@ -66,26 +85,58 @@ unitD = D (one 1)
6685
6786-- | Applicative/Monoidal instance 'mult' function
6887multD ::
69− ( KnownNat (Count (Normalize a)),
70− KnownNat (Count (Normalize b)),
71− KnownNat (Count (Normalize (a, b))),
72− FromLists Prob (Normalize (a, b)) (Normalize a),
73− FromLists Prob (Normalize (a, b)) (Normalize b),
74− Normalize (a, b) ~ Normalize (Normalize a, Normalize b)
88+ ( CountableDimsN a b,
89+ CountableN (a, b),
90+ FLN (a, b) a,
91+ FLN (a, b) b,
92+ TrivialP a b
7593 ) => Dist a -> Dist b -> Dist (a, b)
76−multD (D a) (D b) = D (khatri a b)
94+multD (D a) (D b) = D (kr a b)
7795
7896-- | Selective instance function
7997selectD ::
80− ( Normalize (Either a b) ~ Either (Normalize a) (Normalize b),
81− FromLists Prob (Normalize b) (Normalize b),
82− KnownNat (Count (Normalize b))
98+ ( FLN b b,
99+ CountableN b
83100 ) => Dist (Either a b) -> Matrix Prob a b -> Dist b
84−selectD (D d) m = D (junc m identity `comp` d)
85−
101+selectD (D d) m = D (selectM d m)
102+
103+-- | Chooses which of the two given effectful
104+-- functions to apply to a given argument;
105+branchD ::
106+ ( Num e,
107+ CountableDimsN a b,
108+ CountableDimsN c (Either b c),
109+ FLN c b,
110+ FLN a b,
111+ FLN a a,
112+ FLN b b,
113+ FLN c c,
114+ FLN b a,
115+ FLN b c,
116+ FLN (Either b c) b,
117+ FLN (Either b c) c
118+ )
119+ => Dist (Either a b) -> Matrix Prob a c -> Matrix Prob b c -> Dist c
120+branchD x l r = f x `selectD` g l `selectD` r
121+ where
122+ f (D m) = D (fork (tr i1) (i1 `comp` tr i2) `comp` m)
123+ g m = i2 `comp` m
124+
125+-- | Branch on a Boolean value, skipping unnecessary computations.
126+ifD ::
127+ ( CountableDimsN a (Either () a),
128+ FLN a a,
129+ FLN a (),
130+ FLN () a,
131+ FLN (Either () a) a
132+ )
133+ => Dist Bool -> Dist a -> Dist a -> Dist a
134+ifD x (D t) (D e) = branchD x' t e
135+ where
136+ x' = bool (Right ()) (Left ()) `fmapD` x
86137
87138-- | Monad instance 'return' function
88−returnD :: forall a . (Enum a, FromLists Prob () (Normalize a), KnownNat (Count a)) => a -> Dist a
139+returnD :: forall a . (Enum a, FLN () a, Countable a) => a -> Dist a
89140returnD a = D (col l)
90141 where
91142 i = fromInteger $ natVal (Proxy :: Proxy (Count a))
@@ -99,8 +150,8 @@ bindD (D d) m = D (m `comp` d)
99150-- | Extract probabilities given an Event.
100151(??) ::
101152 ( Enum a,
102− KnownNat (Count a),
103− FromLists Prob () (Normalize a)
153+ Countable a,
154+ FLN () a
104155 ) => (a -> Bool) -> Dist a -> Prob
105156(??) p d =
106157 let l = toValues d
@@ -110,11 +161,11 @@ bindD (D d) m = D (m `comp` d)
110161-- Distribution Construction
111162
112163-- | Constructs a Bernoulli distribution
113−choose :: (FromLists Prob () (Normalize a)) => Prob -> Dist a
164+choose :: (FLN () a) => Prob -> Dist a
114165choose prob = D (col [prob, 1 - prob])
115166
116167-- | Creates a distribution given a shape function
117−shape :: (FromLists Prob () (Normalize a)) => (Prob -> Prob) -> [a] -> Dist a
168+shape :: (FLN () a) => (Prob -> Prob) -> [a] -> Dist a
118169shape _ [] = error "Probability.shape: empty list"
119170shape f xs =
120171 let incr = 1 / fromIntegral (length xs - 1)
@@ -122,23 +173,23 @@ shape f xs =
122173 in fromFreqs (zip xs ps)
123174
124175-- | Constructs a Linear distribution
125−linear :: (FromLists Prob () (Normalize a)) => [a] -> Dist a
176+linear :: (FLN () a) => [a] -> Dist a
126177linear = shape id
127178
128179-- | Constructs an Uniform distribution
129−uniform :: (FromLists Prob () (Normalize a)) => [a] -> Dist a
180+uniform :: (FLN () a) => [a] -> Dist a
130181uniform = shape (const 1)
131182
132183-- | Constructs an Negative Exponential distribution
133−negExp :: (FromLists Prob () (Normalize a)) => [a] -> Dist a
184+negExp :: (FLN () a) => [a] -> Dist a
134185negExp = shape (\x -> exp (-x))
135186
136187-- | Constructs an Normal distribution
137−normal :: (FromLists Prob () (Normalize a)) => [a] -> Dist a
188+normal :: (FLN () a) => [a] -> Dist a
138189normal = shape (normalCurve 0.5 0.5)
139190
140191-- | Transforms a 'Dist' into a list of pairs.
141−toValues :: forall a . (Enum a, KnownNat (Count a), FromLists Prob () (Normalize a)) => Dist a -> [(a, Prob)]
192+toValues :: forall a . (Enum a, Countable a, FLN () a) => Dist a -> [(a, Prob)]
142193toValues (D d) =
143194 let rows = fromInteger (natVal (Proxy :: Proxy (Count a)))
144195 probs = toList d
@@ -146,7 +197,7 @@ toValues (D d) =
146197 in res
147198
148199-- | Pretty a distribution
149−prettyDist :: forall a. (Show a, Enum a, KnownNat (Count a), FromLists Prob () (Normalize a)) => Dist a -> String
200+prettyDist :: forall a. (Show a, Enum a, Countable a, FLN () a) => Dist a -> String
150201prettyDist d =
151202 let values = sortBy (\(a, p1) (b, p2) -> compare p2 p1) (toValues @a d)
152203 w = maximum (map (length . show . fst) values)
@@ -158,12 +209,12 @@ prettyDist d =
158209 showR n x = show x ++ " "
159210
160211-- | Pretty Print a distribution
161−prettyPrintDist :: forall a . (Show a, Enum a, KnownNat (Count a), FromLists Prob () (Normalize a)) => Dist a -> IO ()
212+prettyPrintDist :: forall a . (Show a, Enum a, Countable a, FLN () a) => Dist a -> IO ()
162213prettyPrintDist = putStrLn . prettyDist @a
163214
164215-- Auxiliary functions
165216
166−fromFreqs :: (FromLists Prob () (Normalize a)) => [(a,Prob)] -> Dist a
217+fromFreqs :: (FLN () a) => [(a,Prob)] -> Dist a
167218fromFreqs xs = D (col (map (\(x,p) -> p/q) xs))
168219 where q = sum $ map snd xs
169220
src/LAoP/Matrix/Internal.hs+437−429
@@ -1,4 +1,6 @@
1+{-# LANGUAGE StrictData #-}
12{-# LANGUAGE TypeFamilyDependencies #-}
3+{-# LANGUAGE ConstraintKinds #-}
24{-# LANGUAGE AllowAmbiguousTypes #-}
35{-# LANGUAGE DataKinds #-}
46{-# LANGUAGE FlexibleContexts #-}
@@ -28,7 +30,7 @@
2830-- motivation behind the library, the underlying theory, and implementation details.
2931--
3032-- This module offers many of the combinators mentioned in the work of
31−-- Macedo (2012) and Oliveira (2012).
33+-- Macedo (2012) and Oliveira (2012).
3234--
3335-- This is an Internal module and it is no supposed to be imported.
3436--
@@ -41,17 +43,26 @@ module LAoP.Matrix.Internal
4143 --
4244 -- There exists two type families that make it easier to write
4345 -- matrix dimensions: 'FromNat' and 'Count'. This approach
44− -- leads to a very straightforward implementation
45− -- of LAoP combinators.
46+ -- leads to a very straightforward implementation
47+ -- of LAoP combinators.
4648
4749 -- * Type safe matrix representation
4850 Matrix (..),
4951
52+ -- * Constraint type aliases
53+ Countable,
54+ CountableDims,
55+ CountableN,
56+ CountableDimsN,
57+ FL,
58+ FLN,
59+ Liftable,
60+ Trivial,
61+
5062 -- * Primitives
51− empty,
5263 one,
53− junc,
54− split,
64+ join,
65+ fork,
5566
5667 -- * Auxiliary type families
5768 FromNat,
@@ -64,6 +75,7 @@ module LAoP.Matrix.Internal
6475 toLists,
6576 toList,
6677 matrixBuilder,
78+ matrixBuilder',
6779 row,
6880 col,
6981 zeros,
@@ -74,28 +86,38 @@ module LAoP.Matrix.Internal
7486 -- * Misc
7587 -- ** Get dimensions
7688 columns,
89+ columns',
7790 rows,
91+ rows',
7892
7993 -- ** Matrix Transposition
8094 tr,
8195
96+ -- ** Scalar multiplication/division of matrices
97+ (.|),
98+ (./),
99+
82100 -- ** Selective operator
83− select,
101+ select,
102+ branch,
84103
85104 -- ** McCarthy's Conditional
86105 cond,
87106
88107 -- ** Matrix "abiding"
89− abideJS,
90− abideSJ,
108+ abideJF,
109+ abideFJ,
110+
111+ -- ** Zip matrices
112+ zipWithM,
91113
92114 -- * Biproduct approach
93− -- ** Split
115+ -- ** Fork
94116 (===),
95117 -- *** Projections
96118 p1,
97119 p2,
98− -- ** Junc
120+ -- ** Join
99121 (|||),
100122 -- *** Injections
101123 i1,
@@ -108,12 +130,13 @@ module LAoP.Matrix.Internal
108130
109131 -- | Note that given the restrictions imposed it is not possible to
110132 -- implement the standard type classes present in standard Haskell.
133+
111134 -- *** Matrix pairing projections
112− kp1,
113− kp2,
135+ fstM,
136+ sndM,
114137
115138 -- *** Matrix pairing
116− khatri,
139+ kr,
117140
118141 -- * Matrix composition and lifting
119142
@@ -121,10 +144,10 @@ module LAoP.Matrix.Internal
121144
122145 -- | Note that given the restrictions imposed it is not possible to
123146 -- implement the standard type classes present in standard Haskell.
124− identity,
147+ iden,
125148 comp,
126− fromF,
127149 fromF',
150+ fromF,
128151
129152 -- * Matrix printing
130153 pretty,
@@ -151,21 +174,22 @@ import LAoP.Utils.Internal
151174import Data.Bool
152175import Data.Kind
153176import Data.List
177+import Data.Maybe
154178import Data.Proxy
179+import Data.Typeable
155180import Data.Void
156181import GHC.TypeLits
157182import Data.Type.Equality
158183import GHC.Generics
159184import Control.DeepSeq
160−import Control.Category
161−import Prelude hiding ((.))
185+import Prelude hiding (id, (.))
186+import qualified Prelude (id, (.))
162187
163188-- | LAoP (Linear Algebra of Programming) Inductive Matrix definition.
164189data Matrix e cols rows where
165− Empty :: Matrix e Void Void
166190 One :: e -> Matrix e () ()
167− Junc :: Matrix e a rows -> Matrix e b rows -> Matrix e (Either a b) rows
168− Split :: Matrix e cols a -> Matrix e cols b -> Matrix e cols (Either a b)
191+ Join :: Matrix e a rows -> Matrix e b rows -> Matrix e (Either a b) rows
192+ Fork :: Matrix e cols a -> Matrix e cols b -> Matrix e cols (Either a b)
169193
170194deriving instance (Show e) => Show (Matrix e cols rows)
171195
@@ -175,7 +199,7 @@ deriving instance (Show e) => Show (Matrix e cols rows)
175199-- 'Generic' instance.
176200type family Count (d :: Type) :: Nat where
177201 Count (Natural n m) = (m - n) + 1
178− Count (Powerset a) = (^) (Count a) (Count a)
202+ Count (List a) = (^) 2 (Count a)
179203 Count (Either a b) = (+) (Count a) (Count b)
180204 Count (a, b) = (*) (Count a) (Count b)
181205 Count (a -> b) = (^) (Count b) (Count a)
@@ -192,205 +216,197 @@ type family Count (d :: Type) :: Nat where
192216--
193217-- Thanks to Li-Yao Xia this type family is super fast.
194218type family FromNat (n :: Nat) :: Type where
195− FromNat 0 = Void
196219 FromNat 1 = ()
197220 FromNat n = FromNat' (Mod n 2 == 0) (FromNat (Div n 2))
198221
199222type family FromNat' (b :: Bool) (m :: Type) :: Type where
200− FromNat' 'True m = Either m m
223+ FromNat' 'True m = Either m m
201224 FromNat' 'False m = Either () (Either m m)
202225
203226-- | Type family that normalizes the representation of a given data
204227-- structure
205228type family Normalize (d :: Type) :: Type where
206− Normalize d = FromNat (Count d)
207−
208−-- | It isn't possible to implement the 'id' function so it's
209−-- implementation is 'undefined'. However 'comp' can be and this partial
210−-- class implementation exists just to make the code more readable.
211−--
212−-- Please use 'identity' instead.
229+ Normalize (Either a b) = Either (Normalize a) (Normalize b)
230+ Normalize d = FromNat (Count d)
231+
232+-- | Constraint type synonyms to keep the type signatures less convoluted
233+type Countable a = KnownNat (Count a)
234+type CountableN a = KnownNat (Count (Normalize a))
235+type CountableDims a b = (Countable a, Countable b)
236+type CountableDimsN a b = (CountableN a, CountableN b)
237+type FL a b = FromLists a b
238+type FLN a b = FromLists (Normalize a) (Normalize b)
239+type Liftable e a b = (Bounded a, Bounded b, Enum a, Enum b, Eq b, Num e, Ord e)
240+type Trivial a = FromNat (Count a) ~ a
241+
242+-- | It is possible to implement a constrained version of the category type
243+-- class.
213244instance (Num e) => Category (Matrix e) where
214− id = undefined
215− (.) = comp
245+ type Object (Matrix e) a = (FL a a, Countable a)
246+ id = iden
247+ (.) = comp
216248
217249instance NFData e => NFData (Matrix e cols rows) where
218− rnf Empty = ()
219− rnf (One e) = rnf e
220− rnf (Junc a b) = rnf a `seq` rnf b
221− rnf (Split a b) = rnf a `seq` rnf b
250+ rnf (One e) = rnf e
251+ rnf (Join a b) = rnf a `seq` rnf b
252+ rnf (Fork a b) = rnf a `seq` rnf b
222253
223254instance Eq e => Eq (Matrix e cols rows) where
224− Empty == Empty = True
225− (One a) == (One b) = a == b
226− (Junc a b) == (Junc c d) = a == c && b == d
227− (Split a b) == (Split c d) = a == c && b == d
228− x@(Split _ _) == y@(Junc _ _) = x == abideJS y
229− x@(Junc _ _) == y@(Split _ _) = abideJS x == y
255+ (One a) == (One b) = a == b
256+ (Join a b) == (Join c d) = a == c && b == d
257+ (Fork a b) == (Fork c d) = a == c && b == d
258+ x@(Fork _ _) == y@(Join _ _) = x == abideJF y
259+ x@(Join _ _) == y@(Fork _ _) = abideJF x == y
230260
231261instance Num e => Num (Matrix e cols rows) where
262+ a + b = zipWithM (+) a b
263+
264+ a - b = zipWithM (-) a b
265+
266+ a * b = zipWithM (*) a b
267+
268+ abs (One a) = One (abs a)
269+ abs (Join a b) = Join (abs a) (abs b)
270+ abs (Fork a b) = Fork (abs a) (abs b)
232271
233− Empty + Empty = Empty
234− (One a) + (One b) = One (a + b)
235− (Junc a b) + (Junc c d) = Junc (a + c) (b + d)
236− (Split a b) + (Split c d) = Split (a + c) (b + d)
237− x@(Split _ _) + y@(Junc _ _) = x + abideJS y
238− x@(Junc _ _) + y@(Split _ _) = abideJS x + y
239−
240− Empty - Empty = Empty
241− (One a) - (One b) = One (a - b)
242− (Junc a b) - (Junc c d) = Junc (a - c) (b - d)
243− (Split a b) - (Split c d) = Split (a - c) (b - d)
244− x@(Split _ _) - y@(Junc _ _) = x - abideJS y
245− x@(Junc _ _) - y@(Split _ _) = abideJS x - y
246−
247− Empty * Empty = Empty
248− (One a) * (One b) = One (a * b)
249− (Junc a b) * (Junc c d) = Junc (a * c) (b * d)
250− (Split a b) * (Split c d) = Split (a * c) (b * d)
251− x@(Split _ _) * y@(Junc _ _) = x * abideJS y
252− x@(Junc _ _) * y@(Split _ _) = abideJS x * y
253−
254− abs Empty = Empty
255− abs (One a) = One (abs a)
256− abs (Junc a b) = Junc (abs a) (abs b)
257− abs (Split a b) = Split (abs a) (abs b)
258−
259− signum Empty = Empty
260− signum (One a) = One (signum a)
261− signum (Junc a b) = Junc (signum a) (signum b)
262− signum (Split a b) = Split (signum a) (signum b)
272+ signum (One a) = One (signum a)
273+ signum (Join a b) = Join (signum a) (signum b)
274+ signum (Fork a b) = Fork (signum a) (signum b)
263275
264276instance Ord e => Ord (Matrix e cols rows) where
265− Empty <= Empty = True
266− (One a) <= (One b) = a <= b
267− (Junc a b) <= (Junc c d) = (a <= c) && (b <= d)
268− (Split a b) <= (Split c d) = (a <= c) && (b <= d)
269− x@(Split _ _) <= y@(Junc _ _) = x <= abideJS y
270− x@(Junc _ _) <= y@(Split _ _) = abideJS x <= y
277+ (One a) <= (One b) = a <= b
278+ (Join a b) <= (Join c d) = (a <= c) && (b <= d)
279+ (Fork a b) <= (Fork c d) = (a <= c) && (b <= d)
280+ x@(Fork _ _) <= y@(Join _ _) = x <= abideJF y
281+ x@(Join _ _) <= y@(Fork _ _) = abideJF x <= y
271282
272283-- Primitives
273284
274−-- | Empty matrix constructor
275−empty :: Matrix e Void Void
276−empty = Empty
277−
278285-- | Unit matrix constructor
279286one :: e -> Matrix e () ()
280287one = One
281288
282−-- | Matrix 'Junc' constructor
283−junc :: Matrix e a rows -> Matrix e b rows -> Matrix e (Either a b) rows
284−junc = Junc
289+-- | Matrix 'Join' constructor
290+join :: Matrix e a rows -> Matrix e b rows -> Matrix e (Either a b) rows
291+join = Join
285292
286293infixl 3 |||
287294
288−-- | Matrix 'Junc' constructor
295+-- | Matrix 'Join' constructor
289296(|||) :: Matrix e a rows -> Matrix e b rows -> Matrix e (Either a b) rows
290−(|||) = Junc
297+(|||) = Join
291298
292−-- | Matrix 'Split' constructor
293−split :: Matrix e cols a -> Matrix e cols b -> Matrix e cols (Either a b)
294−split = Split
299+-- | Matrix 'Fork' constructor
300+fork :: Matrix e cols a -> Matrix e cols b -> Matrix e cols (Either a b)
301+fork = Fork
295302
296303infixl 2 ===
297304
298−-- | Matrix 'Split' constructor
305+-- | Matrix 'Fork' constructor
299306(===) :: Matrix e cols a -> Matrix e cols b -> Matrix e cols (Either a b)
300−(===) = Split
307+(===) = Fork
301308
302309-- Construction
303310
304311-- | Type class for defining the 'fromList' conversion function.
305312--
306313-- Given that it is not possible to branch on types at the term level type
307−-- classes are needed bery much like an inductive definition but on types.
308−class FromLists e cols rows where
314+-- classes are needed very much like an inductive definition but on types.
315+class FromLists cols rows where
309316 -- | Build a matrix out of a list of list of elements. Throws a runtime
310317 -- error if the dimensions do not match.
311318 fromLists :: [[e]] -> Matrix e cols rows
312319
313−instance FromLists e Void Void where
314− fromLists [] = Empty
315− fromLists _ = error "Wrong dimensions"
316−
317−instance {-# OVERLAPPING #-} FromLists e () () where
320+instance FromLists () () where
318321 fromLists [[e]] = One e
319322 fromLists _ = error "Wrong dimensions"
320323
321−instance {-# OVERLAPPING #-} (FromLists e cols ()) => FromLists e (Either () cols) () where
322− fromLists [h : t] = Junc (One h) (fromLists [t])
324+instance (FromLists cols ()) => FromLists (Either () cols) () where
325+ fromLists [h : t] = Join (One h) (fromLists [t])
323326 fromLists _ = error "Wrong dimensions"
324327
325−instance {-# OVERLAPPABLE #-} (FromLists e a (), FromLists e b (), KnownNat (Count a)) => FromLists e (Either a b) () where
326− fromLists [l] =
328+instance {-# OVERLAPPABLE #-}
329+ (FromLists a (), FromLists b (), Countable a) => FromLists (Either a b) () where
330+ fromLists [l] =
327331 let rowsA = fromInteger (natVal (Proxy :: Proxy (Count a)))
328− in Junc (fromLists [take rowsA l]) (fromLists [drop rowsA l])
332+ in Join (fromLists [take rowsA l]) (fromLists [drop rowsA l])
329333 fromLists _ = error "Wrong dimensions"
330334
331−instance {-# OVERLAPPING #-} (FromLists e () rows) => FromLists e () (Either () rows) where
332− fromLists ([h] : t) = Split (One h) (fromLists t)
335+instance (FromLists () rows) => FromLists () (Either () rows) where
336+ fromLists ([h] : t) = Fork (One h) (fromLists t)
333337 fromLists _ = error "Wrong dimensions"
334338
335−instance {-# OVERLAPPABLE #-} (FromLists e () a, FromLists e () b, KnownNat (Count a)) => FromLists e () (Either a b) where
336− fromLists l@([_] : _) =
339+instance {-# OVERLAPPABLE #-}
340+ (FromLists () a, FromLists () b, Countable a) => FromLists () (Either a b) where
341+ fromLists l@([_] : _) =
337342 let rowsA = fromInteger (natVal (Proxy :: Proxy (Count a)))
338− in Split (fromLists (take rowsA l)) (fromLists (drop rowsA l))
343+ in Fork (fromLists (take rowsA l)) (fromLists (drop rowsA l))
339344 fromLists _ = error "Wrong dimensions"
340345
341−instance {-# OVERLAPPABLE #-} (FromLists e (Either a b) c, FromLists e (Either a b) d, KnownNat (Count c)) => FromLists e (Either a b) (Either c d) where
346+instance (FromLists (Either a b) c, FromLists (Either a b) d, Countable c)
347+ => FromLists (Either a b) (Either c d) where
342348 fromLists l@(h : t) =
343349 let lh = length h
344350 rowsC = fromInteger (natVal (Proxy :: Proxy (Count c)))
345− condition = all (== lh) (map length t)
351+ condition = all ((== lh) . length) t
346352 in if lh > 0 && condition
347− then Split (fromLists (take rowsC l)) (fromLists (drop rowsC l))
353+ then Fork (fromLists (take rowsC l)) (fromLists (drop rowsC l))
348354 else error "Not all rows have the same length"
349355
350356-- | Matrix builder function. Constructs a matrix provided with
351−-- a construction function.
352−matrixBuilder ::
357+-- a construction function that operates with indices.
358+matrixBuilder' ::
353359 forall e cols rows.
354− ( FromLists e cols rows,
355− KnownNat (Count cols),
356− KnownNat (Count rows)
357− ) =>
358− ((Int, Int) -> e) ->
359− Matrix e cols rows
360−matrixBuilder f =
360+ ( FL cols rows,
361+ CountableDims cols rows
362+ ) => ((Int, Int) -> e) -> Matrix e cols rows
363+matrixBuilder' f =
361364 let c = fromInteger $ natVal (Proxy :: Proxy (Count cols))
362365 r = fromInteger $ natVal (Proxy :: Proxy (Count rows))
363366 positions = [(a, b) | a <- [0 .. (r - 1)], b <- [0 .. (c - 1)]]
364367 in fromLists . map (map f) . groupBy (\(x, _) (w, _) -> x == w) $ positions
365368
369+-- | Matrix builder function. Constructs a matrix provided with
370+-- a construction function that operates with arbitrary types.
371+matrixBuilder ::
372+ forall e a b.
373+ ( FLN a b,
374+ Enum a,
375+ Enum b,
376+ Bounded a,
377+ Bounded b,
378+ Eq a,
379+ Countable b
380+ ) => ((a, b) -> e) -> Matrix e (Normalize a) (Normalize b)
381+matrixBuilder f =
382+ let r = fromInteger $ natVal (Proxy :: Proxy (Count b))
383+ positions = [(a, b) | a <- [minBound .. maxBound], b <- [minBound .. maxBound]]
384+ in fromLists . map (map f) . transpose . buildList r $ positions
385+ where
386+ buildList _ [] = []
387+ buildList r l = take r l : buildList r (drop r l)
388+
366389-- | Constructs a column vector matrix
367−col :: (FromLists e () rows) => [e] -> Matrix e () rows
390+col :: (FL () rows) => [e] -> Matrix e () rows
368391col = fromLists . map (: [])
369392
370393-- | Constructs a row vector matrix
371−row :: (FromLists e cols ()) => [e] -> Matrix e cols ()
394+row :: (FL cols ()) => [e] -> Matrix e cols ()
372395row = fromLists . (: [])
373396
374397-- | Lifts functions to matrices with arbitrary dimensions.
375398--
376399-- NOTE: Be careful to not ask for a matrix bigger than the cardinality of
377400-- types @a@ or @b@ allows.
378−fromF ::
401+fromF' ::
379402 forall a b cols rows e.
380− ( Bounded a,
381− Bounded b,
382− Enum a,
383− Enum b,
384− Eq b,
385− Num e,
386− Ord e,
387− KnownNat (Count cols),
388− KnownNat (Count rows),
389− FromLists e rows cols
403+ ( Liftable e a b,
404+ CountableDims cols rows,
405+ FL rows cols
390406 ) =>
391407 (a -> b) ->
392408 Matrix e cols rows
393−fromF f =
409+fromF' f =
394410 let minA = minBound @a
395411 maxA = maxBound @a
396412 minB = minBound @b
@@ -400,8 +416,8 @@ fromF f =
400416 elementsA = take ccols [minA .. maxA]
401417 elementsB = take rrows [minB .. maxB]
402418 combinations = (,) <$> elementsA <*> elementsB
403− combAp = map snd . sort . map (\(a, b) -> if f a == b
404− then ((fromEnum a, fromEnum b), 1)
419+ combAp = map snd . sort . map (\(a, b) -> if f a == b
420+ then ((fromEnum a, fromEnum b), 1)
405421 else ((fromEnum a, fromEnum b), 0)) $ combinations
406422 mList = buildList combAp rrows
407423 in tr $ fromLists mList
@@ -411,48 +427,23 @@ fromF f =
411427
412428-- | Lifts functions to matrices with dimensions matching @a@ and @b@
413429-- cardinality's.
414−fromF' ::
430+fromF ::
415431 forall a b e.
416− ( Bounded a,
417− Bounded b,
418− Enum a,
419− Enum b,
420− Eq b,
421− Num e,
422− Ord e,
423− KnownNat (Count (Normalize a)),
424− KnownNat (Count (Normalize b)),
425− FromLists e (Normalize b) (Normalize a)
432+ ( Liftable e a b,
433+ CountableDimsN a b,
434+ FLN b a
426435 ) =>
427436 (a -> b) ->
428437 Matrix e (Normalize a) (Normalize b)
429−fromF' f =
430− let minA = minBound @a
431− maxA = maxBound @a
432− minB = minBound @b
433− maxB = maxBound @b
434− ccols = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize a)))
435− rrows = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize b)))
436− elementsA = take ccols [minA .. maxA]
437− elementsB = take rrows [minB .. maxB]
438− combinations = (,) <$> elementsA <*> elementsB
439− combAp = map snd . sort . map (\(a, b) -> if f a == b
440− then ((fromEnum a, fromEnum b), 1)
441− else ((fromEnum a, fromEnum b), 0)) $ combinations
442− mList = buildList combAp rrows
443− in tr $ fromLists mList
444− where
445− buildList [] _ = []
446− buildList l r = take r l : buildList (drop r l) r
438+fromF = fromF'
447439
448440-- Conversion
449441
450442-- | Converts a matrix to a list of lists of elements.
451443toLists :: Matrix e cols rows -> [[e]]
452−toLists Empty = []
453444toLists (One e) = [[e]]
454−toLists (Split l r) = toLists l ++ toLists r
455−toLists (Junc l r) = zipWith (++) (toLists l) (toLists r)
445+toLists (Fork l r) = toLists l ++ toLists r
446+toLists (Join l r) = zipWith (++) (toLists l) (toLists r)
456447
457448-- | Converts a matrix to a list of elements.
458449toList :: Matrix e cols rows -> [e]
@@ -461,37 +452,38 @@ toList = concat . toLists
461452-- Zeros Matrix
462453
463454-- | The zero matrix. A matrix wholly filled with zeros.
464−zeros :: (Num e, FromLists e cols rows, KnownNat (Count cols), KnownNat (Count rows)) => Matrix e cols rows
465−zeros = matrixBuilder (const 0)
455+zeros :: (Num e, FL cols rows, CountableDims cols rows) => Matrix e cols rows
456+zeros = matrixBuilder' (const 0)
466457
467458-- Ones Matrix
468459
469460-- | The ones matrix. A matrix wholly filled with ones.
470461--
471462-- Also known as T (Top) matrix.
472−ones :: (Num e, FromLists e cols rows, KnownNat (Count cols), KnownNat (Count rows)) => Matrix e cols rows
473−ones = matrixBuilder (const 1)
463+ones :: (Num e, FL cols rows, CountableDims cols rows) => Matrix e cols rows
464+ones = matrixBuilder' (const 1)
474465
475466-- Const Matrix
476467
477468-- | The constant matrix constructor. A matrix wholly filled with a given
478469-- value.
479−constant :: (Num e, FromLists e cols rows, KnownNat (Count cols), KnownNat (Count rows)) => e -> Matrix e cols rows
480−constant e = matrixBuilder (const e)
470+constant :: (Num e, FL cols rows, CountableDims cols rows) => e -> Matrix e cols rows
471+constant e = matrixBuilder' (const e)
481472
482473-- Bang Matrix
483474
484475-- | The T (Top) row vector matrix.
485−bang :: forall e cols. (Num e, Enum e, FromLists e cols (), KnownNat (Count cols)) => Matrix e cols ()
476+bang :: forall e cols. (Num e, Enum e, FL cols (), Countable cols) => Matrix e cols ()
486477bang =
487478 let c = fromInteger $ natVal (Proxy :: Proxy (Count cols))
488479 in fromLists [take c [1, 1 ..]]
489480
490−-- Identity Matrix
481+-- iden Matrix
491482
492−-- | Identity matrix.
493−identity :: (Num e, FromLists e cols cols, KnownNat (Count cols)) => Matrix e cols cols
494−identity = matrixBuilder (bool 0 1 . uncurry (==))
483+-- | iden matrix.
484+iden :: forall e cols . (Num e, FL cols cols, Countable cols) => Matrix e cols cols
485+iden = matrixBuilder' (bool 0 1 . uncurry (==))
486+{-# NOINLINE iden #-}
495487
496488-- Matrix composition (MMM)
497489
@@ -500,60 +492,90 @@ identity = matrixBuilder (bool 0 1 . uncurry (==))
500492-- This definition takes advantage of divide-and-conquer and fusion laws
501493-- from LAoP.
502494comp :: (Num e) => Matrix e cr rows -> Matrix e cols cr -> Matrix e cols rows
503−comp Empty Empty = Empty
504−comp (One a) (One b) = One (a * b)
505−comp (Junc a b) (Split c d) = comp a c + comp b d -- Divide-and-conquer law
506−comp (Split a b) c = Split (comp a c) (comp b c) -- Split fusion law
507−comp c (Junc a b) = Junc (comp c a) (comp c b) -- Junc fusion law
495+comp (One a) (One b) = One (a * b)
496+comp (Join a b) (Fork c d) = comp a c + comp b d -- Divide-and-conquer law
497+comp (Fork a b) c = Fork (comp a c) (comp b c) -- Fork fusion law
498+comp c (Join a b) = Join (comp c a) (comp c b) -- Join fusion law
499+{-# NOINLINE comp #-}
500+{-# RULES
501+ "comp/iden1" forall m. comp m iden = m ;
502+ "comp/iden2" forall m. comp iden m = m
503+#-}
504+
505+-- Scalar multiplication of matrices
506+
507+infixl 7 .|
508+-- | Scalar multiplication of matrices.
509+(.|) :: Num e => e -> Matrix e cols rows -> Matrix e cols rows
510+(.|) e (One a) = One (e * a)
511+(.|) e (Join a b) = Join (e .| a) (e .| b)
512+(.|) e (Fork a b) = Fork (e .| a) (e .| b)
513+
514+-- Scalar division of matrices
515+
516+infixl 7 ./
517+-- | Scalar multiplication of matrices.
518+(./) :: Fractional e => Matrix e cols rows -> e -> Matrix e cols rows
519+(./) (One a) e = One (a / e)
520+(./) (Join a b) e = Join (a ./ e) (b ./ e)
521+(./) (Fork a b) e = Fork (a ./ e) (b ./ e)
508522
509523-- Projections
510524
511525-- | Biproduct first component projection
512−p1 :: forall e m n. (Num e, KnownNat (Count n), KnownNat (Count m), FromLists e n m, FromLists e m m) => Matrix e (Either m n) m
513−p1 =
514− let iden = identity :: Matrix e m m
515− zero = zeros :: Matrix e n m
516− in junc iden zero
526+p1 :: (Num e, CountableDims n m, FL n m, FL m m) => Matrix e (Either m n) m
527+p1 = join id zeros
517528
518529-- | Biproduct second component projection
519−p2 :: forall e m n. (Num e, KnownNat (Count n), KnownNat (Count m), FromLists e m n, FromLists e n n) => Matrix e (Either m n) n
520−p2 =
521− let iden = identity :: Matrix e n n
522− zero = zeros :: Matrix e m n
523− in junc zero iden
530+p2 :: (Num e, CountableDims n m, FL m n, FL n n) => Matrix e (Either m n) n
531+p2 = join zeros id
524532
525533-- Injections
526534
527535-- | Biproduct first component injection
528−i1 :: (Num e, KnownNat (Count n), KnownNat (Count m), FromLists e n m, FromLists e m m) => Matrix e m (Either m n)
536+i1 :: (Num e, CountableDims n m, FL n m, FL m m) => Matrix e m (Either m n)
529537i1 = tr p1
530538
531539-- | Biproduct second component injection
532−i2 :: (Num e, KnownNat (Count n), KnownNat (Count m), FromLists e m n, FromLists e n n) => Matrix e n (Either m n)
540+i2 :: (Num e, CountableDims n m, FL m n, FL n n) => Matrix e n (Either m n)
533541i2 = tr p2
534542
535543-- Dimensions
536544
537545-- | Obtain the number of rows.
538546--
539−-- NOTE: The 'KnownNat' constaint is needed in order to obtain the
540−-- dimensions in constant time.
541−--
542−-- TODO: A 'rows' function that does not need the 'KnownNat' constraint in
543−-- exchange for performance.
544−rows :: forall e cols rows. (KnownNat (Count rows)) => Matrix e cols rows -> Int
547+-- NOTE: The 'KnownNat' constraint is needed in order to obtain the
548+-- dimensions in constant time. For a version that doesn't require the
549+-- constraint see 'rows''.
550+rows :: forall e cols rows. (Countable rows) => Matrix e cols rows -> Int
545551rows _ = fromInteger $ natVal (Proxy :: Proxy (Count rows))
546552
553+-- | Obtain the number of rows in an inefficient manner, but without any
554+-- constraints.
555+--
556+-- For a more efficient version see 'rows'.
557+rows' :: Matrix e cols rows -> Int
558+rows' (One _) = 1
559+rows' (Join lhs _) = rows' lhs
560+rows' (Fork top bottom) = rows' top + rows' bottom
561+
547562-- | Obtain the number of columns.
548−--
549−-- NOTE: The 'KnownNat' constaint is needed in order to obtain the
550−-- dimensions in constant time.
551563--
552−-- TODO: A 'columns' function that does not need the 'KnownNat' constraint in
553−-- exchange for performance.
554−columns :: forall e cols rows. (KnownNat (Count cols)) => Matrix e cols rows -> Int
564+-- NOTE: The 'KnownNat' constraint is needed in order to obtain the
565+-- dimensions in constant time. For a version that doesn't require the
566+-- constraint see 'columns''.
567+columns :: forall e cols rows. (Countable cols) => Matrix e cols rows -> Int
555568columns _ = fromInteger $ natVal (Proxy :: Proxy (Count cols))
556569
570+-- | Obtain the number of columns in an inefficient manner, but without any
571+-- constraints.
572+--
573+-- For a more efficient version see 'columns'.
574+columns' :: Matrix e cols rows -> Int
575+columns' (One _) = 1
576+columns' (Join lhs rhs) = columns' lhs + columns' rhs
577+columns' (Fork top _) = columns' top
578+
557579-- Coproduct Bifunctor
558580
559581infixl 5 -|-
@@ -562,157 +584,172 @@ infixl 5 -|-
562584(-|-) ::
563585 forall e n k m j.
564586 ( Num e,
565− KnownNat (Count j),
566− KnownNat (Count k),
567− FromLists e k k,
568− FromLists e j k,
569− FromLists e k j,
570− FromLists e j j
587+ CountableDims j k,
588+ FL k k,
589+ FL j k,
590+ FL k j,
591+ FL j j
571592 ) =>
572593 Matrix e n k ->
573594 Matrix e m j ->
574595 Matrix e (Either n m) (Either k j)
575−(-|-) a b = Junc (i1 . a) (i2 . b)
596+(-|-) a b = Join (i1 . a) (i2 . b)
576597
577598-- Khatri Rao Product and projections
578599
579600-- | Khatri Rao product first component projection matrix.
580−kp1 ::
601+fstM ::
581602 forall e m k .
582603 ( Num e,
583− KnownNat (Count k),
584− FromLists e (FromNat (Count m * Count k)) m,
585− KnownNat (Count m),
586− KnownNat (Count (Normalize (m, k)))
604+ CountableDims k m,
605+ FL (Normalize (m, k)) m,
606+ CountableN (m, k)
587607 ) => Matrix e (Normalize (m, k)) m
588−kp1 = matrixBuilder f
608+fstM = matrixBuilder' f
589609 where
590610 offset = fromInteger (natVal (Proxy :: Proxy (Count k)))
591611 f (x, y)
592612 | y >= (x * offset) && y <= (x * offset + offset - 1) = 1
593− | otherwise = 0
613+ | otherwise = 0
594614
595615-- | Khatri Rao product second component projection matrix.
596−kp2 ::
616+sndM ::
597617 forall e m k .
598618 ( Num e,
599− KnownNat (Count k),
600− FromLists e (FromNat (Count m * Count k)) k,
601− KnownNat (Count m),
602− KnownNat (Count (Normalize (m, k)))
619+ CountableDims k m,
620+ FL (Normalize (m, k)) k,
621+ CountableN (m, k)
603622 ) => Matrix e (Normalize (m, k)) k
604−kp2 = matrixBuilder f
623+sndM = matrixBuilder' f
605624 where
606625 offset = fromInteger (natVal (Proxy :: Proxy (Count k)))
607626 f (x, y)
608627 | x == y || mod (y - x) offset == 0 = 1
609− | otherwise = 0
628+ | otherwise = 0
610629
611630-- | Khatri Rao Matrix product also known as matrix pairing.
612631--
613632-- NOTE: That this is not a true categorical product, see for instance:
614−--
633+--
615634-- @
616−-- | kp1 . khatri a b == a
617−-- khatri a b ==> |
618−-- | kp2 . khatri a b == b
635+-- | fstM . kr a b == a
636+-- kr a b ==> |
637+-- | sndM . kr a b == b
619638-- @
620639--
621640-- __Emphasis__ on the implication symbol.
622−khatri ::
623− forall e cols a b.
641+kr ::
642+ forall e cols a b.
624643 ( Num e,
625− KnownNat (Count a),
626− KnownNat (Count b),
627− KnownNat (Count (Normalize (a, b))),
628− FromLists e (Normalize (a, b)) a,
629− FromLists e (Normalize (a, b)) b
644+ CountableDims a b,
645+ CountableN (a, b),
646+ FL (Normalize (a, b)) a,
647+ FL (Normalize (a, b)) b
630648 ) => Matrix e cols a -> Matrix e cols b -> Matrix e cols (Normalize (a, b))
631−khatri a b =
632− let kp1' = kp1 @e @a @b
633− kp2' = kp2 @e @a @b
634− in (tr kp1') . a * (tr kp2') . b
649+kr a b =
650+ let fstM' = fstM @e @a @b
651+ sndM' = sndM @e @a @b
652+ in (tr fstM' . a) * (tr sndM' . b)
635653
636654-- Product Bifunctor (Kronecker)
637655
638656infixl 4 ><
639657
640658-- | Matrix product functor also known as kronecker product
641−(><) ::
642− forall e m p n q.
659+(><) ::
660+ forall e m p n q.
643661 ( Num e,
644− KnownNat (Count m),
645− KnownNat (Count n),
646− KnownNat (Count p),
647− KnownNat (Count q),
648− KnownNat (Count (Normalize (m, n))),
649− FromLists e (Normalize (m, n)) m,
650− FromLists e (Normalize (m, n)) n,
651− KnownNat (Count (Normalize (p, q))),
652− FromLists e (Normalize (p, q)) p,
653− FromLists e (Normalize (p, q)) q
654− )
662+ CountableDims m n,
663+ CountableDims p q,
664+ CountableDimsN (m, n) (p, q),
665+ FL (Normalize (m, n)) m,
666+ FL (Normalize (m, n)) n,
667+ FL (Normalize (p, q)) p,
668+ FL (Normalize (p, q)) q
669+ )
655670 => Matrix e m p -> Matrix e n q -> Matrix e (Normalize (m, n)) (Normalize (p, q))
656671(><) a b =
657− let kp1' = kp1 @e @m @n
658− kp2' = kp2 @e @m @n
659− in khatri (a . kp1') (b . kp2')
672+ let fstM' = fstM @e @m @n
673+ sndM' = sndM @e @m @n
674+ in kr (a . fstM') (b . sndM')
660675
661−-- Matrix abide Junc Split
676+-- Matrix abide Join Fork
662677
663−-- | Matrix "abiding" followin the 'Junc'-'Split' abide law.
664−--
678+-- | Matrix "abiding" following the 'Join'-'Fork' exchange law.
679+--
665680-- Law:
666681--
667682-- @
668−-- 'Junc' ('Split' a c) ('Split' b d) == 'Split' ('Junc' a b) ('Junc' c d)
683+-- 'Join' ('Fork' a c) ('Fork' b d) == 'Fork' ('Join' a b) ('Join' c d)
669684-- @
670−abideJS :: Matrix e cols rows -> Matrix e cols rows
671−abideJS (Junc (Split a c) (Split b d)) = Split (Junc (abideJS a) (abideJS b)) (Junc (abideJS c) (abideJS d)) -- Junc-Split abide law
672−abideJS Empty = Empty
673−abideJS (One e) = One e
674−abideJS (Junc a b) = Junc (abideJS a) (abideJS b)
675−abideJS (Split a b) = Split (abideJS a) (abideJS b)
685+abideJF :: Matrix e cols rows -> Matrix e cols rows
686+abideJF (Join (Fork a c) (Fork b d)) = Fork (Join (abideJF a) (abideJF b)) (Join (abideJF c) (abideJF d)) -- Join-Fork abide law
687+abideJF (One e) = One e
688+abideJF (Join a b) = Join (abideJF a) (abideJF b)
689+abideJF (Fork a b) = Fork (abideJF a) (abideJF b)
676690
677−-- Matrix abide Split Junc
691+-- Matrix abide Fork Join
678692
679−-- | Matrix "abiding" followin the 'Split'-'Junc' abide law.
680−--
693+-- | Matrix "abiding" followin the 'Fork'-'Join' abide law.
694+--
681695-- @
682−-- 'Split' ('Junc' a b) ('Junc' c d) == 'Junc' ('Split' a c) ('Split' b d)
696+-- 'Fork' ('Join' a b) ('Join' c d) == 'Join' ('Fork' a c) ('Fork' b d)
683697-- @
684−abideSJ :: Matrix e cols rows -> Matrix e cols rows
685−abideSJ (Split (Junc a b) (Junc c d)) = Junc (Split (abideSJ a) (abideSJ c)) (Split (abideSJ b) (abideSJ d)) -- Split-Junc abide law
686−abideSJ Empty = Empty
687−abideSJ (One e) = One e
688−abideSJ (Junc a b) = Junc (abideSJ a) (abideSJ b)
689−abideSJ (Split a b) = Split (abideSJ a) (abideSJ b)
698+abideFJ :: Matrix e cols rows -> Matrix e cols rows
699+abideFJ (Fork (Join a b) (Join c d)) = Join (Fork (abideFJ a) (abideFJ c)) (Fork (abideFJ b) (abideFJ d)) -- Fork-Join abide law
700+abideFJ (One e) = One e
701+abideFJ (Join a b) = Join (abideFJ a) (abideFJ b)
702+abideFJ (Fork a b) = Fork (abideFJ a) (abideFJ b)
690703
691704-- Matrix transposition
692705
693706-- | Matrix transposition.
694707tr :: Matrix e cols rows -> Matrix e rows cols
695−tr Empty = Empty
696−tr (One e) = One e
697−tr (Junc a b) = Split (tr a) (tr b)
698−tr (Split a b) = Junc (tr a) (tr b)
708+tr (One e) = One e
709+tr (Join a b) = Fork (tr a) (tr b)
710+tr (Fork a b) = Join (tr a) (tr b)
699711
700712-- Selective 'select' operator
701713
702714-- | Selective functors 'select' operator equivalent inspired by the
703715-- ArrowMonad solution presented in the paper.
704−select :: (Num e, FromLists e b b, KnownNat (Count b)) => Matrix e cols (Either a b) -> Matrix e a b -> Matrix e cols b
705−select m y = junc y identity . m
716+select :: (Num e, FL b b, Countable b) => Matrix e cols (Either a b) -> Matrix e a b -> Matrix e cols b
717+select (Fork a b) y = y . a + b -- Divide-and-conquer law
718+select (Join (Fork a c) (Fork b d)) y = join (y . a + c) (y . b + d) -- Pattern matching + DnC law
719+select m y = join y id . m
720+
721+branch ::
722+ ( Num e,
723+ CountableDims a b,
724+ CountableDims c (Either b c),
725+ FL c b,
726+ FL a b,
727+ FL a a,
728+ FL b b,
729+ FL c c,
730+ FL b a,
731+ FL b c,
732+ FL (Either b c) b,
733+ FL (Either b c) c
734+ )
735+ => Matrix e cols (Either a b) -> Matrix e a c -> Matrix e b c -> Matrix e cols c
736+branch x l r = f x `select` g l `select` r
737+ where
738+ f :: (Num e, Countable a, CountableDims b c, FL a b, FL c b, FL b b, FL b a, FL a a)
739+ => Matrix e cols (Either a b) -> Matrix e cols (Either a (Either b c))
740+ f m = fork (tr i1) (i1 . tr i2) . m
741+ g :: (Num e, CountableDims b c, FL b c, FL c c) => Matrix e a c -> Matrix e a (Either b c)
742+ g m = i2 . m
706743
707744-- McCarthy's Conditional
708745
709746-- | McCarthy's Conditional expresses probabilistic choice.
710747cond ::
711− ( cols ~ FromNat (Count cols),
712− KnownNat (Count cols),
713− FromLists e () cols,
714− FromLists e cols (),
715− FromLists e cols cols,
748+ ( Trivial cols,
749+ Countable cols,
750+ FL () cols,
751+ FL cols (),
752+ FL cols cols,
716753 Bounded a,
717754 Enum a,
718755 Num e,
@@ -720,14 +757,14 @@ cond ::
720757 )
721758 =>
722759 (a -> Bool) -> Matrix e cols rows -> Matrix e cols rows -> Matrix e cols rows
723−cond p f g = junc f g . grd p
724−
725−grd ::
726− ( q ~ FromNat (Count q),
727− KnownNat (Count q),
728− FromLists e () q,
729− FromLists e q (),
730− FromLists e q q,
760+cond p f g = join f g . grd p
761+
762+grd ::
763+ ( Trivial q,
764+ Countable q,
765+ FL () q,
766+ FL q (),
767+ FL q q,
731768 Bounded a,
732769 Enum a,
733770 Num e,
@@ -735,63 +772,86 @@ grd ::
735772 )
736773 =>
737774 (a -> Bool) -> Matrix e q (Either q q)
738−grd f = split (corr f) (corr (not . f))
739−
740−corr ::
741− forall e a q .
742− ( q ~ FromNat (Count q),
743− KnownNat (Count q),
744− FromLists e () q,
745− FromLists e q (),
746− FromLists e q q,
747− Bounded a,
748− Enum a,
749− Num e,
750− Ord e
751− )
775+grd f = fork (corr f) (corr (not . f))
776+
777+corr ::
778+ forall e a q .
779+ ( Trivial q,
780+ Countable q,
781+ FL () q,
782+ FL q (),
783+ FL q q,
784+ Liftable e a Bool
785+ )
752786 => (a -> Bool) -> Matrix e q q
753−corr p = let f = fromF p :: Matrix e q ()
754− in khatri f (identity :: Matrix e q q)
787+corr p = let f = fromF' p :: Matrix e q ()
788+ in kr f (id :: Matrix e q q)
755789
756790-- Pretty print
757791
758792prettyAux :: Show e => [[e]] -> [[e]] -> String
759793prettyAux [] _ = ""
760−prettyAux [[e]] m = "│ " ++ fill (show e) ++ " │\n"
794+prettyAux [[e]] m = "│ " ++ fill (show e) ++ " │\n"
761795 where
762796 v = fmap show m
763797 widest = maximum $ fmap length v
764798 fill str = replicate (widest - length str - 2) ' ' ++ str
765−prettyAux [h] m = "│ " ++ fill (unwords $ map show h) ++ " │\n"
799+prettyAux [h] m = "│ " ++ fill (unwords $ map show h) ++ " │\n"
766800 where
767− v = fmap show m
768− widest = maximum $ fmap length v
801+ v = fmap show m
802+ widest = maximum $ fmap length v
769803 fill str = replicate (widest - length str - 2) ' ' ++ str
770−prettyAux (h : t) l = "│ " ++ fill (unwords $ map show h) ++ " │\n" ++
804+prettyAux (h : t) l = "│ " ++ fill (unwords $ map show h) ++ " │\n" ++
771805 prettyAux t l
772806 where
773− v = fmap show l
774− widest = maximum $ fmap length v
807+ v = fmap show l
808+ widest = maximum $ fmap length v
775809 fill str = replicate (widest - length str - 2) ' ' ++ str
776810
777811-- | Matrix pretty printer
778−pretty :: (KnownNat (Count cols), Show e) => Matrix e cols rows -> String
779−pretty m = "┌ " ++ unwords (replicate (columns m) blank) ++ " ┐\n" ++
780− prettyAux (toLists m) (toLists m) ++
781− "└ " ++ unwords (replicate (columns m) blank) ++ " ┘"
782− where
783− v = fmap show (toList m)
784− widest = maximum $ fmap length v
812+pretty :: (CountableDims cols rows, Show e) => Matrix e cols rows -> String
813+pretty m = concat
814+ [ "┌ ", unwords (replicate (columns m) blank), " ┐\n"
815+ , unlines
816+ [ "│ " ++ unwords (fmap (\j -> fill $ show $ getElem i j m) [1..columns m]) ++ " │" | i <- [1..rows m] ]
817+ , "└ ", unwords (replicate (columns m) blank), " ┘"
818+ ]
819+ where
820+ strings = map show (toList m)
821+ widest = maximum $ map length strings
785822 fill str = replicate (widest - length str) ' ' ++ str
786− blank = fill ""
823+ blank = fill ""
824+ safeGet i j m
825+ | i > rows m || j > columns m || i < 1 || j < 1 = Nothing
826+ | otherwise = Just $ unsafeGet i j m (toList m)
827+ unsafeGet i j m l = l !! encode (columns m) (i,j)
828+ encode m (i,j) = (i-1)*m + j - 1
829+ getElem i j m =
830+ fromMaybe
831+ (error $
832+ "getElem: Trying to get the "
833+ ++ show (i, j)
834+ ++ " element from a "
835+ ++ show (rows m) ++ "x" ++ show (columns m)
836+ ++ " matrix."
837+ )
838+ (safeGet i j m)
787839
788840-- | Matrix pretty printer
789−prettyPrint :: (KnownNat (Count cols), Show e) => Matrix e cols rows -> IO ()
841+prettyPrint :: (CountableDims cols rows, Show e) => Matrix e cols rows -> IO ()
790842prettyPrint = putStrLn . pretty
791843
844+-- | Zip two matrices with a given binary function
845+zipWithM :: (e -> f -> g) -> Matrix e cols rows -> Matrix f cols rows -> Matrix g cols rows
846+zipWithM f (One a) (One b) = One (f a b)
847+zipWithM f (Join a b) (Join c d) = Join (zipWithM f a c) (zipWithM f b d)
848+zipWithM f (Fork a b) (Fork c d) = Fork (zipWithM f a c) (zipWithM f b d)
849+zipWithM f x@(Fork _ _) y@(Join _ _) = zipWithM f x (abideJF y)
850+zipWithM f x@(Join _ _) y@(Fork _ _) = zipWithM f (abideJF x) y
851+
792852-- Relational operators functions
793853
794−type Boolean = Natural 0 1
854+type Boolean = Natural 0 1
795855type Relation a b = Matrix Boolean a b
796856
797857-- | Helper conversion function
@@ -807,54 +867,47 @@ fromBool False = nat 0
807867
808868-- | Relational negation
809869negateM :: Relation cols rows -> Relation cols rows
810−negateM Empty = Empty
811−negateM (One (Nat 0)) = One (Nat 1)
812−negateM (One (Nat 1)) = One (Nat 0)
813−negateM (Junc a b) = Junc (negateM a) (negateM b)
814−negateM (Split a b) = Split (negateM a) (negateM b)
870+negateM (One (Nat p)) = One (Nat (negate p))
871+negateM (Join a b) = Join (negateM a) (negateM b)
872+negateM (Fork a b) = Fork (negateM a) (negateM b)
815873
816874-- | Relational addition
817875orM :: Relation cols rows -> Relation cols rows -> Relation cols rows
818−orM Empty Empty = Empty
819−orM (One a) (One b) = One (fromBool (toBool a || toBool b))
820−orM (Junc a b) (Junc c d) = Junc (orM a c) (orM b d)
821−orM (Split a b) (Split c d) = Split (orM a c) (orM b d)
822−orM x@(Split _ _) y@(Junc _ _) = orM x (abideJS y)
823−orM x@(Junc _ _) y@(Split _ _) = orM (abideJS x) y
876+orM (One a) (One b) = One (fromBool (toBool a || toBool b))
877+orM (Join a b) (Join c d) = Join (orM a c) (orM b d)
878+orM (Fork a b) (Fork c d) = Fork (orM a c) (orM b d)
879+orM x@(Fork _ _) y@(Join _ _) = orM x (abideJF y)
880+orM x@(Join _ _) y@(Fork _ _) = orM (abideJF x) y
824881
825882-- | Relational multiplication
826883andM :: Relation cols rows -> Relation cols rows -> Relation cols rows
827−andM Empty Empty = Empty
828−andM (One a) (One b) = One (fromBool (toBool a && toBool b))
829−andM (Junc a b) (Junc c d) = Junc (andM a c) (andM b d)
830−andM (Split a b) (Split c d) = Split (andM a c) (andM b d)
831−andM x@(Split _ _) y@(Junc _ _) = andM x (abideJS y)
832−andM x@(Junc _ _) y@(Split _ _) = andM (abideJS x) y
884+andM (One a) (One b) = One (fromBool (toBool a && toBool b))
885+andM (Join a b) (Join c d) = Join (andM a c) (andM b d)
886+andM (Fork a b) (Fork c d) = Fork (andM a c) (andM b d)
887+andM x@(Fork _ _) y@(Join _ _) = andM x (abideJF y)
888+andM x@(Join _ _) y@(Fork _ _) = andM (abideJF x) y
833889
834890-- | Relational subtraction
835891subM :: Relation cols rows -> Relation cols rows -> Relation cols rows
836−subM Empty Empty = Empty
837−subM (One a) (One b) = if a - b < nat 0 then One (nat 0) else One (a - b)
838−subM (Junc a b) (Junc c d) = Junc (subM a c) (subM b d)
839−subM (Split a b) (Split c d) = Split (subM a c) (subM b d)
840−subM x@(Split _ _) y@(Junc _ _) = subM x (abideJS y)
841−subM x@(Junc _ _) y@(Split _ _) = subM (abideJS x) y
892+subM (One a) (One b) = if a - b < nat 0 then One (nat 0) else One (a - b)
893+subM (Join a b) (Join c d) = Join (subM a c) (subM b d)
894+subM (Fork a b) (Fork c d) = Fork (subM a c) (subM b d)
895+subM x@(Fork _ _) y@(Join _ _) = subM x (abideJF y)
896+subM x@(Join _ _) y@(Fork _ _) = subM (abideJF x) y
842897
843898-- | Matrix relational composition.
844899compRel :: Relation cr rows -> Relation cols cr -> Relation cols rows
845−compRel Empty Empty = Empty
846−compRel (One a) (One b) = One (fromBool (toBool a && toBool b))
847−compRel (Junc a b) (Split c d) = orM (compRel a c) (compRel b d) -- Divide-and-conquer law
848−compRel (Split a b) c = Split (compRel a c) (compRel b c) -- Split fusion law
849−compRel c (Junc a b) = Junc (compRel c a) (compRel c b) -- Junc fusion law
900+compRel (One a) (One b) = One (fromBool (toBool a && toBool b))
901+compRel (Join a b) (Fork c d) = orM (compRel a c) (compRel b d) -- Divide-and-conquer law
902+compRel (Fork a b) c = Fork (compRel a c) (compRel b c) -- Fork fusion law
903+compRel c (Join a b) = Join (compRel c a) (compRel c b) -- Join fusion law
850904
851905-- | Matrix relational right division
852906divR :: Relation b c -> Relation b a -> Relation a c
853−divR Empty Empty = Empty
854907divR (One a) (One b) = One (fromBool (not (toBool b) || toBool a)) -- b implies a
855−divR (Junc a b) (Junc c d) = andM (divR a c) (divR b d)
856−divR (Split a b) c = Split (divR a c) (divR b c)
857−divR c (Split a b) = Junc (divR c a) (divR c b)
908+divR (Join a b) (Join c d) = andM (divR a c) (divR b d)
909+divR (Fork a b) c = Fork (divR a c) (divR b c)
910+divR c (Fork a b) = Join (divR c a) (divR c b)
858911
859912-- | Matrix relational left division
860913divL :: Relation c b -> Relation a b -> Relation a c
@@ -870,97 +923,52 @@ divS s r = divL r s `intersection` divR (tr r) (tr s)
870923--
871924-- NOTE: Be careful to not ask for a relation bigger than the cardinality of
872925-- types @a@ or @b@ allows.
873−fromFRel ::
926+fromFRel' ::
874927 forall a b cols rows.
875− ( Bounded a,
876− Bounded b,
877− Enum a,
878− Enum b,
879− Eq b,
880− KnownNat (Count cols),
881− KnownNat (Count rows),
882− FromLists (Natural 0 1) rows cols
928+ ( Liftable Boolean a b,
929+ CountableDims cols rows,
930+ FL rows cols
883931 ) =>
884932 (a -> b) ->
885933 Relation cols rows
886−fromFRel f =
887− let minA = minBound @a
888− maxA = maxBound @a
889− minB = minBound @b
890− maxB = maxBound @b
891− ccols = fromInteger $ natVal (Proxy :: Proxy (Count cols))
892− rrows = fromInteger $ natVal (Proxy :: Proxy (Count rows))
893− elementsA = take ccols [minA .. maxA]
894− elementsB = take rrows [minB .. maxB]
895− combinations = (,) <$> elementsA <*> elementsB
896− combAp = map snd . sort . map (\(a, b) -> if f a == b
897− then ((fromEnum a, fromEnum b), nat 1)
898− else ((fromEnum a, fromEnum b), nat 0)) $ combinations
899− mList = buildList combAp rrows
900− in tr $ fromLists mList
901− where
902− buildList [] _ = []
903− buildList l r = take r l : buildList (drop r l) r
934+fromFRel' = fromF'
904935
905936-- | Lifts functions to relations with dimensions matching @a@ and @b@
906937-- cardinality's.
907−fromFRel' ::
938+fromFRel ::
908939 forall a b.
909− ( Bounded a,
910− Bounded b,
911− Enum a,
912− Enum b,
913− Eq b,
914− KnownNat (Count (Normalize a)),
915− KnownNat (Count (Normalize b)),
916− FromLists (Natural 0 1) (Normalize b) (Normalize a)
940+ ( Liftable Boolean a b,
941+ CountableDimsN a b,
942+ FLN b a
917943 ) =>
918944 (a -> b) ->
919945 Relation (Normalize a) (Normalize b)
920−fromFRel' f =
921− let minA = minBound @a
922− maxA = maxBound @a
923− minB = minBound @b
924− maxB = maxBound @b
925− ccols = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize a)))
926− rrows = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize b)))
927− elementsA = take ccols [minA .. maxA]
928− elementsB = take rrows [minB .. maxB]
929− combinations = (,) <$> elementsA <*> elementsB
930− combAp = map snd . sort . map (\(a, b) -> if f a == b
931− then ((fromEnum a, fromEnum b), nat 1)
932− else ((fromEnum a, fromEnum b), nat 0)) $ combinations
933− mList = buildList combAp rrows
934− in tr $ fromLists mList
935− where
936− buildList [] _ = []
937− buildList l r = take r l : buildList (drop r l) r
946+fromFRel = fromFRel'
938947
939948-- | Lifts a relation function to a Boolean Matrix
940−toRel ::
949+toRel ::
941950 forall a b.
942951 ( Bounded a,
943952 Bounded b,
944953 Enum a,
945954 Enum b,
946955 Eq b,
947− KnownNat (Count (Normalize a)),
948− KnownNat (Count (Normalize b)),
949− FromLists (Natural 0 1) (Normalize b) (Normalize a)
950− )
956+ CountableDims a b,
957+ FLN b a
958+ )
951959 => (a -> b -> Bool) -> Relation (Normalize a) (Normalize b)
952960toRel f =
953961 let minA = minBound @a
954962 maxA = maxBound @a
955963 minB = minBound @b
956964 maxB = maxBound @b
957− ccols = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize a)))
958− rrows = fromInteger $ natVal (Proxy :: Proxy (Count (Normalize b)))
965+ ccols = fromInteger $ natVal (Proxy :: Proxy (Count a))
966+ rrows = fromInteger $ natVal (Proxy :: Proxy (Count b))
959967 elementsA = take ccols [minA .. maxA]
960968 elementsB = take rrows [minB .. maxB]
961969 combinations = (,) <$> elementsA <*> elementsB
962− combAp = map snd . sort . map (\(a, b) -> if uncurry f (a, b)
963− then ((fromEnum a, fromEnum b), nat 1)
970+ combAp = map snd . sort . map (\(a, b) -> if uncurry f (a, b)
971+ then ((fromEnum a, fromEnum b), nat 1)
964972 else ((fromEnum a, fromEnum b), nat 0)) $ combinations
965973 mList = buildList combAp rrows
966974 in tr $ fromLists mList
src/LAoP/Matrix/Nat.hs+194−187
@@ -1,3 +1,4 @@
1+{-# LANGUAGE ConstraintKinds #-}
12{-# LANGUAGE AllowAmbiguousTypes #-}
23{-# LANGUAGE DataKinds #-}
34{-# LANGUAGE DerivingVia #-}
@@ -53,11 +54,22 @@ module LAoP.Matrix.Nat
5354 -- * Type safe matrix representation
5455 Matrix (..),
5556
57+ -- * Constraint type synonyms
58+ Countable,
59+ CountableDims,
60+ CountableN,
61+ CountableNz,
62+ CountableDimsN,
63+ FLN,
64+ FLNz,
65+ Liftable,
66+ TrivialE,
67+ TrivialP,
68+
5669 -- * Primitives
57− empty,
5870 one,
59− junc,
60− split,
71+ join,
72+ fork,
6173
6274 -- * Auxiliary type families
6375 I.FromNat,
@@ -65,11 +77,11 @@ module LAoP.Matrix.Nat
6577 I.Normalize,
6678
6779 -- * Matrix construction and conversion
68− I.FromLists,
80+ I.FL,
6981 fromLists,
7082 toLists,
7183 toList,
72− matrixBuilder,
84+ matrixBuilder',
7385 row,
7486 col,
7587 zeros,
@@ -85,6 +97,10 @@ module LAoP.Matrix.Nat
8597 -- ** Matrix Transposition
8698 tr,
8799
100+ -- ** Scalar multiplication/division of matrices
101+ (.|),
102+ (./),
103+
88104 -- ** Selective operator
89105 select,
90106
@@ -92,16 +108,19 @@ module LAoP.Matrix.Nat
92108 cond,
93109
94110 -- ** Matrix "abiding"
95− abideJS,
96− abideSJ,
111+ abideJF,
112+ abideFJ,
113+
114+ -- ** Zip Matrices
115+ zipWithM,
97116
98117 -- * Biproduct approach
99− -- ** Split
118+ -- ** Fork
100119 (===),
101120 -- *** Projections
102121 p1,
103122 p2,
104− -- ** Junc
123+ -- ** Join
105124 (|||),
106125 -- *** Injections
107126 i1,
@@ -115,11 +134,11 @@ module LAoP.Matrix.Nat
115134 -- | Note that given the restrictions imposed it is not possible to
116135 -- implement the standard type classes present in standard Haskell.
117136 -- *** Matrix pairing projections
118− kp1,
119− kp2,
137+ fstM,
138+ sndM,
120139
121140 -- *** Matrix pairing
122− khatri,
141+ kr,
123142
124143 -- * Matrix composition and lifting
125144
@@ -127,10 +146,10 @@ module LAoP.Matrix.Nat
127146
128147 -- | Note that given the restrictions imposed it is not possible to
129148 -- implement the standard type classes present in standard Haskell.
130− identity,
149+ iden,
131150 comp,
132− fromF,
133151 fromF',
152+ fromF,
134153
135154 -- * Matrix printing
136155 pretty,
@@ -141,107 +160,95 @@ where
141160import Data.Proxy
142161import GHC.TypeLits
143162import Control.DeepSeq
144−import qualified Control.Category as C
145163import qualified LAoP.Matrix.Internal as I
146164
147165newtype Matrix e (cols :: Nat) (rows :: Nat) = M (I.Matrix e (I.FromNat cols) (I.FromNat rows))
148166 deriving (Show, Num, Eq, Ord, NFData) via (I.Matrix e (I.FromNat cols) (I.FromNat rows))
149167
150−-- | It isn't possible to implement the 'id' function so it's
151−-- implementation is 'undefined'. However 'comp' can be and this partial
152−-- class implementation exists just to make the code more readable.
153−--
154−-- Please use 'identity' instead.
155−instance (Num e) => C.Category (Matrix e) where
156− id = undefined
157− (.) = comp
168+-- | Constraint type synonyms to keep the type signatures less convoluted
169+type Countable a = KnownNat (I.Count a)
170+type CountableDims a b = (Countable a, Countable b)
171+type CountableN a = KnownNat (I.Count (I.FromNat a))
172+type CountableNz a = KnownNat (I.Count (I.Normalize a))
173+type CountableDimsN a b = (CountableN a, CountableN b)
174+type FLN e a b = I.FL (I.FromNat a) (I.FromNat b)
175+type FLNz e a b = I.FL (I.Normalize a) (I.Normalize b)
176+type Liftable e a b = (Bounded a, Bounded b, Enum a, Enum b, Eq b, Num e, Ord e)
177+type TrivialE a b = I.FromNat (a + b) ~ Either (I.FromNat a) (I.FromNat b)
178+type TrivialP a b = I.FromNat (a * b) ~ I.FromNat (I.Count (I.FromNat a) * I.Count (I.FromNat b))
158179
159180-- Primitives
160181
161−empty :: Matrix e 0 0
162−empty = M I.Empty
163−
164182one :: e -> Matrix e 1 1
165183one = M . I.One
166184
167−junc ::
168− (I.FromNat cols3 ~ Either (I.FromNat cols1) (I.FromNat cols2)) =>
169− Matrix e cols1 rows ->
170− Matrix e cols2 rows ->
171− Matrix e cols3 rows
172−junc (M a) (M b) = M (I.Junc a b)
185+join ::
186+ (TrivialE a b) =>
187+ Matrix e a rows ->
188+ Matrix e b rows ->
189+ Matrix e (a + b) rows
190+join (M a) (M b) = M (I.Join a b)
173191
174192infixl 3 |||
175193(|||) ::
176− (I.FromNat cols3 ~ Either (I.FromNat cols1) (I.FromNat cols2)) =>
177− Matrix e cols1 rows ->
178− Matrix e cols2 rows ->
179− Matrix e cols3 rows
180−(|||) = junc
181−
182−split ::
183− (I.FromNat rows3 ~ Either (I.FromNat rows1) (I.FromNat rows2)) =>
184− Matrix e cols rows1 ->
185− Matrix e cols rows2 ->
186− Matrix e cols rows3
187−split (M a) (M b) = M (I.Split a b)
194+ (TrivialE a b) =>
195+ Matrix e a rows ->
196+ Matrix e b rows ->
197+ Matrix e (a + b) rows
198+(|||) = join
199+
200+fork ::
201+ (TrivialE a b) =>
202+ Matrix e cols a ->
203+ Matrix e cols b ->
204+ Matrix e cols (a + b)
205+fork (M a) (M b) = M (I.Fork a b)
188206
189207infixl 2 ===
190208(===) ::
191− (I.FromNat rows3 ~ Either (I.FromNat rows1) (I.FromNat rows2)) =>
192− Matrix e cols rows1 ->
193− Matrix e cols rows2 ->
194− Matrix e cols rows3
195−(===) = split
209+ (TrivialE a b) =>
210+ Matrix e cols a ->
211+ Matrix e cols b ->
212+ Matrix e cols (a + b)
213+(===) = fork
196214
197215-- Construction
198216
199−fromLists :: (I.FromLists e (I.FromNat cols) (I.FromNat rows)) => [[e]] -> Matrix e cols rows
217+fromLists :: (FLN e cols rows) => [[e]] -> Matrix e cols rows
200218fromLists = M . I.fromLists
201219
202−matrixBuilder ::
203− (I.FromLists e (I.FromNat cols) (I.FromNat rows), KnownNat (I.Count (I.FromNat cols)), KnownNat (I.Count (I.FromNat rows))) =>
204− ((Int, Int) -> e) ->
205− Matrix e cols rows
206−matrixBuilder = M . I.matrixBuilder
220+-- | Matrix builder function. Constructs a matrix provided with
221+-- a construction function that operates with indices.
222+matrixBuilder' ::
223+ (FLN e cols rows, CountableN cols, CountableN rows)
224+ => ((Int, Int) -> e) -> Matrix e cols rows
225+matrixBuilder' = M . I.matrixBuilder'
207226
208−col :: (I.FromLists e () (I.FromNat rows)) => [e] -> Matrix e 1 rows
227+col :: (I.FL () (I.FromNat rows)) => [e] -> Matrix e 1 rows
209228col = M . I.col
210229
211−row :: (I.FromLists e (I.FromNat cols) ()) => [e] -> Matrix e cols 1
230+row :: (I.FL (I.FromNat cols) ()) => [e] -> Matrix e cols 1
212231row = M . I.row
213232
214−fromF ::
215− ( Bounded a,
216− Bounded b,
217− Enum a,
218− Enum b,
219− Eq b,
220− Num e,
221− Ord e,
222− KnownNat (I.Count (I.FromNat cols)),
223− KnownNat (I.Count (I.FromNat rows)),
224− I.FromLists e (I.FromNat rows) (I.FromNat cols)
233+fromF' ::
234+ ( Liftable e a b,
235+ CountableN cols,
236+ CountableN rows,
237+ FLN e rows cols
225238 ) =>
226239 (a -> b) ->
227240 Matrix e cols rows
228−fromF = M . I.fromF
241+fromF' = M . I.fromF'
229242
230−fromF' ::
231− ( Bounded a,
232− Bounded b,
233− Enum a,
234− Enum b,
235− Eq b,
236− Num e,
237− Ord e,
238− KnownNat (I.Count (I.Normalize a)),
239− KnownNat (I.Count (I.Normalize b)),
240− I.FromLists e (I.Normalize b) (I.Normalize a)
243+fromF ::
244+ ( Liftable e a b,
245+ CountableNz a,
246+ CountableNz b,
247+ FLNz e b a
241248 ) =>
242249 (a -> b) ->
243250 Matrix e (I.Count a) (I.Count b)
244−fromF' = M . I.fromF'
251+fromF = undefined -- M . I.fromF
245252
246253-- Conversion
247254
@@ -254,21 +261,21 @@ toList (M m) = I.toList m
254261-- Zeros Matrix
255262
256263zeros ::
257− (Num e, I.FromLists e (I.FromNat cols) (I.FromNat rows), KnownNat (I.Count (I.FromNat cols)), KnownNat (I.Count (I.FromNat rows))) =>
264+ (Num e, FLN e cols rows, CountableN cols, CountableN rows) =>
258265 Matrix e cols rows
259266zeros = M I.zeros
260267
261268-- Ones Matrix
262269
263270ones ::
264− (Num e, I.FromLists e (I.FromNat cols) (I.FromNat rows), KnownNat (I.Count (I.FromNat cols)), KnownNat (I.Count (I.FromNat rows))) =>
271+ (Num e, FLN e cols rows, CountableN cols, CountableN rows) =>
265272 Matrix e cols rows
266273ones = M I.ones
267274
268275-- Const Matrix
269276
270277constant ::
271− (Num e, I.FromLists e (I.FromNat cols) (I.FromNat rows), KnownNat (I.Count (I.FromNat cols)), KnownNat (I.Count (I.FromNat rows))) =>
278+ (Num e, FLN e cols rows, CountableN cols, CountableN rows) =>
272279 e ->
273280 Matrix e cols rows
274281constant = M . I.constant
@@ -277,40 +284,52 @@ constant = M . I.constant
277284
278285bang ::
279286 forall e cols.
280− (Num e, Enum e, I.FromLists e (I.FromNat cols) (), KnownNat (I.Count (I.FromNat cols))) =>
287+ (Num e, Enum e, I.FL (I.FromNat cols) (), CountableN cols) =>
281288 Matrix e cols 1
282289bang = M I.bang
283290
284−-- Identity Matrix
291+-- iden Matrix
285292
286−identity ::
287− (Num e, I.FromLists e (I.FromNat cols) (I.FromNat cols), KnownNat (I.Count (I.FromNat cols))) =>
293+iden ::
294+ (Num e, FLN e cols cols, CountableN cols) =>
288295 Matrix e cols cols
289−identity = M I.identity
296+iden = M I.iden
290297
291298-- Matrix composition (MMM)
292299
293300comp :: (Num e) => Matrix e cr rows -> Matrix e cols cr -> Matrix e cols rows
294301comp (M a) (M b) = M (I.comp a b)
295302
303+-- Scalar multiplication of matrices
304+
305+infixl 7 .|
306+-- | Scalar multiplication of matrices.
307+(.|) :: Num e => e -> Matrix e cols rows -> Matrix e cols rows
308+(.|) e (M m) = M (e I..| m)
309+
310+-- Scalar division of matrices
311+
312+infixl 7 ./
313+-- | Scalar multiplication of matrices.
314+(./) :: Fractional e => Matrix e cols rows -> e -> Matrix e cols rows
315+(./) (M m) e = M (m I../ e)
316+
296317p1 ::
297318 ( Num e,
298− KnownNat (I.Count (I.FromNat n)),
299− KnownNat (I.Count (I.FromNat m)),
300− I.FromLists e (I.FromNat n) (I.FromNat m),
301− I.FromLists e (I.FromNat m) (I.FromNat m),
302− I.FromNat (m + n) ~ Either (I.FromNat m) (I.FromNat n)
319+ CountableDimsN n m,
320+ FLN e n m,
321+ FLN e m m,
322+ TrivialE m n
303323 ) =>
304324 Matrix e (m + n) m
305325p1 = M I.p1
306326
307327p2 ::
308328 ( Num e,
309− KnownNat (I.Count (I.FromNat n)),
310− KnownNat (I.Count (I.FromNat m)),
311− I.FromLists e (I.FromNat m) (I.FromNat n),
312− I.FromLists e (I.FromNat n) (I.FromNat n),
313− I.FromNat (m + n) ~ Either (I.FromNat m) (I.FromNat n)
329+ CountableDimsN n m,
330+ FLN e m n,
331+ FLN e n n,
332+ TrivialE m n
314333 ) =>
315334 Matrix e (m + n) n
316335p2 = M I.p2
@@ -319,138 +338,125 @@ p2 = M I.p2
319338
320339i1 ::
321340 ( Num e,
322− KnownNat (I.Count (I.FromNat n)),
323− KnownNat (I.Count (I.FromNat rows)),
324− I.FromLists e (I.FromNat n) (I.FromNat rows),
325− I.FromLists e (I.FromNat rows) (I.FromNat rows),
326− I.FromNat (rows + n) ~ Either (I.FromNat rows) (I.FromNat n)
341+ CountableDimsN n rows,
342+ FLN e n rows,
343+ FLN e rows rows,
344+ TrivialE rows n
327345 ) =>
328346 Matrix e rows (rows + n)
329347i1 = tr p1
330348
331349i2 ::
332350 ( Num e,
333− KnownNat (I.Count (I.FromNat rows)),
334− KnownNat (I.Count (I.FromNat m)),
335− I.FromLists e (I.FromNat m) (I.FromNat rows),
336− I.FromLists e (I.FromNat rows) (I.FromNat rows),
337− I.FromNat (m + rows) ~ Either (I.FromNat m) (I.FromNat rows)
351+ CountableDimsN rows m,
352+ FLN e m rows,
353+ FLN e rows rows,
354+ TrivialE m rows
338355 ) =>
339356 Matrix e rows (m + rows)
340357i2 = tr p2
341358
342359-- Dimensions
343360
344−rows :: (KnownNat (I.Count (I.FromNat rows))) => Matrix e cols rows -> Int
361+rows :: (CountableN rows) => Matrix e cols rows -> Int
345362rows (M m) = I.rows m
346363
347−columns :: (KnownNat (I.Count (I.FromNat cols))) => Matrix e cols rows -> Int
364+columns :: (CountableN cols) => Matrix e cols rows -> Int
348365columns (M m) = I.columns m
349366
350−-- Coproduct Bifunctor
351−
352367infixl 5 -|-
353368
369+-- | Coproduct Bifunctor (Direct sum)
354370(-|-) ::
355371 ( Num e,
356− KnownNat (I.Count (I.FromNat j)),
357− KnownNat (I.Count (I.FromNat k)),
358− I.FromLists e (I.FromNat k) (I.FromNat k),
359− I.FromLists e (I.FromNat j) (I.FromNat k),
360− I.FromLists e (I.FromNat k) (I.FromNat j),
361− I.FromLists e (I.FromNat j) (I.FromNat j),
362− I.FromNat (n + m) ~ Either (I.FromNat n) (I.FromNat m),
363− I.FromNat (k + j) ~ Either (I.FromNat k) (I.FromNat j)
372+ CountableDimsN j k,
373+ FLN e k k,
374+ FLN e j k,
375+ FLN e k j,
376+ FLN e j j,
377+ TrivialE n m,
378+ TrivialE k j
364379 ) =>
365380 Matrix e n k ->
366381 Matrix e m j ->
367382 Matrix e (n + m) (k + j)
368383(-|-) (M a) (M b) = M ((I.-|-) a b)
369384
370−-- Khatri Rao Product and projections
371−
372−kp1 ::
385+-- | Khatri Rao Product first projection
386+fstM ::
373387 forall e m k .
374388 ( Num e,
375− KnownNat (I.Count (I.FromNat m)),
376− KnownNat (I.Count (I.FromNat k)),
377− KnownNat (I.Count (I.FromNat (m * k))),
378− I.FromLists e (I.FromNat (m * k)) (I.FromNat m),
379− I.FromNat (m * k) ~ I.FromNat (I.Count (I.FromNat m) * I.Count (I.FromNat k))
389+ CountableDimsN m k,
390+ CountableN (m * k),
391+ FLN e (m * k) m,
392+ TrivialP m k
380393 ) => Matrix e (m * k) m
381−kp1 = M (I.kp1 @e @(I.FromNat m) @(I.FromNat k))
394+fstM = M (I.fstM @e @(I.FromNat m) @(I.FromNat k))
382395
383−kp2 ::
396+-- | Khatri Rao Product second projection
397+sndM ::
384398 forall e m k.
385399 ( Num e,
386− KnownNat (I.Count (I.FromNat k)),
387− I.FromLists e (I.FromNat (m * k)) (I.FromNat k),
388− KnownNat (I.Count (I.FromNat m)),
389− KnownNat (I.Count (I.FromNat (m * k))),
390− I.FromNat (m * k) ~ I.FromNat (I.Count (I.FromNat m) * I.Count (I.FromNat k))
400+ CountableDimsN k m,
401+ FLN e (m * k) k,
402+ CountableN (m * k),
403+ TrivialP m k
391404 ) => Matrix e (m * k) k
392−kp2 = M (I.kp2 @e @(I.FromNat m) @(I.FromNat k))
405+sndM = M (I.sndM @e @(I.FromNat m) @(I.FromNat k))
393406
394−khatri ::
407+-- | Khatri Rao Product
408+kr ::
395409 forall e cols a b.
396410 ( Num e,
397− KnownNat (I.Count (I.FromNat a)),
398− KnownNat (I.Count (I.FromNat b)),
399− KnownNat (I.Count (I.FromNat (a * b))),
400− I.FromLists e (I.FromNat (a * b)) (I.FromNat a),
401− I.FromLists e (I.FromNat (a * b)) (I.FromNat b),
402− I.FromNat (a * b) ~ I.FromNat (I.Count (I.FromNat a) * I.Count (I.FromNat b))
411+ CountableDimsN a b,
412+ CountableN (a * b),
413+ FLN e (a * b) a,
414+ FLN e (a * b) b,
415+ TrivialP a b
403416 ) => Matrix e cols a -> Matrix e cols b -> Matrix e cols (a * b)
404−khatri a b =
405− let kp1' = kp1 @e @a @b
406− kp2' = kp2 @e @a @b
407− in comp (tr kp1') a * comp (tr kp2') b
408−
409−-- Product Bifunctor (Kronecker)
417+kr a b =
418+ let fstM' = fstM @e @a @b
419+ sndM' = sndM @e @a @b
420+ in comp (tr fstM') a * comp (tr sndM') b
410421
422+-- | Product Bifunctor (Kronecker)
411423infixl 4 ><
412424
413425(><) ::
414426 forall e m p n q.
415427 ( Num e,
416− KnownNat (I.Count (I.FromNat m)),
417− KnownNat (I.Count (I.FromNat n)),
418− KnownNat (I.Count (I.FromNat p)),
419− KnownNat (I.Count (I.FromNat q)),
420− KnownNat (I.Count (I.FromNat (m * n))),
421− KnownNat (I.Count (I.FromNat (p * q))),
422− I.FromLists e (I.FromNat (m * n)) (I.FromNat m),
423− I.FromLists e (I.FromNat (m * n)) (I.FromNat n),
424− I.FromLists e (I.FromNat (p * q)) (I.FromNat p),
425− I.FromLists e (I.FromNat (p * q)) (I.FromNat q),
426− I.FromNat (m * n) ~ I.FromNat (I.Count (I.FromNat m) * I.Count (I.FromNat n)),
427− I.FromNat (p * q) ~ I.FromNat (I.Count (I.FromNat p) * I.Count (I.FromNat q))
428+ CountableDimsN m n,
429+ CountableDimsN p q,
430+ CountableDimsN (m * n) (p * q),
431+ FLN e (m * n) m,
432+ FLN e (m * n) n,
433+ FLN e (p * q) p,
434+ FLN e (p * q) q,
435+ TrivialP m n,
436+ TrivialP p q
428437 ) => Matrix e m p -> Matrix e n q -> Matrix e (m * n) (p * q)
429438(><) a b =
430− let kp1' = kp1 @e @m @n
431− kp2' = kp2 @e @m @n
432− in khatri (comp a kp1') (comp b kp2')
433−
434−-- Matrix abide Junc Split
439+ let fstM' = fstM @e @m @n
440+ sndM' = sndM @e @m @n
441+ in kr (comp a fstM') (comp b sndM')
435442
436−abideJS :: Matrix e cols rows -> Matrix e cols rows
437−abideJS (M m) = M (I.abideJS m)
443+-- | Matrix abide Join Fork
444+abideJF :: Matrix e cols rows -> Matrix e cols rows
445+abideJF (M m) = M (I.abideJF m)
438446
439−-- Matrix abide Split Junc
440−
441−abideSJ :: Matrix e cols rows -> Matrix e cols rows
442−abideSJ (M m) = M (I.abideSJ m)
443−
444−-- Matrix transposition
447+-- | Matrix abide Fork Join
448+abideFJ :: Matrix e cols rows -> Matrix e cols rows
449+abideFJ (M m) = M (I.abideFJ m)
445450
451+-- | Matrix transposition
446452tr :: Matrix e cols rows -> Matrix e rows cols
447453tr (M m) = M (I.tr m)
448454
449455-- Selective 'select' operator
450456select ::
451457 ( Num e,
452− I.FromLists e (I.FromNat rows1) (I.FromNat rows1),
453− KnownNat (I.Count (I.FromNat rows1)),
458+ FLN e rows1 rows1,
459+ CountableN rows1,
454460 I.FromNat rows2 ~ I.FromNat rows1,
455461 I.FromNat cols1 ~ I.FromNat cols2,
456462 I.FromNat rows3 ~ Either (I.FromNat cols3) (I.FromNat rows1)
@@ -461,14 +467,11 @@ select (M m) (M y) = M (I.select m y)
461467
462468cond ::
463469 ( I.FromNat (I.Count (I.FromNat cols)) ~ I.FromNat cols,
464− KnownNat (I.Count (I.FromNat cols)),
465− I.FromLists e () (I.FromNat cols),
466− I.FromLists e (I.FromNat cols) (),
467− I.FromLists e (I.FromNat cols) (I.FromNat cols),
468− Bounded a,
469− Enum a,
470− Num e,
471− Ord e
470+ CountableN cols,
471+ I.FL () (I.FromNat cols),
472+ I.FL (I.FromNat cols) (),
473+ FLN e cols cols,
474+ Liftable e a Bool
472475 )
473476 =>
474477 (a -> Bool) -> Matrix e cols rows -> Matrix e cols rows -> Matrix e cols rows
@@ -476,8 +479,12 @@ cond p (M a) (M b) = M (I.cond p a b)
476479
477480-- Pretty print
478481
479−pretty :: (KnownNat (I.Count (I.FromNat cols)), Show e) => Matrix e cols rows -> String
482+pretty :: (CountableDimsN cols rows, Show e) => Matrix e cols rows -> String
480483pretty (M m) = I.pretty m
481484
482−prettyPrint :: (KnownNat (I.Count (I.FromNat cols)), Show e) => Matrix e cols rows -> IO ()
485+prettyPrint :: (CountableDimsN cols rows, Show e) => Matrix e cols rows -> IO ()
483486prettyPrint (M m) = I.prettyPrint m
487+
488+-- | Zip two matrices with a given binary function
489+zipWithM :: (e -> f -> g) -> Matrix e cols rows -> Matrix f cols rows -> Matrix g cols rows
490+zipWithM f (M a) (M b) = M (I.zipWithM f a b)
src/LAoP/Matrix/Type.hs+283−240
@@ -1,10 +1,11 @@
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE AllowAmbiguousTypes #-}
24{-# LANGUAGE DataKinds #-}
35{-# LANGUAGE DerivingVia #-}
46{-# LANGUAGE FlexibleContexts #-}
57{-# LANGUAGE FlexibleInstances #-}
68{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE KindSignatures #-}
89{-# LANGUAGE MultiParamTypeClasses #-}
910{-# LANGUAGE NoStarIsType #-}
1011{-# LANGUAGE RankNTypes #-}
@@ -55,15 +56,24 @@ module LAoP.Matrix.Type
5556 -- * Type safe matrix representation
5657 Matrix (..),
5758
59+ -- * Constraint type aliases
60+ Countable,
61+ CountableDims,
62+ CountableN,
63+ CountableDimsN,
64+ FLN,
65+ Liftable,
66+ Trivial,
67+ TrivialP,
68+
5869 -- * Type aliases
5970 Zero,
6071 One,
6172
6273 -- * Primitives
63− empty,
6474 one,
65− junc,
66− split,
75+ join,
76+ fork,
6777
6878 -- * Auxiliary type families
6979 I.FromNat,
@@ -75,24 +85,27 @@ module LAoP.Matrix.Type
7585 fromLists,
7686 toLists,
7787 toList,
88+ matrixBuilder',
7889 matrixBuilder,
7990 row,
8091 col,
8192 zeros,
8293 ones,
8394 bang,
95+ point,
8496 constant,
8597
8698 -- * Functor instance equivalent function
8799 fmapM,
100+ bimapM,
88101
89102 -- * Applicative/Monoidal instance equivalent functions
90103 unitM,
91104 multM,
92105
93106 -- * Selective equivalent instance function
94− selectM,
95−
107+ selectM,
108+
96109 -- * Monad equivalent instance function
97110 returnM,
98111 bindM,
@@ -100,25 +113,34 @@ module LAoP.Matrix.Type
100113 -- * Misc
101114 -- ** Get dimensions
102115 columns,
116+ columns',
103117 rows,
118+ rows',
104119
105120 -- ** Matrix Transposition
106121 tr,
107122
123+ -- ** Scalar multiplication/division of matrices
124+ (.|),
125+ (./),
126+
108127 -- ** McCarthy's Conditional
109128 cond,
110129
111130 -- ** Matrix "abiding"
112− abideJS,
113− abideSJ,
131+ abideJF,
132+ abideFJ,
133+
134+ -- ** Zip Matrices
135+ zipWithM,
114136
115137 -- * Biproduct approach
116− -- ** Split
138+ -- ** Fork
117139 (===),
118140 -- *** Projections
119141 p1,
120142 p2,
121− -- ** Junc
143+ -- ** Join
122144 (|||),
123145 -- *** Injections
124146 i1,
@@ -132,11 +154,11 @@ module LAoP.Matrix.Type
132154 -- | Note that given the restrictions imposed it is not possible to
133155 -- implement the standard type classes present in standard Haskell.
134156 -- *** Matrix pairing projections
135− kp1,
136− kp2,
157+ fstM,
158+ sndM,
137159
138160 -- *** Matrix pairing
139− khatri,
161+ kr,
140162
141163 -- * Matrix composition and lifting
142164
@@ -144,10 +166,10 @@ module LAoP.Matrix.Type
144166
145167 -- | Note that given the restrictions imposed it is not possible to
146168 -- implement the standard type classes present in standard Haskell.
147− identity,
169+ iden,
148170 comp,
149− fromF,
150171 fromF',
172+ fromF,
151173
152174 -- * Relation
153175 toRel,
@@ -161,23 +183,44 @@ where
161183import Data.Void
162184import Data.Proxy
163185import Data.Kind
164−import GHC.TypeLits
186+import GHC.TypeLits
165187import Control.DeepSeq
166188import LAoP.Utils
167−import qualified Control.Category as C
168189import qualified LAoP.Matrix.Internal as I
190+import Prelude hiding (id, (.))
169191
170192newtype Matrix e (cols :: Type) (rows :: Type) = M (I.Matrix e (I.Normalize cols) (I.Normalize rows))
171193 deriving (Show, Num, Eq, Ord, NFData) via (I.Matrix e (I.Normalize cols) (I.Normalize rows))
172194
173−-- | It isn't possible to implement the 'id' function so it's
174−-- implementation is 'undefined'. However 'comp' can be and this partial
175−-- class implementation exists just to make the code more readable.
176−--
177−-- Please use 'identity' instead.
178−instance (Num e) => C.Category (Matrix e) where
179− id = undefined
180− (.) = comp
195+-- | Constraint type synonyms to keep the type signatures less convoluted
196+type Countable a = KnownNat (I.Count a)
197+type CountableDims a b = (Countable a, Countable b)
198+type CountableN a = KnownNat (I.Count (I.Normalize a))
199+type CountableDimsN a b = (CountableN a, CountableN b)
200+type FLN a b = I.FromLists (I.Normalize a) (I.Normalize b)
201+type Liftable e a b = (Bounded a, Bounded b, Enum a, Enum b, Eq b, Num e, Ord e)
202+type Trivial a = I.Normalize (I.Normalize a) ~ I.Normalize (I.Normalize (I.Normalize a))
203+type Trivial2 a = I.Normalize a ~ I.Normalize (I.Normalize a)
204+type Trivial3 a = I.FromNat (I.Count (I.Normalize (I.Normalize a))) ~ I.Normalize (I.Normalize a)
205+type TrivialP a b = I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
206+
207+-- | It is possible to implement a constrained version of the category type
208+-- class.
209+instance (Num e) => Category (Matrix e) where
210+ type Object (Matrix e) a = (FLN a a, CountableN a)
211+ id = iden
212+ (.) = comp
213+
214+-- | Bifunctor equivalent function
215+bimapM ::
216+ ( Liftable e a b,
217+ Liftable e c d,
218+ CountableDimsN a c,
219+ CountableDimsN b d,
220+ FLN d c,
221+ FLN b a
222+ ) => (a -> b) -> (c -> d) -> Matrix e a c -> Matrix e b d
223+bimapM f g m = fromF g . m . tr (fromF f)
181224
182225-- | Zero type alias
183226type Zero = Void
@@ -187,92 +230,75 @@ type One = ()
187230
188231-- Primitives
189232
190−-- | Empty matrix constructor
191−empty :: Matrix e Zero Zero
192−empty = M I.Empty
193−
194233-- | Unit matrix constructor
195234one :: e -> Matrix e One One
196235one = M . I.One
197236
198−-- | Matrix 'Junc' constructor
199−junc ::
200− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
237+-- | Matrix 'Join' constructor
238+join ::
201239 Matrix e a rows ->
202240 Matrix e b rows ->
203241 Matrix e (Either a b) rows
204−junc (M a) (M b) = M (I.Junc a b)
242+join (M a) (M b) = M (I.Join a b)
205243
206244infixl 3 |||
207−-- | Matrix 'Junc' constructor
245+-- | Matrix 'Join' constructor
208246(|||) ::
209− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
210247 Matrix e a rows ->
211248 Matrix e b rows ->
212249 Matrix e (Either a b) rows
213−(|||) = junc
250+(|||) = join
214251
215−-- | Matrix 'Split' constructor
216−split ::
217− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
252+-- | Matrix 'Fork' constructor
253+fork ::
218254 Matrix e cols a ->
219255 Matrix e cols b ->
220256 Matrix e cols (Either a b)
221−split (M a) (M b) = M (I.Split a b)
257+fork (M a) (M b) = M (I.Fork a b)
222258
223259infixl 2 ===
224−-- | Matrix 'Split' constructor
260+-- | Matrix 'Fork' constructor
225261(===) ::
226− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
227262 Matrix e cols a ->
228263 Matrix e cols b ->
229264 Matrix e cols (Either a b)
230−(===) = split
265+(===) = fork
231266
232267-- Functor hierarchy
233268
234269-- | Functor instance equivalent function
235−fmapM ::
236− ( Bounded a,
237− Bounded b,
238− Enum a,
239− Enum b,
240− Eq b,
241− Num e,
242− Ord e,
243− KnownNat (I.Count (I.Normalize a)),
244− KnownNat (I.Count (I.Normalize b)),
245− I.FromLists e (I.Normalize b) (I.Normalize a)
270+fmapM ::
271+ ( Liftable e a b,
272+ CountableDimsN a b,
273+ FLN b a
246274 )
247275 =>
248276 (a -> b) -> Matrix e c a -> Matrix e c b
249−fmapM f m = fromF' f `comp` m
277+fmapM f m = fromF f . m
250278
251279-- | Applicative instance equivalent 'unit' function,
252280unitM :: (Num e) => Matrix e () ()
253281unitM = one 1
254282
255283-- | Applicative instance equivalent 'unit' function,
256−multM ::
257− ( KnownNat (I.Count (I.Normalize a)),
258− KnownNat (I.Count (I.Normalize b)),
259− KnownNat (I.Count (I.Normalize (a, b))),
284+multM ::
285+ ( CountableDimsN a b,
286+ CountableN (a, b),
260287 Num e,
261− I.FromLists e (I.Normalize (a, b)) (I.Normalize a),
262− I.FromLists e (I.Normalize (a, b)) (I.Normalize b),
263− I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
288+ FLN (a, b) a,
289+ FLN (a, b) b,
290+ TrivialP a b
264291 ) => Matrix e c a -> Matrix e c b -> Matrix e c (a, b)
265−multM a b = khatri a b
266−
292+multM = kr
267293
268294-- | Monad instance equivalent 'return' function,
269−returnM ::
270− forall e a .
271− ( Num e,
272− Enum e,
273− Enum a,
274− I.FromLists e () (I.Normalize a),
275− KnownNat (I.Count a)
295+returnM ::
296+ forall e a .
297+ ( Num e,
298+ Enum e,
299+ Enum a,
300+ FLN () a,
301+ Countable a
276302 ) => a -> Matrix e One a
277303returnM a = col l
278304 where
@@ -288,73 +314,64 @@ bindM = flip comp
288314
289315-- | Build a matrix out of a list of list of elements. Throws a runtime
290316-- error if the dimensions do not match.
291−fromLists :: (I.FromLists e (I.Normalize cols) (I.Normalize rows)) => [[e]] -> Matrix e cols rows
317+fromLists :: (FLN cols rows) => [[e]] -> Matrix e cols rows
292318fromLists = M . I.fromLists
293319
294320-- | Matrix builder function. Constructs a matrix provided with
295−-- a construction function.
321+-- a construction function that operates with indices.
322+matrixBuilder' ::
323+ (FLN cols rows, CountableDimsN cols rows )
324+ => ((Int, Int) -> e) -> Matrix e cols rows
325+matrixBuilder' = M . I.matrixBuilder'
326+
327+-- | Matrix builder function. Constructs a matrix provided with
328+-- a construction function that operates with arbitrary types.
296329matrixBuilder ::
297− (I.FromLists e (I.Normalize cols) (I.Normalize rows), KnownNat (I.Count (I.Normalize cols)), KnownNat (I.Count (I.Normalize rows))) =>
298− ((Int, Int) -> e) ->
299− Matrix e cols rows
300−matrixBuilder = M . I.matrixBuilder
330+ ( FLN a b,
331+ Enum a,
332+ Enum b,
333+ Bounded a,
334+ Bounded b,
335+ Eq a,
336+ Countable b
337+ ) => ((a, b) -> e) -> Matrix e a b
338+matrixBuilder f = M (I.matrixBuilder f)
301339
302340-- | Constructs a column vector matrix
303−col :: (I.FromLists e () (I.Normalize rows)) => [e] -> Matrix e One rows
341+col :: (FLN () rows) => [e] -> Matrix e One rows
304342col = M . I.col
305343
306344-- | Constructs a row vector matrix
307−row :: (I.FromLists e (I.Normalize cols) ()) => [e] -> Matrix e cols One
345+row :: (FLN cols ()) => [e] -> Matrix e cols One
308346row = M . I.row
309347
310348-- | Lifts functions to matrices with arbitrary dimensions.
311349--
312350-- NOTE: Be careful to not ask for a matrix bigger than the cardinality of
313351-- types @a@ or @b@ allows.
314−fromF ::
315− ( Bounded a,
316− Bounded b,
317− Enum a,
318− Enum b,
319− Eq b,
320− Num e,
321− Ord e,
322− KnownNat (I.Count (I.Normalize cols)),
323− KnownNat (I.Count (I.Normalize rows)),
324− I.FromLists e (I.Normalize rows) (I.Normalize cols)
352+fromF' ::
353+ ( Liftable e a b,
354+ CountableDimsN cols rows,
355+ FLN rows cols
325356 ) =>
326− (a -> b) ->
327− Matrix e cols rows
328−fromF = M . I.fromF
357+ (a -> b) -> Matrix e cols rows
358+fromF' = M . I.fromF'
329359
330360-- | Lifts functions to matrices with dimensions matching @a@ and @b@
331361-- cardinality's.
332−fromF' ::
333− ( Bounded a,
334− Bounded b,
335− Enum a,
336− Enum b,
337− Eq b,
338− Num e,
339− Ord e,
340− KnownNat (I.Count (I.Normalize a)),
341− KnownNat (I.Count (I.Normalize b)),
342− I.FromLists e (I.Normalize b) (I.Normalize a)
362+fromF ::
363+ ( Liftable e a b,
364+ CountableDimsN a b,
365+ FLN b a
343366 ) =>
344− (a -> b) ->
345− Matrix e a b
346−fromF' = M . I.fromF'
367+ (a -> b) -> Matrix e a b
368+fromF = M . I.fromF
347369
348370-- | Lifts relation functions to Boolean Matrix
349371toRel ::
350− ( Bounded a,
351− Bounded b,
352− Enum a,
353− Enum b,
354− Eq b,
355− KnownNat (I.Count (I.Normalize a)),
356− KnownNat (I.Count (I.Normalize b)),
357− I.FromLists (Natural 0 1) (I.Normalize b) (I.Normalize a)
372+ ( Liftable (Natural 0 1) a b,
373+ CountableDims a b,
374+ FLN b a
358375 ) => (a -> b -> Bool) -> Matrix (Natural 0 1) a b
359376toRel = M . I.toRel
360377
@@ -372,8 +389,8 @@ toList (M m) = I.toList m
372389
373390-- | The zero matrix. A matrix wholly filled with zeros.
374391zeros ::
375− (Num e, I.FromLists e (I.Normalize cols) (I.Normalize rows), KnownNat (I.Count (I.Normalize cols)), KnownNat (I.Count (I.Normalize rows))) =>
376− Matrix e cols rows
392+ (Num e, FLN cols rows, CountableDimsN cols rows)
393+ => Matrix e cols rows
377394zeros = M I.zeros
378395
379396-- Ones Matrix
@@ -382,8 +399,8 @@ zeros = M I.zeros
382399--
383400-- Also known as T (Top) matrix.
384401ones ::
385− (Num e, I.FromLists e (I.Normalize cols) (I.Normalize rows), KnownNat (I.Count (I.Normalize cols)), KnownNat (I.Count (I.Normalize rows))) =>
386− Matrix e cols rows
402+ (Num e, FLN cols rows, CountableDimsN cols rows)
403+ => Matrix e cols rows
387404ones = M I.ones
388405
389406-- Const Matrix
@@ -391,9 +408,8 @@ ones = M I.ones
391408-- | The constant matrix constructor. A matrix wholly filled with a given
392409-- value.
393410constant ::
394− (Num e, I.FromLists e (I.Normalize cols) (I.Normalize rows), KnownNat (I.Count (I.Normalize cols)), KnownNat (I.Count (I.Normalize rows))) =>
395− e ->
396− Matrix e cols rows
411+ (Num e, FLN cols rows, CountableDimsN cols rows)
412+ => e -> Matrix e cols rows
397413constant = M . I.constant
398414
399415-- Bang Matrix
@@ -401,17 +417,30 @@ constant = M . I.constant
401417-- | The T (Top) row vector matrix.
402418bang ::
403419 forall e cols.
404− (Num e, Enum e, I.FromLists e (I.Normalize cols) (), KnownNat (I.Count (I.Normalize cols))) =>
420+ (Num e, Enum e, FLN cols (), CountableN cols) =>
405421 Matrix e cols One
406422bang = M I.bang
407423
408−-- Identity Matrix
424+-- | Point constant relation
425+point ::
426+ ( Bounded a,
427+ Enum a,
428+ Eq a,
429+ Num e,
430+ Ord e,
431+ CountableN a,
432+ FLN a One
433+ ) => a -> Matrix e One a
434+point = fromF . const
435+
436+-- iden Matrix
409437
410−-- | Identity matrix
411−identity ::
412− (Num e, I.FromLists e (I.Normalize a) (I.Normalize a), KnownNat (I.Count (I.Normalize a))) =>
438+-- | iden matrix
439+iden ::
440+ (Num e, FLN a a, CountableN a) =>
413441 Matrix e a a
414−identity = M I.identity
442+iden = M I.iden
443+{-# NOINLINE iden #-}
415444
416445-- Matrix composition (MMM)
417446
@@ -421,15 +450,32 @@ identity = M I.identity
421450-- from LAoP.
422451comp :: (Num e) => Matrix e cr rows -> Matrix e cols cr -> Matrix e cols rows
423452comp (M a) (M b) = M (I.comp a b)
453+{-# NOINLINE comp #-}
454+{-# RULES
455+ "comp/iden1" forall m. comp m iden = m ;
456+ "comp/iden2" forall m. comp iden m = m
457+#-}
458+
459+-- Scalar multiplication of matrices
460+
461+infixl 7 .|
462+-- | Scalar multiplication of matrices.
463+(.|) :: Num e => e -> Matrix e cols rows -> Matrix e cols rows
464+(.|) e (M m) = M (e I..| m)
465+
466+-- Scalar division of matrices
467+
468+infixl 7 ./
469+-- | Scalar multiplication of matrices.
470+(./) :: Fractional e => Matrix e cols rows -> e -> Matrix e cols rows
471+(./) (M m) e = M (m I../ e)
424472
425473-- | Biproduct first component projection
426474p1 ::
427475 ( Num e,
428− KnownNat (I.Count (I.Normalize n)),
429− KnownNat (I.Count (I.Normalize m)),
430− I.FromLists e (I.Normalize n) (I.Normalize m),
431− I.FromLists e (I.Normalize m) (I.Normalize m),
432− I.Normalize (Either m n) ~ Either (I.Normalize m) (I.Normalize n)
476+ CountableDimsN n m,
477+ FLN n m,
478+ FLN m m
433479 ) =>
434480 Matrix e (Either m n) m
435481p1 = M I.p1
@@ -437,11 +483,9 @@ p1 = M I.p1
437483-- | Biproduct second component projection
438484p2 ::
439485 ( Num e,
440− KnownNat (I.Count (I.Normalize n)),
441− KnownNat (I.Count (I.Normalize m)),
442− I.FromLists e (I.Normalize m) (I.Normalize n),
443− I.FromLists e (I.Normalize n) (I.Normalize n),
444− I.Normalize (Either m n) ~ Either (I.Normalize m) (I.Normalize n)
486+ CountableDimsN n m,
487+ FLN m n,
488+ FLN n n
445489 ) =>
446490 Matrix e (Either m n) n
447491p2 = M I.p2
@@ -451,11 +495,9 @@ p2 = M I.p2
451495-- | Biproduct first component injection
452496i1 ::
453497 ( Num e,
454− KnownNat (I.Count (I.Normalize n)),
455− KnownNat (I.Count (I.Normalize m)),
456− I.FromLists e (I.Normalize n) (I.Normalize m),
457− I.FromLists e (I.Normalize m) (I.Normalize m),
458− I.Normalize (Either m n) ~ Either (I.Normalize m) (I.Normalize n)
498+ CountableDimsN n m,
499+ FLN n m,
500+ FLN m m
459501 ) =>
460502 Matrix e m (Either m n)
461503i1 = tr p1
@@ -463,11 +505,9 @@ i1 = tr p1
463505-- | Biproduct second component injection
464506i2 ::
465507 ( Num e,
466− KnownNat (I.Count (I.Normalize n)),
467− KnownNat (I.Count (I.Normalize m)),
468− I.FromLists e (I.Normalize m) (I.Normalize n),
469− I.FromLists e (I.Normalize n) (I.Normalize n),
470− I.Normalize (Either m n) ~ Either (I.Normalize m) (I.Normalize n)
508+ CountableDimsN n m,
509+ FLN m n,
510+ FLN n n
471511 ) =>
472512 Matrix e n (Either m n)
473513i2 = tr p2
@@ -476,24 +516,34 @@ i2 = tr p2
476516
477517-- | Obtain the number of rows.
478518--
479−-- NOTE: The 'KnownNat' constaint is needed in order to obtain the
480−-- dimensions in constant time.
481−--
482−-- TODO: A 'rows' function that does not need the 'KnownNat' constraint in
483−-- exchange for performance.
484−rows :: (KnownNat (I.Count (I.Normalize rows))) => Matrix e cols rows -> Int
519+-- NOTE: The 'KnownNat' constraint is needed in order to obtain the
520+-- dimensions in constant time. For a version that doesn't require the
521+-- constraint see 'rows''.
522+rows :: (CountableN rows) => Matrix e cols rows -> Int
485523rows (M m) = I.rows m
486524
525+-- | Obtain the number of rows in an inefficient manner, but without any
526+-- constraints.
527+--
528+-- For a more efficient version see 'rows'.
529+rows' :: Matrix e cols rows -> Int
530+rows' (M m) = I.rows' m
531+
487532-- | Obtain the number of columns.
488−--
489−-- NOTE: The 'KnownNat' constaint is needed in order to obtain the
490−-- dimensions in constant time.
491533--
492−-- TODO: A 'columns' function that does not need the 'KnownNat' constraint in
493−-- exchange for performance.
494−columns :: (KnownNat (I.Count (I.Normalize cols))) => Matrix e cols rows -> Int
534+-- NOTE: The 'KnownNat' constraint is needed in order to obtain the
535+-- dimensions in constant time. For a version that doesn't require the
536+-- constraint see 'columns''.
537+columns :: (CountableN cols) => Matrix e cols rows -> Int
495538columns (M m) = I.columns m
496539
540+-- | Obtain the number of columns in an inefficient manner, but without any
541+-- constraints.
542+--
543+-- For a more efficient version see 'columns'.
544+columns' :: Matrix e cols rows -> Int
545+columns' (M m) = I.columns' m
546+
497547-- Coproduct Bifunctor
498548
499549infixl 5 -|-
@@ -501,14 +551,11 @@ infixl 5 -|-
501551-- | Matrix coproduct functor also known as matrix direct sum.
502552(-|-) ::
503553 ( Num e,
504− KnownNat (I.Count (I.Normalize j)),
505− KnownNat (I.Count (I.Normalize k)),
506− I.FromLists e (I.Normalize k) (I.Normalize k),
507− I.FromLists e (I.Normalize j) (I.Normalize k),
508− I.FromLists e (I.Normalize k) (I.Normalize j),
509− I.FromLists e (I.Normalize j) (I.Normalize j),
510− I.Normalize (Either n m) ~ Either (I.Normalize n) (I.Normalize m),
511− I.Normalize (Either k j) ~ Either (I.Normalize k) (I.Normalize j)
554+ CountableDimsN j k,
555+ FLN k k,
556+ FLN j k,
557+ FLN k j,
558+ FLN j j
512559 ) =>
513560 Matrix e n k ->
514561 Matrix e m j ->
@@ -518,104 +565,98 @@ infixl 5 -|-
518565-- Khatri Rao Product and projections
519566
520567-- | Khatri Rao product first component projection matrix.
521−kp1 ::
568+fstM ::
522569 forall e m k .
523570 ( Num e,
524− KnownNat (I.Count (I.Normalize m)),
525− KnownNat (I.Count (I.Normalize k)),
526− KnownNat (I.Count (I.Normalize (m, k))),
527− I.FromLists e (I.Normalize (m, k)) (I.Normalize m),
528− I.Normalize (m, k) ~ I.Normalize (I.Normalize m, I.Normalize k)
571+ CountableDimsN m k,
572+ CountableN (m, k),
573+ FLN (m, k) m,
574+ TrivialP m k
529575 ) => Matrix e (m, k) m
530−kp1 = M (I.kp1 @e @(I.Normalize m) @(I.Normalize k))
576+fstM = M (I.fstM @e @(I.Normalize m) @(I.Normalize k))
531577
532578-- | Khatri Rao product second component projection matrix.
533−kp2 ::
579+sndM ::
534580 forall e m k.
535581 ( Num e,
536− KnownNat (I.Count (I.Normalize k)),
537− KnownNat (I.Count (I.Normalize m)),
538− KnownNat (I.Count (I.Normalize (m, k))),
539− I.FromLists e (I.Normalize (m, k)) (I.Normalize k),
540− I.Normalize (m, k) ~ I.Normalize (I.Normalize m, I.Normalize k)
582+ CountableDimsN k m,
583+ CountableN (m, k),
584+ FLN (m, k) k,
585+ TrivialP m k
541586 ) => Matrix e (m, k) k
542−kp2 = M (I.kp2 @e @(I.Normalize m) @(I.Normalize k))
587+sndM = M (I.sndM @e @(I.Normalize m) @(I.Normalize k))
543588
544589-- | Khatri Rao Matrix product also known as matrix pairing.
545590--
546591-- NOTE: That this is not a true categorical product, see for instance:
547−--
592+--
548593-- @
549−-- | kp1 `comp` khatri a b == a
550−-- khatri a b ==> |
551−-- | kp2 `comp` khatri a b == b
594+-- | fstM . kr a b == a
595+-- kr a b ==> |
596+-- | sndM . kr a b == b
552597-- @
553598--
554599-- __Emphasis__ on the implication symbol.
555−khatri ::
600+kr ::
556601 forall e cols a b.
557602 ( Num e,
558− KnownNat (I.Count (I.Normalize a)),
559− KnownNat (I.Count (I.Normalize b)),
560− KnownNat (I.Count (I.Normalize (a, b))),
561− I.FromLists e (I.Normalize (a, b)) (I.Normalize a),
562− I.FromLists e (I.Normalize (a, b)) (I.Normalize b),
563− I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
603+ CountableDimsN a b,
604+ CountableN (a, b),
605+ FLN (a, b) a,
606+ FLN (a, b) b,
607+ TrivialP a b
564608 ) => Matrix e cols a -> Matrix e cols b -> Matrix e cols (a, b)
565−khatri a b =
566− let kp1' = kp1 @e @a @b
567− kp2' = kp2 @e @a @b
568− in comp (tr kp1') a * comp (tr kp2') b
609+kr a b =
610+ let fstM' = fstM @e @a @b
611+ sndM' = sndM @e @a @b
612+ in comp (tr fstM') a * comp (tr sndM') b
569613
570614-- Product Bifunctor (Kronecker)
571615
572616infixl 4 ><
573617
574−-- | Matrix product functor also known as kronecker product
618+-- | Matrix product functor also known as Kronecker product
575619(><) ::
576620 forall e m p n q.
577621 ( Num e,
578− KnownNat (I.Count (I.Normalize m)),
579− KnownNat (I.Count (I.Normalize n)),
580− KnownNat (I.Count (I.Normalize p)),
581− KnownNat (I.Count (I.Normalize q)),
582− KnownNat (I.Count (I.Normalize (m, n))),
583− KnownNat (I.Count (I.Normalize (p, q))),
584− I.FromLists e (I.Normalize (m, n)) (I.Normalize m),
585− I.FromLists e (I.Normalize (m, n)) (I.Normalize n),
586− I.FromLists e (I.Normalize (p, q)) (I.Normalize p),
587− I.FromLists e (I.Normalize (p, q)) (I.Normalize q),
588− I.Normalize (m, n) ~ I.Normalize (I.Normalize m, I.Normalize n),
589− I.Normalize (p, q) ~ I.Normalize (I.Normalize p, I.Normalize q)
622+ CountableDimsN m n,
623+ CountableDimsN p q,
624+ CountableDimsN (m, n) (p, q),
625+ FLN (m, n) m,
626+ FLN (m, n) n,
627+ FLN (p, q) p,
628+ FLN (p, q) q,
629+ TrivialP m n,
630+ TrivialP p q
590631 ) => Matrix e m p -> Matrix e n q -> Matrix e (m, n) (p, q)
591632(><) a b =
592− let kp1' = kp1 @e @m @n
593− kp2' = kp2 @e @m @n
594− in khatri (comp a kp1') (comp b kp2')
633+ let fstM' = fstM @e @m @n
634+ sndM' = sndM @e @m @n
635+ in kr (comp a fstM') (comp b sndM')
595636
596−-- Matrix abide Junc Split
637+-- Matrix abide Join Fork
597638
598−-- | Matrix "abiding" followin the 'Junc'-'Split' abide law.
599−--
639+-- | Matrix "abiding" followin the 'Join'-'Fork' abide law.
640+--
600641-- Law:
601642--
602643-- @
603−-- 'Junc' ('Split' a c) ('Split' b d) == 'Split' ('Junc' a b) ('Junc' c d)
644+-- 'Join' ('Fork' a c) ('Fork' b d) == 'Fork' ('Join' a b) ('Join' c d)
604645-- @
605−abideJS :: Matrix e cols rows -> Matrix e cols rows
606−abideJS (M m) = M (I.abideJS m)
646+abideJF :: Matrix e cols rows -> Matrix e cols rows
647+abideJF (M m) = M (I.abideJF m)
607648
608−-- Matrix abide Split Junc
649+-- Matrix abide Fork Join
609650
610−-- | Matrix "abiding" followin the 'Split'-'Junc' abide law.
611−--
651+-- | Matrix "abiding" followin the 'Fork'-'Join' abide law.
652+--
612653-- Law:
613654--
614655-- @
615−-- 'Split' ('Junc' a b) ('Junc' c d) == 'Junc' ('Split' a c) ('Split' b d)
656+-- 'Fork' ('Join' a b) ('Join' c d) == 'Join' ('Fork' a c) ('Fork' b d)
616657-- @
617−abideSJ :: Matrix e cols rows -> Matrix e cols rows
618−abideSJ (M m) = M (I.abideSJ m)
658+abideFJ :: Matrix e cols rows -> Matrix e cols rows
659+abideFJ (M m) = M (I.abideFJ m)
619660
620661-- Matrix transposition
621662
@@ -627,11 +668,10 @@ tr (M m) = M (I.tr m)
627668
628669-- | Selective functors 'select' operator equivalent inspired by the
629670-- ArrowMonad solution presented in the paper.
630−selectM ::
671+selectM ::
631672 ( Num e,
632− I.FromLists e (I.Normalize b) (I.Normalize b),
633− KnownNat (I.Count (I.Normalize b)),
634− I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)
673+ FLN b b,
674+ CountableN b
635675 ) => Matrix e cols (Either a b) -> Matrix e a b -> Matrix e cols b
636676selectM (M m) (M y) = M (I.select m y)
637677
@@ -639,15 +679,14 @@ selectM (M m) (M y) = M (I.select m y)
639679
640680-- | McCarthy's Conditional expresses probabilistic choice.
641681cond ::
642− ( I.Normalize (I.Normalize a) ~ I.Normalize a,
643− KnownNat (I.Count (I.Normalize a)),
644− I.FromLists e () (I.Normalize a),
645− I.FromLists e (I.Normalize a) (),
646− I.FromLists e (I.Normalize a) (I.Normalize a),
647− Bounded a,
648− Enum a,
649− Num e,
650− Ord e
682+ ( Trivial a,
683+ Trivial2 a,
684+ Trivial3 a,
685+ CountableN a,
686+ FLN () a,
687+ FLN a (),
688+ FLN a a,
689+ Liftable e a Bool
651690 )
652691 =>
653692 (a -> Bool) -> Matrix e a b -> Matrix e a b -> Matrix e a b
@@ -656,9 +695,13 @@ cond p (M a) (M b) = M (I.cond p a b)
656695-- Pretty print
657696
658697-- | Matrix pretty printer
659−pretty :: (KnownNat (I.Count (I.Normalize cols)), Show e) => Matrix e cols rows -> String
698+pretty :: (CountableDimsN cols rows, Show e) => Matrix e cols rows -> String
660699pretty (M m) = I.pretty m
661700
662701-- | Matrix pretty printer
663−prettyPrint :: (KnownNat (I.Count (I.Normalize cols)), Show e) => Matrix e cols rows -> IO ()
702+prettyPrint :: (CountableDimsN cols rows, Show e) => Matrix e cols rows -> IO ()
664703prettyPrint (M m) = I.prettyPrint m
704+
705+-- | Zip two matrices with a given binary function
706+zipWithM :: (e -> f -> g) -> Matrix e a b -> Matrix f a b -> Matrix g a b
707+zipWithM f (M a) (M b) = M (I.zipWithM f a b)
src/LAoP/Relation.hs+15−6
@@ -30,12 +30,21 @@ module LAoP.Relation
3030 Relation (..),
3131 Boolean,
3232
33+ -- * Constraint type synonyms
34+ Countable,
35+ CountableDims,
36+ CountableN,
37+ CountableDimsN,
38+ FLN,
39+ Liftable,
40+ Trivial,
41+ TrivialP,
42+
3343 -- * Primitives
34− empty,
3544 one,
36− junc,
45+ join,
3746 (|||),
38− split,
47+ fork,
3948 (===),
4049
4150 -- * Auxiliary type families
@@ -98,8 +107,8 @@ module LAoP.Relation
98107 splitR,
99108
100109 -- ** Projections
101− p1,
102− p2,
110+ fstR,
111+ sndR,
103112 -- ** Bifunctor
104113 (><),
105114 -- * Relational coproduct
@@ -138,7 +147,7 @@ module LAoP.Relation
138147 cond,
139148
140149 -- * Relational composition and lifting
141− identity,
150+ iden,
142151 comp,
143152 fromF,
144153 fromF',
src/LAoP/Relation/Internal.hs+302−336
@@ -1,3 +1,5 @@
1+{-# LANGUAGE TypeFamilies #-}
2+{-# LANGUAGE ConstraintKinds #-}
13{-# LANGUAGE GADTs #-}
24{-# LANGUAGE UndecidableInstances #-}
35{-# LANGUAGE FlexibleContexts #-}
@@ -39,12 +41,21 @@ module LAoP.Relation.Internal
3941 Relation (..),
4042 Boolean,
4143
44+ -- * Constraint type synonyms
45+ Countable,
46+ CountableDims,
47+ CountableN,
48+ CountableDimsN,
49+ FLN,
50+ Liftable,
51+ Trivial,
52+ TrivialP,
53+
4254 -- * Primitives
43− empty,
4455 one,
45− junc,
56+ join,
4657 (|||),
47− split,
58+ fork,
4859 (===),
4960
5061 -- * Auxiliary type families
@@ -55,14 +66,15 @@ module LAoP.Relation.Internal
5566 -- * Matrix construction and conversion
5667 I.FromLists,
5768 fromLists,
58− fromF,
5969 fromF',
70+ fromF,
6071 toRel,
6172 toLists,
6273 toList,
6374 toBool,
6475 pt,
6576 belongs,
77+ relationBuilder',
6678 relationBuilder,
6779 zeros,
6880 ones,
@@ -107,8 +119,8 @@ module LAoP.Relation.Internal
107119 splitR,
108120
109121 -- ** Projections
110− p1,
111− p2,
122+ fstR,
123+ sndR,
112124 -- ** Bifunctor
113125 (><),
114126 -- * Relational coproduct
@@ -147,10 +159,10 @@ module LAoP.Relation.Internal
147159 cond,
148160
149161 -- * Relational composition and lifting
150− identity,
162+ iden,
151163 comp,
152− fromF,
153164 fromF',
165+ fromF,
154166
155167 -- ** Relational application
156168 pointAp,
@@ -166,12 +178,13 @@ import Data.Void
166178import qualified LAoP.Matrix.Internal as I
167179import LAoP.Utils.Internal
168180import Control.DeepSeq
169−import qualified Control.Category as C
170181import Data.Bool
171182import GHC.TypeLits
183+import Prelude hiding (id, (.))
172184
173185-- | Boolean type synonym for working with boolean matrices
174186type Boolean = Natural 0 1
187+type Powerset a = List (List a)
175188
176189-- | Relation data type.
177190newtype Relation a b = R (I.Matrix Boolean (I.Normalize a) (I.Normalize b))
@@ -179,23 +192,31 @@ newtype Relation a b = R (I.Matrix Boolean (I.Normalize a) (I.Normalize b))
179192
180193deriving instance (Read (I.Matrix Boolean (I.Normalize a) (I.Normalize b))) => Read (Relation a b)
181194
182−-- | It isn't possible to implement the 'id' function so it's
183−-- implementation is 'undefined'. However 'comp' can be and this partial
184−-- class implementation exists just to make the code more readable.
185−--
186−-- Please use 'identity' instead.
187−instance C.Category Relation where
188− id = undefined
189− (.) = comp
195+-- | Constraint type synonyms to keep the type signatures less convoluted
196+type Countable a = KnownNat (I.Count a)
197+type CountableDims a b = (Countable a, Countable b)
198+type CountableN a = KnownNat (I.Count (I.Normalize a))
199+type CountableDimsN a b = (CountableN a, CountableN b)
200+type FLN a b = I.FromLists (I.Normalize a) (I.Normalize b)
201+type Liftable a b = (Bounded a, Bounded b, Enum a, Enum b, Eq b, Num Boolean, Ord Boolean)
202+type Trivial a = I.Normalize a ~ I.Normalize (I.Normalize a)
203+type TrivialP a b = I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
204+
205+-- | It is possible to implement a constrained version of the category type
206+-- class.
207+instance Category Relation where
208+ type Object Relation a = (FLN a a, CountableN a)
209+ id = iden
210+ (.) = comp
190211
191212instance Num (Relation a b) where
192− -- | Matrix addition becomes Boolean matrix disjunction
213+ -- | Matrix addition becomes Boolean matrix disjointion
193214 (R a) + (R b) = R (I.orM a b)
194215
195216 -- | Matrix subtraction becomes Relational subtraction
196217 (R a) - (R b) = R (I.subM a b)
197218
198− -- | Matrix multiplication becomes Boolean matrix conjunction
219+ -- | Matrix multiplication becomes Boolean matrix conjointion
199220 (R a) * (R b) = R (I.andM a b)
200221
201222 -- | Matrix negation becomes Boolean matrix negation
@@ -207,119 +228,103 @@ type One = ()
207228
208229-- Primitives
209230
210−-- | Empty matrix constructor
211−empty :: Relation Zero Zero
212−empty = R I.Empty
213−
214231-- | Unit matrix constructor
215232one :: Boolean -> Relation One One
216233one = R . I.One
217234
218−-- | Boolean Matrix 'Junc' constructor, also known as relational coproduct.
235+-- | Boolean Matrix 'Join' constructor, also known as relational coproduct.
219236--
220237-- See 'eitherR'.
221−junc :: (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b))
222− => Relation a c -> Relation b c -> Relation (Either a b) c
223−junc (R a) (R b) = R (I.Junc a b)
238+join :: Relation a c -> Relation b c -> Relation (Either a b) c
239+join (R a) (R b) = R (I.Join a b)
224240
225241infixl 3 |||
226−-- | Boolean Matrix 'Junc' constructor
242+-- | Boolean Matrix 'Join' constructor
227243--
228244-- See 'eitherR'.
229245(|||) ::
230− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
231246 Relation a c ->
232247 Relation b c ->
233248 Relation (Either a b) c
234−(|||) = junc
249+(|||) = join
235250
236−-- | Boolean Matrix 'Split' constructor, also known as relational product.
237−split :: (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b))
238− => Relation c a -> Relation c b -> Relation c (Either a b)
239−split (R a) (R b) = R (I.Split a b)
251+-- | Boolean Matrix 'Fork' constructor, also known as relational product.
252+fork :: Relation c a -> Relation c b -> Relation c (Either a b)
253+fork (R a) (R b) = R (I.Fork a b)
240254
241255infixl 2 ===
242−-- | Boolean Matrix 'Split' constructor
256+-- | Boolean Matrix 'Fork' constructor
243257(===) ::
244− (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)) =>
245258 Relation c a ->
246259 Relation c b ->
247260 Relation c (Either a b)
248−(===) = split
261+(===) = fork
249262
250263-- Construction
251264
252265-- | Build a matrix out of a list of list of elements. Throws a runtime
253266-- error if the dimensions do not match.
254−fromLists :: (I.FromLists Boolean (I.Normalize a) (I.Normalize b)) => [[Boolean]] -> Relation a b
267+fromLists :: (FLN a b) => [[Boolean]] -> Relation a b
255268fromLists = R . I.fromLists
256269
257−-- | Matrix builder function. Constructs a matrix provided with
258−-- a construction function.
270+-- | Relation builder function. Constructs a relation provided with
271+-- a construction function that operates with indices.
272+relationBuilder' ::
273+ (FLN a b, CountableDimsN a b) =>
274+ ((Int, Int) -> Boolean) -> Relation a b
275+relationBuilder' = R . I.matrixBuilder'
276+
277+-- | Relation builder function. Constructs a relation provided with
278+-- a construction function that operates with arbitrary types.
259279relationBuilder ::
260− (I.FromLists Boolean (I.Normalize a) (I.Normalize b), KnownNat (I.Count (I.Normalize a)), KnownNat (I.Count (I.Normalize b))) =>
261− ((Int, Int) -> Boolean) ->
262− Relation a b
280+ ( FLN a b,
281+ Enum a,
282+ Enum b,
283+ Bounded a,
284+ Bounded b,
285+ Eq a,
286+ CountableDims a b
287+ ) => ((a, b) -> Boolean) -> Relation a b
263288relationBuilder = R . I.matrixBuilder
264289
265290-- | Lifts functions to matrices with arbitrary dimensions.
266291--
267292-- NOTE: Be careful to not ask for a matrix bigger than the cardinality of
268293-- types @a@ or @b@ allows.
269−fromF ::
270− ( Bounded a,
271− Bounded b,
272− Enum a,
273− Enum b,
274− Eq b,
275− KnownNat (I.Count (I.Normalize c)),
276− KnownNat (I.Count (I.Normalize d)),
277− I.FromLists Boolean (I.Normalize d) (I.Normalize c)
294+fromF' ::
295+ ( Liftable a b,
296+ CountableDimsN c d,
297+ FLN d c
278298 )
279299 => (a -> b) -> Relation c d
280−fromF f = R (I.fromFRel f)
300+fromF' f = R (I.fromFRel' f)
281301
282302-- | Lifts functions to matrices with dimensions matching @a@ and @b@
283303-- cardinality's.
284−fromF' ::
285− ( Bounded b,
286− Bounded a,
287− Enum a,
288− Enum b,
289− Eq b,
290− KnownNat (I.Count (I.Normalize a)),
291− KnownNat (I.Count (I.Normalize b)),
292− I.FromLists Boolean (I.Normalize b) (I.Normalize a)
304+fromF ::
305+ ( Liftable a b,
306+ CountableDimsN a b,
307+ FLN b a
293308 )
294309 => (a -> b) -> Relation a b
295−fromF' f = R (I.fromFRel' f)
310+fromF f = R (I.fromFRel f)
296311
297312-- | Lifts relation functions to 'Relation'
298313toRel ::
299− ( Bounded b,
300− Bounded a,
301− Enum a,
302− Enum b,
303− Eq b,
304− KnownNat (I.Count (I.Normalize a)),
305− KnownNat (I.Count (I.Normalize b)),
306− I.FromLists Boolean (I.Normalize b) (I.Normalize a)
314+ ( Liftable a b,
315+ CountableDims a b,
316+ FLN b a
307317 )
308− => (a -> b -> Bool) -> Relation a b
318+ => (a -> b -> Bool) -> Relation a b
309319toRel = R . I.toRel
310320
311321-- | Lowers a 'Relation' to a function
312322fromRel ::
313− ( Bounded a,
314− Bounded b,
315− Enum a,
316− Enum b,
323+ ( Liftable a b,
317324 Eq a,
318− Eq b,
319− KnownNat (I.Count (I.Normalize a)),
320− KnownNat (I.Count (I.Normalize b)),
321− I.FromLists Boolean (I.Normalize a) One,
322− I.FromLists Boolean (I.Normalize b) One
325+ CountableDimsN a b,
326+ FLN a One,
327+ FLN b One
323328 )
324329 => Relation a b -> (a -> b -> Bool)
325330fromRel r a b = pointApBool a b r
@@ -343,52 +348,46 @@ toBool r = case toList r of
343348-- | Power transpose.
344349--
345350-- Maps a relation to a set valued function.
346−pt ::
347− ( Bounded a,
348− Bounded b,
349− Enum a,
350− Enum b,
351+pt ::
352+ ( Liftable a b,
351353 Eq a,
352− Eq b,
353− KnownNat (I.Count (I.Normalize a)),
354− KnownNat (I.Count (I.Normalize b)),
355− I.FromLists Boolean (I.Normalize a) One,
356− I.FromLists Boolean (I.Normalize b) One
354+ CountableDimsN a b,
355+ FLN a One,
356+ FLN b One
357357 )
358− => Relation a b -> (a -> Powerset b)
358+ => Relation a b -> (a -> List b)
359359pt r a =
360− let (PS lb) = maxBound
361− in PS [ b | b <- lb, toBool (pointAp a b r) ]
360+ let (L lb) = maxBound
361+ in L [ b | b <- lb, toBool (pointAp a b r) ]
362362
363363-- | Belongs relation
364364belongs ::
365365 ( Bounded a,
366366 Enum a,
367367 Eq a,
368− KnownNat (I.Count (I.Normalize (Powerset a))),
369− KnownNat (I.Count (I.Normalize a)),
370− I.FromLists Boolean (I.Normalize a) (I.Normalize (Powerset a))
368+ CountableDims (List a) a,
369+ FLN a (List a)
371370 )
372− => Relation (Powerset a) a
373−belongs = toRel (flip elemR)
371+ => Relation (List a) a
372+belongs = toRel elemR
374373 where
375− elemR x (PS l) = x `elem` l
374+ elemR (L l) x = x `elem` l
376375
377376-- Zeros Matrix
378377
379378-- | The zero relation. A relation where no element of type @a@ relates
380379-- with elements of type @b@.
381380--
382−-- Also known as ⊥ (Bottom) Relation or empty Relation.
381+-- Also known as ⊥ (Bottom) Relation.
383382--
384383-- @
385−-- r ``comp`` ⊥ == ⊥ ``comp`` r == ⊥
384+-- r `.` ⊥ == ⊥ `.` r == ⊥
386385-- ⊥ ``sse`` R && R ``sse`` T == True
387386-- @
388387zeros ::
389− (I.FromLists Boolean (I.Normalize a) (I.Normalize b), KnownNat (I.Count (I.Normalize a)), KnownNat (I.Count (I.Normalize b))) =>
388+ (FLN a b, CountableDimsN a b) =>
390389 Relation a b
391−zeros = relationBuilder (const (nat 0))
390+zeros = relationBuilder' (const (nat 0))
392391
393392-- Ones Matrix
394393
@@ -401,44 +400,43 @@ zeros = relationBuilder (const (nat 0))
401400-- ⊥ ``sse`` R && R ``sse`` T == True
402401-- @
403402ones ::
404− (I.FromLists Boolean (I.Normalize a) (I.Normalize b), KnownNat (I.Count (I.Normalize a)), KnownNat (I.Count (I.Normalize b))) =>
403+ (FLN a b, CountableDimsN a b) =>
405404 Relation a b
406−ones = relationBuilder (const (nat 1))
405+ones = relationBuilder' (const (nat 1))
407406
408407-- Bang Matrix
409408
410409-- | The T (Top) row vector relation.
411410bang ::
412− (I.FromLists Boolean (I.Normalize a) One, KnownNat (I.Count (I.Normalize a))) =>
411+ (FLN a One, CountableN a) =>
413412 Relation a One
414413bang = ones
415414
416415-- | Point constant relation
417−point ::
416+point ::
418417 ( Bounded a,
419418 Enum a,
420419 Eq a,
421− KnownNat (I.Count (I.Normalize a)),
422− I.FromLists Boolean (I.Normalize a) One
420+ CountableN a,
421+ FLN a One
423422 ) => a -> Relation One a
424−point = fromF' . const
423+point = fromF . const
425424
426−-- Identity Matrix
425+-- iden Matrix
427426
428−-- | Identity matrix
427+-- | iden matrix
429428--
430429-- @
431−-- 'identity' ``comp`` r == r == r ``comp`` 'identity'
430+-- 'iden' `.` r == r == r `.` 'iden'
432431-- @
433−identity ::
434− (I.FromLists Boolean (I.Normalize a) (I.Normalize a), KnownNat (I.Count (I.Normalize a))) =>
435− Relation a a
436−identity = relationBuilder (bool (nat 0) (nat 1) . uncurry (==))
432+iden ::
433+ (FLN a a, CountableN a) => Relation a a
434+iden = relationBuilder' (bool (nat 0) (nat 1) . uncurry (==))
437435
438436-- | Relational composition
439437--
440438-- @
441−-- r ``comp`` (s ``comp`` p) = (r ``comp`` s) ``comp`` p
439+-- r `.` (s `.` p) = (r `.` s) `.` p
442440-- @
443441comp :: Relation b c -> Relation a b -> Relation a c
444442comp (R a) (R b) = R (I.compRel a b)
@@ -486,8 +484,8 @@ shrunkBy r s = r `intersection` divR s (conv r)
486484-- r ``overriddenBy`` r == r
487485-- @
488486overriddenBy ::
489− ( I.FromLists Boolean (I.Normalize b) (I.Normalize b),
490− KnownNat (I.Count (I.Normalize b))
487+ ( FLN b b,
488+ CountableN b
491489 ) => Relation a b -> Relation a b -> Relation a b
492490overriddenBy r s = s `union` r `intersection` divR zeros (conv s)
493491
@@ -496,35 +494,25 @@ overriddenBy r s = s `union` r `intersection` divR zeros (conv s)
496494-- If @a@ and @b@ are related by 'Relation' @r@
497495-- then @'pointAp' a b r == 'one' ('nat' 1)@
498496pointAp ::
499− ( Bounded a,
500− Bounded b,
501− Enum a,
502− Enum b,
497+ ( Liftable a b,
503498 Eq a,
504− Eq b,
505− KnownNat (I.Count (I.Normalize a)),
506− KnownNat (I.Count (I.Normalize b)),
507− I.FromLists Boolean (I.Normalize a) One,
508− I.FromLists Boolean (I.Normalize b) One
499+ CountableDimsN a b,
500+ FLN a One,
501+ FLN b One
509502 ) => a -> b -> Relation a b -> Relation One One
510−pointAp a b r = conv (point b) `comp` r `comp` point a
503+pointAp a b r = conv (point b) . r . point a
511504
512505-- | Relational application
513506--
514507-- The same as 'pointAp' but converts 'Boolean' to 'Bool'
515508pointApBool ::
516− ( Bounded a,
517− Bounded b,
518− Enum a,
519− Enum b,
509+ ( Liftable a b,
520510 Eq a,
521− Eq b,
522− KnownNat (I.Count (I.Normalize a)),
523− KnownNat (I.Count (I.Normalize b)),
524− I.FromLists Boolean (I.Normalize a) One,
525− I.FromLists Boolean (I.Normalize b) One
511+ CountableDimsN a b,
512+ FLN a One,
513+ FLN b One
526514 ) => a -> b -> Relation a b -> Bool
527−pointApBool a b r = toBool $ conv (point b) `comp` r `comp` point a
515+pointApBool a b r = toBool $ conv (point b) . r . point a
528516
529517-- | Relational converse
530518--
@@ -550,7 +538,7 @@ iff r s = r == s
550538
551539-- | Relational intersection
552540--
553−-- Lifts pointwise conjunction.
541+-- Lifts pointwise conjointion.
554542--
555543-- @
556544-- (r ``intersection`` s) ``intersection`` t == r ``intersection`` (s ``intersection`` t)
@@ -561,13 +549,13 @@ intersection a b = a * b
561549
562550-- | Relational union
563551--
564−-- Lifts pointwise disjunction.
552+-- Lifts pointwise disjointion.
565553--
566554-- @
567555-- (r ``union`` s) ``union`` t == r `'union' (s ``union`` t)
568556-- r ``union`` s ``sse`` x == r ``sse`` x && s ``sse`` x
569−-- r ``comp`` (s ``union`` t) == (r ``comp`` s) ``union`` (r ``comp`` t)
570−-- (s ``union`` t) ``comp`` r == (s ``comp`` r) ``union`` (t ``comp`` r)
557+-- r `.` (s ``union`` t) == (r `.` s) ``union`` (r `.` t)
558+-- (s ``union`` t) `.` r == (s `.` r) ``union`` (t `.` r)
571559-- @
572560union :: Relation a b -> Relation a b -> Relation a b
573561union a b = a + b
@@ -575,46 +563,46 @@ union a b = a + b
575563-- | Relation Kernel
576564--
577565-- @
578−-- 'ker' r == 'conv' r ``comp`` r
566+-- 'ker' r == 'conv' r `.` r
579567-- 'ker' r == 'img' ('conv' r)
580568-- @
581569ker :: Relation a b -> Relation a a
582−ker r = conv r `comp` r
570+ker r = conv r . r
583571
584572-- | Relation Image
585573--
586574-- @
587−-- 'img' r == r ``comp`` conv r
575+-- 'img' r == r `.` conv r
588576-- 'img' r == 'ker' ('conv' r)
589577-- @
590578img :: Relation a b -> Relation b b
591−img r = r `comp` conv r
579+img r = r . conv r
592580
593581-- | Function division. Special case of 'divS'.
594582--
595583-- NOTE: _This is only valid_ if @f@ and @g@ are 'function's, i.e. 'simple' and
596584-- 'entire'.
597585--
598−-- @'divisionF' f g == 'conv' g ``comp`` f@
586+-- @'divisionF' f g == 'conv' g `.` f@
599587divisionF :: Relation a c -> Relation b c -> Relation a b
600−divisionF f g = conv g `comp` f
588+divisionF f g = conv g . f
601589
602590-- Taxonomy of binary relations
603591
604592-- | A 'Relation' @r@ is 'simple' 'iff' @'coreflexive' ('img' r)@
605−simple :: (KnownNat (I.Count (I.Normalize b)), I.FromLists Boolean (I.Normalize b) (I.Normalize b)) => Relation a b -> Bool
593+simple :: (CountableN b, FLN b b) => Relation a b -> Bool
606594simple = coreflexive . img
607595
608596-- | A 'Relation' @r@ is 'injective' 'iff' @'coreflexive' ('ker' r)@
609−injective :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a b -> Bool
597+injective :: (CountableN a, FLN a a) => Relation a b -> Bool
610598injective = coreflexive . ker
611599
612600-- | A 'Relation' @r@ is 'entire' 'iff' @'reflexive' ('ker' r)@
613−entire :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a b -> Bool
601+entire :: (CountableN a, FLN a a) => Relation a b -> Bool
614602entire = reflexive . ker
615603
616604-- | A 'Relation' @r@ is 'surjective' 'iff' @'reflexive' ('img' r)@
617−surjective :: (KnownNat (I.Count (I.Normalize b)), I.FromLists Boolean (I.Normalize b) (I.Normalize b)) => Relation a b -> Bool
605+surjective :: (CountableN b, FLN b b) => Relation a b -> Bool
618606surjective = reflexive . img
619607
620608-- | A 'Relation' @r@ is a 'function' 'iff' @'simple' r && 'entire' r@
@@ -623,118 +611,113 @@ surjective = reflexive . img
623611-- relations:
624612--
625613-- @
626−-- f ``comp`` r ``sse`` s == r ``sse`` f ``comp`` s
627−-- r ``comp`` f ``sse`` s == r ``sse`` s ``comp`` f
614+-- f `.` r ``sse`` s == r ``sse`` f `.` s
615+-- r `.` f ``sse`` s == r ``sse`` s `.` f
628616-- @
629617function ::
630− ( KnownNat (I.Count (I.Normalize b)),
631− KnownNat (I.Count (I.Normalize a)),
632− I.FromLists Boolean (I.Normalize a) (I.Normalize a),
633− I.FromLists Boolean (I.Normalize b) (I.Normalize b)
618+ ( CountableDimsN a b,
619+ FLN a a,
620+ FLN b b
634621 )
635622 => Relation a b -> Bool
636623function r = simple r && entire r
637624
638625-- | A 'Relation' @r@ is a 'representation' 'iff' @'injective' r && 'entire' r@
639626representation ::
640− ( KnownNat (I.Count (I.Normalize a)),
641− I.FromLists Boolean (I.Normalize a) (I.Normalize a)
627+ ( CountableN a,
628+ FLN a a
642629 )
643630 => Relation a b -> Bool
644631representation r = injective r && entire r
645632
646633-- | A 'Relation' @r@ is an 'abstraction' 'iff' @'surjective' r && 'simple' r@
647634abstraction ::
648− ( KnownNat (I.Count (I.Normalize b)),
649− I.FromLists Boolean (I.Normalize b) (I.Normalize b)
635+ ( CountableN b,
636+ FLN b b
650637 )
651638 => Relation a b -> Bool
652639abstraction r = surjective r && simple r
653640
654641-- | A 'Relation' @r@ is a 'surjection' 'iff' @'function' r && 'abstraction' r@
655642surjection ::
656− ( KnownNat (I.Count (I.Normalize b)),
657− KnownNat (I.Count (I.Normalize a)),
658− I.FromLists Boolean (I.Normalize a) (I.Normalize a),
659− I.FromLists Boolean (I.Normalize b) (I.Normalize b)
643+ ( CountableDimsN a b,
644+ FLN a a,
645+ FLN b b
660646 )
661647 => Relation a b -> Bool
662648surjection r = function r && abstraction r
663649
664650-- | A 'Relation' @r@ is a 'injection' 'iff' @'function' r && 'representation' r@
665651injection ::
666− ( KnownNat (I.Count (I.Normalize b)),
667− KnownNat (I.Count (I.Normalize a)),
668− I.FromLists Boolean (I.Normalize a) (I.Normalize a),
669− I.FromLists Boolean (I.Normalize b) (I.Normalize b)
652+ ( CountableDimsN a b,
653+ FLN a a,
654+ FLN b b
670655 )
671656 => Relation a b -> Bool
672657injection r = function r && representation r
673658
674659-- | A 'Relation' @r@ is an 'bijection' 'iff' @'injection' r && 'surjection' r@
675660bijection ::
676− ( KnownNat (I.Count (I.Normalize b)),
677− KnownNat (I.Count (I.Normalize a)),
678− I.FromLists Boolean (I.Normalize b) (I.Normalize b),
679− I.FromLists Boolean (I.Normalize a) (I.Normalize a)
661+ ( CountableDimsN a b,
662+ FLN b b,
663+ FLN a a
680664 ) => Relation a b -> Bool
681665bijection r = injection r && surjection r
682666
683−
684667-- Properties of relations
685668
686−-- | A 'Relation' @r@ is 'reflexive' 'iff' @'identity' ``sse`` r@
687−reflexive :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
688−reflexive r = identity <= r
669+-- | A 'Relation' @r@ is 'reflexive' 'iff' @'id' ``sse`` r@
670+reflexive :: (CountableN a, FLN a a) => Relation a a -> Bool
671+reflexive r = id <= r
689672
690−-- | A 'Relation' @r@ is 'coreflexive' 'iff' @r ``sse`` 'identity'@
691−coreflexive :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
692−coreflexive r = r <= identity
673+-- | A 'Relation' @r@ is 'coreflexive' 'iff' @r ``sse`` 'id'@
674+coreflexive :: (CountableN a, FLN a a) => Relation a a -> Bool
675+coreflexive r = r <= id
693676
694−-- | A 'Relation' @r@ is 'transitive' 'iff' @(r ``comp`` r) ``sse`` r@
677+-- | A 'Relation' @r@ is 'transitive' 'iff' @(r `.` r) ``sse`` r@
695678transitive :: Relation a a -> Bool
696−transitive r = (r `comp` r) `sse` r
679+transitive r = (r . r) `sse` r
697680
698681-- | A 'Relation' @r@ is 'symmetric' 'iff' @r == 'conv' r@
699682symmetric :: Relation a a -> Bool
700683symmetric r = r == conv r
701684
702−-- | A 'Relation' @r@ is anti-symmetric 'iff' @(r ``intersection`` 'conv' r) ``sse`` 'identity'@
703−antiSymmetric :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
704−antiSymmetric r = (r `intersection` conv r) `sse` identity
685+-- | A 'Relation' @r@ is anti-symmetric 'iff' @(r ``intersection`` 'conv' r) ``sse`` 'id'@
686+antiSymmetric :: (CountableN a, FLN a a) => Relation a a -> Bool
687+antiSymmetric r = (r `intersection` conv r) `sse` id
705688
706−-- | A 'Relation' @r@ is 'irreflexive' 'iff' @(r ``intersection`` 'identity') == 'zeros'@
707−irreflexive :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
708−irreflexive r = (r `intersection` identity) == zeros
689+-- | A 'Relation' @r@ is 'irreflexive' 'iff' @(r ``intersection`` 'id') == 'zeros'@
690+irreflexive :: (CountableN a, FLN a a) => Relation a a -> Bool
691+irreflexive r = (r `intersection` id) == zeros
709692
710693-- | A 'Relation' @r@ is 'connected' 'iff' @(r ``union`` 'conv' r) == 'ones'@
711−connected :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
694+connected :: (CountableN a, FLN a a) => Relation a a -> Bool
712695connected r = (r `union` conv r) == ones
713696
714697-- | A 'Relation' @r@ is a 'preorder' 'iff' @'reflexive' r && 'transitive' r@
715−preorder :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
698+preorder :: (CountableN a, FLN a a) => Relation a a -> Bool
716699preorder r = reflexive r && transitive r
717700
718701-- | A 'Relation' @r@ is a partial-order 'iff' @'antiSymmetric' r && 'preorder' r@
719−partialOrder :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
702+partialOrder :: (CountableN a, FLN a a) => Relation a a -> Bool
720703partialOrder r = antiSymmetric r && preorder r
721704
722705-- | A 'Relation' @r@ is a linear-order 'iff' @'connected' r && 'partialOrder' r@
723−linearOrder :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
706+linearOrder :: (CountableN a, FLN a a) => Relation a a -> Bool
724707linearOrder r = connected r && partialOrder r
725708
726709-- | A 'Relation' @r@ is an 'equivalence' 'iff' @'symmetric' r && 'preorder' r@
727−equivalence :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
710+equivalence :: (CountableN a, FLN a a) => Relation a a -> Bool
728711equivalence r = symmetric r && preorder r
729712
730713-- | A 'Relation' @r@ is a partial-equivalence 'iff' @'partialOrder' r && 'equivalence' r@
731−partialEquivalence :: (KnownNat (I.Count (I.Normalize a)), I.FromLists Boolean (I.Normalize a) (I.Normalize a)) => Relation a a -> Bool
714+partialEquivalence :: (CountableN a, FLN a a) => Relation a a -> Bool
732715partialEquivalence r = partialOrder r && equivalence r
733716
734717-- | A 'Relation' @r@ is 'difunctional' or regular wherever
735−-- @r ``comp`` 'conv' r ``comp`` r == r@
718+-- @r `.` 'conv' r `.` r == r@
736719difunctional :: Relation a b -> Bool
737−difunctional r = r `comp` conv r `comp` r == r
720+difunctional r = r . conv r . r == r
738721
739722-- Relational pairing
740723
@@ -743,64 +726,61 @@ difunctional r = r `comp` conv r `comp` r == r
743726-- NOTE: That this is not a true categorical product, see for instance:
744727--
745728-- @
746−-- | 'p1' ``comp`` 'splitR' a b ``sse`` a
729+-- | 'fstR' `.` 'splitR' a b ``sse`` a
747730-- 'splitR' a b <=> |
748−-- | 'p2' ``comp`` 'splitR' a b ``sse`` b
731+-- | 'sndR' `.` 'splitR' a b ``sse`` b
749732-- @
750733--
751734-- __Emphasis__ on the 'sse'.
752735--
753736-- @
754−-- 'splitR' r s ``comp`` f == 'splitR' (r ``comp`` f) (s ``comp`` f)
755−-- (R '><' S) ``comp`` 'splitR' p q == 'splitR' (r ``comp`` p) (s ``comp`` q)
756−-- 'conv' ('splitR' r s) ``comp`` 'splitR' x y == ('conv' r ``comp`` x) ``intersection`` ('conv' s ``comp`` y)
737+-- 'splitR' r s `.` f == 'splitR' (r `.` f) (s `.` f)
738+-- (R '><' S) `.` 'splitR' p q == 'splitR' (r `.` p) (s `.` q)
739+-- 'conv' ('splitR' r s) `.` 'splitR' x y == ('conv' r `.` x) ``intersection`` ('conv' s `.` y)
757740-- @
758741--
759742-- @
760743-- 'eitherR' ('splitR' r s) ('splitR' t v) == 'splitR' ('eitherR' r t) ('eitherR' s v)
761744-- @
762745splitR ::
763− ( KnownNat (I.Count (I.Normalize a)),
764− KnownNat (I.Count (I.Normalize b)),
765− KnownNat (I.Count (I.Normalize (a, b))),
766− I.FromLists Boolean (I.Normalize (a, b)) (I.Normalize a),
767− I.FromLists Boolean (I.Normalize (a, b)) (I.Normalize b),
768− I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
746+ ( CountableDimsN a b,
747+ CountableN (a, b),
748+ FLN (a, b) a,
749+ FLN (a, b) b,
750+ TrivialP a b
769751 )
770752 => Relation c a -> Relation c b -> Relation c (a, b)
771−splitR (R f) (R g) = R (I.khatri f g)
753+splitR (R f) (R g) = R (I.kr f g)
772754
773755-- | Relational pairing first component projection
774756--
775757-- @
776−-- 'p1' ``comp`` 'splitR' r s ``sse`` r
758+-- 'fstR' `.` 'splitR' r s ``sse`` r
777759-- @
778−p1 ::
760+fstR ::
779761 forall a b .
780− ( KnownNat (I.Count (I.Normalize a)),
781− KnownNat (I.Count (I.Normalize b)),
782− KnownNat (I.Count (I.Normalize (a, b))),
783− I.FromLists Boolean (I.Normalize (a, b)) (I.Normalize a),
784− I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
762+ ( CountableDimsN a b,
763+ CountableN (a, b),
764+ FLN (a, b) a,
765+ TrivialP a b
785766 )
786767 => Relation (a, b) a
787−p1 = R (I.kp1 @Boolean @(I.Normalize a) @(I.Normalize b))
768+fstR = R (I.fstM @Boolean @(I.Normalize a) @(I.Normalize b))
788769
789770-- | Relational pairing second component projection
790771--
791772-- @
792−-- 'p2' ``comp`` 'splitR' r s ``sse`` s
773+-- 'sndR' `.` 'splitR' r s ``sse`` s
793774-- @
794−p2 ::
775+sndR ::
795776 forall a b .
796− ( KnownNat (I.Count (I.Normalize b)),
797− KnownNat (I.Count (I.Normalize a)),
798− KnownNat (I.Count (I.Normalize (a, b))),
799− I.FromLists Boolean (I.Normalize (a, b)) (I.Normalize b),
800− I.Normalize (a, b) ~ I.Normalize (I.Normalize a, I.Normalize b)
777+ ( CountableDimsN a b,
778+ CountableN (a, b),
779+ FLN (a, b) b,
780+ TrivialP a b
801781 )
802782 => Relation (a, b) b
803−p2 = R (I.kp2 @Boolean @(I.Normalize a) @(I.Normalize b))
783+sndR = R (I.sndM @Boolean @(I.Normalize a) @(I.Normalize b))
804784
805785-- Relational pairing functor
806786
@@ -808,22 +788,19 @@ infixl 4 ><
808788-- | Relational pairing functor
809789--
810790-- @
811−-- r '><' s == 'splitR' (r ``comp`` p1) (s ``comp`` p2)
812−-- (r '><' s) ``comp`` (p '><' q) == (r ``comp`` p) '><' (s ``comp`` q)
791+-- r '><' s == 'splitR' (r `.` fstR) (s `.` sndR)
792+-- (r '><' s) `.` (p '><' q) == (r `.` p) '><' (s `.` q)
813793-- @
814794(><) ::
815− ( KnownNat (I.Count (I.Normalize a)),
816− KnownNat (I.Count (I.Normalize b)),
817− KnownNat (I.Count (I.Normalize c)),
818− KnownNat (I.Count (I.Normalize d)),
819− KnownNat (I.Count (I.Normalize (a, c))),
820− KnownNat (I.Count (I.Normalize (b, d))),
821− I.FromLists Boolean (I.Normalize (a, c)) (I.Normalize a),
822− I.FromLists Boolean (I.Normalize (a, c)) (I.Normalize c),
823− I.FromLists Boolean (I.Normalize (b, d)) (I.Normalize b),
824− I.FromLists Boolean (I.Normalize (b, d)) (I.Normalize d),
825− I.Normalize (a, c) ~ I.Normalize (I.Normalize a, I.Normalize c),
826− I.Normalize (b, d) ~ I.Normalize (I.Normalize b, I.Normalize d)
795+ ( CountableDimsN a b,
796+ CountableDimsN c d,
797+ CountableDimsN (a, c) (b, d),
798+ FLN (a, c) a,
799+ FLN (a, c) c,
800+ FLN (b, d) b,
801+ FLN (b, d) d,
802+ TrivialP a c,
803+ TrivialP b d
827804 )
828805 => Relation a b -> Relation c d -> Relation (a, c) (b, d)
829806(><) (R a) (R b) = R ((I.><) a b)
@@ -833,34 +810,31 @@ infixl 4 ><
833810-- | Relational coproduct.
834811--
835812-- @
836−-- | 'eitherR' a b ``comp`` 'i1' == a
813+-- | 'eitherR' a b `.` 'i1' == a
837814-- 'eitherR' a b <=> |
838−-- | 'eitherR' a b ``comp`` 'i2' == b
815+-- | 'eitherR' a b `.` 'i2' == b
839816-- @
840817--
841818-- @
842−-- 'eitherR' r s ``comp`` 'conv' ('eitherR' t u) == (r ``comp`` 'conv' t) ``union`` (s ``comp`` 'conv' u)
819+-- 'eitherR' r s `.` 'conv' ('eitherR' t u) == (r `.` 'conv' t) ``union`` (s `.` 'conv' u)
843820-- @
844821--
845822-- @
846823-- 'eitherR' ('splitR' r s) ('splitR' t v) == 'splitR' ('eitherR' r t) ('eitherR' s v)
847824-- @
848−eitherR :: (I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b))
849− => Relation a c -> Relation b c -> Relation (Either a b) c
850−eitherR = junc
825+eitherR :: Relation a c -> Relation b c -> Relation (Either a b) c
826+eitherR = join
851827
852828-- | Relational coproduct first component injection
853829--
854830-- @
855−-- 'img' 'i1' ``union`` 'img' 'i2' == 'identity'
856−-- 'i1' ``comp`` 'i2' = 'zeros'
831+-- 'img' 'i1' ``union`` 'img' 'i2' == 'id'
832+-- 'i1' `.` 'i2' = 'zeros'
857833-- @
858834i1 ::
859− ( KnownNat (I.Count (I.Normalize b)),
860− KnownNat (I.Count (I.Normalize a)),
861− I.FromLists Boolean (I.Normalize b) (I.Normalize a),
862− I.FromLists Boolean (I.Normalize a) (I.Normalize a),
863− I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)
835+ ( CountableDimsN a b,
836+ FLN b a,
837+ FLN a a
864838 )
865839 => Relation a (Either a b)
866840i1 = R I.i1
@@ -868,15 +842,13 @@ i1 = R I.i1
868842-- | Relational coproduct second component injection
869843--
870844-- @
871−-- 'img' 'i1' ``union`` 'img' 'i2' == 'identity'
872−-- 'i1' ``comp`` 'i2' = 'zeros'
845+-- 'img' 'i1' ``union`` 'img' 'i2' == 'id'
846+-- 'i1' `.` 'i2' = 'zeros'
873847-- @
874848i2 ::
875− ( KnownNat (I.Count (I.Normalize b)),
876− KnownNat (I.Count (I.Normalize a)),
877− I.FromLists Boolean (I.Normalize a) (I.Normalize b),
878− I.FromLists Boolean (I.Normalize b) (I.Normalize b),
879− I.Normalize (Either a b) ~ Either (I.Normalize a) (I.Normalize b)
849+ ( CountableDimsN a b,
850+ FLN a b,
851+ FLN b b
880852 )
881853 => Relation b (Either a b)
882854i2 = R I.i2
@@ -886,17 +858,14 @@ infixl 5 -|-
886858-- | Relational coproduct functor.
887859--
888860-- @
889−-- r '-|-' s == 'eitherR' ('i1' ``comp`` r) ('i2' ``comp`` s)
861+-- r '-|-' s == 'eitherR' ('i1' `.` r) ('i2' `.` s)
890862-- @
891863(-|-) ::
892− ( KnownNat (I.Count (I.Normalize d)),
893− KnownNat (I.Count (I.Normalize b)),
894− I.FromLists Boolean (I.Normalize b) (I.Normalize b),
895− I.FromLists Boolean (I.Normalize d) (I.Normalize b),
896− I.FromLists Boolean (I.Normalize b) (I.Normalize d),
897− I.FromLists Boolean (I.Normalize d) (I.Normalize d),
898− I.Normalize (Either a c) ~ Either (I.Normalize a) (I.Normalize c),
899− I.Normalize (Either b d) ~ Either (I.Normalize b) (I.Normalize d)
864+ ( CountableDimsN b d,
865+ FLN b b,
866+ FLN d b,
867+ FLN b d,
868+ FLN d d
900869 )
901870 => Relation a b -> Relation c d -> Relation (Either a c) (Either b d)
902871(-|-) (R a) (R b) = R ((I.-|-) a b)
@@ -909,22 +878,20 @@ infixl 5 -|-
909878-- 'trans'/'untrans';
910879-- more-over, where each particular attribute is placed (input/output) is irrelevant.
911880trans ::
912− ( KnownNat (I.Count (I.Normalize (a, b))),
913− KnownNat (I.Count (I.Normalize a)),
914− KnownNat (I.Count (I.Normalize (c, b))),
915− KnownNat (I.Count (I.Normalize b)),
916− KnownNat (I.Count (I.Normalize c)),
917− I.FromLists Boolean (I.Normalize (c, b)) (I.FromNat (I.Count c)),
918− I.FromLists Boolean (I.Normalize (c, b)) (I.FromNat (I.Count b)),
919− I.FromLists Boolean (I.Normalize (a, b)) (I.FromNat (I.Count b)),
920− I.FromLists Boolean (I.Normalize (a, b)) (I.FromNat (I.Count a)),
921− I.Normalize (a, b) ~ I.Normalize (I.Normalize (a, b)),
922− I.Normalize (c, b) ~ I.Normalize (I.Normalize (c, b)),
923− I.Normalize (I.Normalize a, I.Normalize b) ~ I.FromNat (I.Count (I.Normalize (a, b))),
924− I.Normalize (I.Normalize c, I.Normalize b) ~ I.FromNat (I.Count (I.Normalize (c, b)))
881+ ( CountableDimsN a b,
882+ CountableN c,
883+ CountableDimsN (a, b) (c, b),
884+ FLN (c, b) c,
885+ FLN (c, b) b,
886+ FLN (a, b) a,
887+ FLN (a, b) b,
888+ Trivial (a, b),
889+ Trivial (c, b),
890+ TrivialP a b,
891+ TrivialP c b
925892 )
926893 => Relation (a, b) c -> Relation a (c, b)
927−trans r = splitR r p2 `comp` conv p1
894+trans r = splitR r sndR . conv fstR
928895
929896-- | Relational 'untrans'
930897--
@@ -932,111 +899,110 @@ trans r = splitR r p2 `comp` conv p1
932899-- 'trans'/'untrans';
933900-- more-over, where each particular attribute is placed (input/output) is irrelevant.
934901untrans ::
935− ( KnownNat (I.Count (I.Normalize (a, b))),
936− KnownNat (I.Count (I.Normalize a)),
937− KnownNat (I.Count (I.Normalize (c, b))),
938− KnownNat (I.Count (I.Normalize b)),
939− KnownNat (I.Count (I.Normalize c)),
940− I.FromLists Boolean (I.Normalize (c, b)) (I.FromNat (I.Count c)),
941− I.FromLists Boolean (I.Normalize (c, b)) (I.FromNat (I.Count b)),
942− I.FromLists Boolean (I.Normalize (a, b)) (I.FromNat (I.Count b)),
943− I.FromLists Boolean (I.Normalize (a, b)) (I.FromNat (I.Count a)),
944− I.Normalize (a, b) ~ I.Normalize (I.Normalize (a, b)),
945− I.Normalize (c, b) ~ I.Normalize (I.Normalize (c, b)),
946− I.Normalize (I.Normalize a, I.Normalize b) ~ I.FromNat (I.Count (I.Normalize (a, b))),
947− I.Normalize (I.Normalize c, I.Normalize b) ~ I.FromNat (I.Count (I.Normalize (c, b)))
902+ ( CountableDimsN a b,
903+ CountableN c,
904+ CountableDimsN (a, b) (c, b),
905+ FLN (c, b) c,
906+ FLN (c, b) b,
907+ FLN (a, b) b,
908+ FLN (a, b) a,
909+ Trivial (a, b),
910+ Trivial (c, b),
911+ TrivialP a b,
912+ TrivialP c b
948913 )
949914 => Relation a (c, b) -> Relation (a, b) c
950−untrans s = p1 `comp` conv (splitR (conv s) p2)
915+untrans s = fstR . conv (splitR (conv s) sndR)
951916
952917-- | Transforms predicate @p@ into a correflexive relation.
953918--
954919-- @
955−-- 'predR' ('const' True) == 'identity'
920+-- 'predR' ('const' True) == 'id'
956921-- 'predR' ('const' False) == 'zeros'
957922-- @
958923--
959924-- @
960−-- 'predR' q ``comp`` 'predR' p == 'predR' q ``union`` 'predR' p
925+-- 'predR' q `.` 'predR' p == 'predR' q ``union`` 'predR' p
961926-- @
962927predR ::
963928 ( Bounded a,
964929 Enum a,
965− KnownNat (I.Count (I.Normalize a)),
966− I.FromLists Boolean (I.Normalize a) (I.Normalize a),
967− I.FromLists Boolean (I.Normalize Bool) (I.Normalize a)
930+ Countable a,
931+ CountableN a,
932+ FLN a a,
933+ FLN Bool a
968934 )
969− => (a -> Bool) -> Relation a a
970−predR p = identity `intersection` divisionF (fromF' (const True)) (fromF' p)
935+ => Relation a Bool -> Relation a a
936+predR p = id `intersection` divisionF (fromF (const True)) p
971937
972938-- | Equalizes functions @f@ and @g@.
973939-- That is, @'equalizer' f g@ is the largest coreflexive
974940-- that restricts @g@ so that @f@ and @g@ yield the same outputs.
975941--
976942-- @
977−-- 'equalizer' r r == 'identity'
943+-- 'equalizer' r r == 'id'
978944-- 'equalizer' ('point' True) ('point' False) == 'zeros'
979945-- @
980946equalizer ::
981− ( KnownNat (I.Count (I.Normalize a)),
982− I.FromLists Boolean (I.Normalize a) (I.Normalize a)
947+ ( CountableN a,
948+ FLN a a
983949 )
984950 => Relation a b -> Relation a b -> Relation a a
985−equalizer f g = identity `intersection` divisionF f g
951+equalizer f g = id `intersection` divisionF f g
986952
987953-- | Relational conditional guard.
988954--
989955-- @
990−-- 'guard' p = 'i2' ``overriddenBy`` 'i1' ``comp`` 'predR' p
956+-- 'guard' p = 'i2' ``overriddenBy`` 'i1' `.` 'predR' p
991957-- @
992−guard ::
958+guard ::
993959 ( Bounded b,
994960 Enum b,
995− KnownNat (I.Count (I.Normalize b)),
996− I.FromLists Boolean (I.Normalize b) (I.Normalize b),
997− I.FromLists Boolean (I.Normalize Bool) (I.Normalize b),
998− I.Normalize (Either b b) ~ Either (I.Normalize b) (I.Normalize b)
999− ) => (b -> Bool) -> Relation b (Either b b)
1000−guard p = conv (eitherR (predR p) (predR (not . p)))
961+ CountableN b,
962+ Countable b,
963+ FLN b b,
964+ FLN Bool b
965+ ) => Relation b Bool -> Relation b (Either b b)
966+guard p = conv (eitherR (predR p) (predR (negate p)))
1001967
1002968-- | Relational McCarthy's conditional.
1003−cond ::
969+cond ::
1004970 ( Bounded b,
1005971 Enum b,
1006− KnownNat (I.Count (I.Normalize b)),
1007− I.FromLists Boolean (I.Normalize b) (I.Normalize b),
1008− I.FromLists Boolean (I.Normalize Bool) (I.Normalize b),
1009− I.Normalize (Either b b) ~ Either (I.Normalize b) (I.Normalize b)
1010− )
1011− => (b -> Bool) -> Relation b c -> Relation b c -> Relation b c
1012−cond p r s = eitherR r s `comp` guard p
972+ Countable b,
973+ CountableN b,
974+ FLN b b,
975+ FLN Bool b
976+ )
977+ => Relation b Bool -> Relation b c -> Relation b c -> Relation b c
978+cond p r s = eitherR r s . guard p
1013979
1014980-- | Relational domain.
1015981--
1016982-- For injective relations, 'domain' and 'ker'nel coincide,
1017−-- since @'ker' r ``sse`` 'identity'@ in such situations.
983+-- since @'ker' r ``sse`` 'id'@ in such situations.
1018984domain ::
1019− ( KnownNat (I.Count (I.Normalize a)),
1020− I.FromLists Boolean (I.Normalize a) (I.Normalize a)
985+ ( CountableN a,
986+ FLN a a
1021987 ) => Relation a b -> Relation a a
1022−domain r = ker r `intersection` identity
988+domain r = ker r `intersection` id
1023989
1024990-- | Relational range.
1025991--
1026992-- For functions, 'range' and 'img' (image) coincide,
1027−-- since @'img' f ``sse`` 'identity'@ for any @f@.
993+-- since @'img' f ``sse`` id@ for any @f@.
1028994range ::
1029− ( I.FromLists Boolean (I.Normalize b) (I.Normalize b),
1030− KnownNat (I.Count (I.Normalize b))
995+ ( CountableN b,
996+ FLN b b
1031997 ) => Relation a b -> Relation b b
1032−range r = img r `intersection` identity
998+range r = img r `intersection` id
1033999
10341000-- Relation pretty print
10351001
10361002-- | Relation pretty printing
1037−pretty :: (KnownNat (I.Count (I.Normalize a))) => Relation a b -> String
1003+pretty :: (CountableDimsN a b) => Relation a b -> String
10381004pretty (R a) = I.pretty a
10391005
10401006-- | Relation pretty printing
1041−prettyPrint :: (KnownNat (I.Count (I.Normalize a))) => Relation a b -> IO ()
1007+prettyPrint :: (CountableDimsN a b) => Relation a b -> IO ()
10421008prettyPrint (R a) = I.prettyPrint a
src/LAoP/Utils.hs+5−2
@@ -95,8 +95,11 @@ module LAoP.Utils
9595 coerceNat2,
9696 coerceNat3,
9797
98− -- * Powerset data type
99− Powerset (..)
98+ -- * List data type
99+ List (..),
100+
101+ -- * Category type-class
102+ Category(..)
100103 )
101104where
102105
src/LAoP/Utils/Internal.hs+41−83
@@ -1,82 +1,13 @@
1+{-# LANGUAGE TypeFamilies #-}
2+{-# LANGUAGE DeriveGeneric #-}
13{-# LANGUAGE TypeApplications #-}
24{-# LANGUAGE DataKinds #-}
35{-# LANGUAGE FlexibleInstances #-}
46{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE KindSignatures #-}
67{-# LANGUAGE ScopedTypeVariables #-}
78
89module LAoP.Utils.Internal
9− ( -- | This is an internal module and it is not meant to be imported.
10− --
11− -- Utility module that provides the 'Natural' data type.
12− -- The semantic associated with this data type is that
13− -- it's meant to be a restricted 'Int' value. For example
14− -- the type @Natural 6@ can only be instanciated with @Nat n@
15− -- where @0 <= n <= 6@. Why, You might ask, because with normal
16− -- 'Int's it is not possible to have a decent @Enum (Int, Int)@
17− -- instance. See the following probabilistic programming model as and
18− -- example:
19− --
20− -- We want to calculate the probability of the sum of two dice throws.
21− -- To do this we start by defining the sample space:
22− --
23− -- @
24− -- type SampleSpace = Int -- We think 'Int' are enough
25− --
26− -- die :: Dist Int 6
27− -- die = unifrom [1..6]
28− --
29− -- -- Promote 'Int' addition to a matrix
30− -- addM = fromF (uncurry (+)) -- Impossible
31− -- @
32− --
33− -- The last line is impossible because @(Int, Int)@ does not have
34− -- a good 'Enum' instance: @[(0, 1), (0, 2), .. (0, maxBound), (1, 0),
35− -- ..]@. And we'd like the addition matrix to be of 36 columns by 12
36− -- rows but limited to integers up to @6@!
37− --
38− -- One way to solve this issue is by defining and auxilary data type to
39− -- represent the sample space:
40− --
41− -- @
42− -- data SampleSpace = S1 | S2 | S3 | S4 | S5 | S6
43− -- deriving (Show, Eq, Enum, Bounded) -- Enum and Bounded are
44− -- important
45− -- @
46− --
47− -- And write the sample space addition function:
48− --
49− -- @
50− -- ssAdd :: SampleSpace -> SampleSpace -> Int
51− -- ssAdd a b = (fromEnum a + 1) + (fromEnum b + 1)
52− -- @
53− --
54− -- And then promote that function to matrix and everything is alright:
55− --
56− -- @
57− -- ssAddM = fromF' (uncurry ssAdd)
58− --
59− -- dieSumProb = ssAddM `comp` (khatri die die)
60− -- @
61− --
62− -- This is a nice solution for small sample spaces. But for larger ones
63− -- it is not feasible to write a data type with hundreds of constructors
64− -- and then write manipulation functions that need to deal with them.
65− -- To mitigate this limitation the 'Natural' type comes a long way and
66− -- allows one to model the sample in an easier way. See for instance:
67− --
68− -- @
69− -- ssAdd :: Natural 6 -> Natural 6 -> Natural 12
70− -- ssAdd = coerceNat (+)
71− --
72− -- ssAddM = fromF' (uncurry sumSS)
73− --
74− -- die :: Dist (Natural 6) 6
75− -- die = uniform [nat @6 1 .. nat 6]
76− --
77− -- dieSumProb = ssAddM `comp` (khatri die die)
78− -- @
79− --
10+ (
8011 -- * 'Natural' data type
8112 Natural(..),
8213 nat,
@@ -87,8 +18,11 @@ module LAoP.Utils.Internal
8718 coerceNat2,
8819 coerceNat3,
8920
90− -- * Powerset data type
91− Powerset (..)
21+ -- * 'List' data type
22+ List (..),
23+
24+ -- * Category type class
25+ Category(..)
9226 )
9327where
9428
@@ -98,12 +32,16 @@ import Data.List
9832import Data.Maybe
9933import GHC.TypeLits
10034import Control.DeepSeq
35+import GHC.Generics
36+import Data.Kind
37+import Prelude hiding (id, (.))
38+import qualified Prelude
10139
10240-- | Wrapper around 'Int's that have a restrictive semantic associated.
10341-- A value of type @'Natural' n m@ can only be instanciated with some 'Int'
10442-- @i@ that's @n <= i <= m@.
10543newtype Natural (start :: Nat) (end :: Nat) = Nat Int
106− deriving (Show, Read, Eq, Ord, NFData)
44+ deriving (Show, Read, Eq, Ord, NFData, Generic)
10745
10846-- | Throws a runtime error if any of the operations overflows or
10947-- underflows.
@@ -207,7 +145,7 @@ instance
207145--
208146-- This data type is a newtype wrapper around '[]'. This exists in order to
209147-- implement an 'Enum' and 'Bounded' instance that cannot be harmful for the outside.
210−newtype Powerset a = PS [a]
148+newtype List a = L [a]
211149 deriving (Eq, Show, Read)
212150
213151powerset :: [a] -> [[a]]
@@ -217,22 +155,42 @@ powerset (x:xs) = powerset xs ++ [x:ps | ps <- powerset xs]
217155instance
218156 ( Enum a,
219157 Bounded a
220− ) => Bounded (Powerset a)
158+ ) => Bounded (List a)
221159 where
222− minBound = PS []
223− maxBound = PS [minBound .. maxBound]
160+ minBound = L []
161+ maxBound = L [minBound .. maxBound]
224162
225163instance
226164 ( Bounded a,
227165 Enum a,
228166 Eq a
229− ) => Enum (Powerset a)
167+ ) => Enum (List a)
230168 where
231169 toEnum i =
232170 let as = [minBound .. maxBound]
233− in PS (powerset as !! i)
171+ in L (powerset as !! i)
234172
235− fromEnum (PS []) = 0
236− fromEnum (PS x) =
173+ fromEnum (L []) = 0
174+ fromEnum (L x) =
237175 let as = [minBound .. maxBound]
238176 in fromMaybe (error "Does not exist") $ elemIndex x (powerset as)
177+
178+-- | Constrained category instance
179+class Category k where
180+ type Object k o :: Constraint
181+ type Object k o = ()
182+ id :: Object k a => k a a
183+ (.) :: k b c -> k a b -> k a c
184+
185+{-# RULES
186+"identity/left" forall p .
187+ id . p = p
188+"identity/right" forall p .
189+ p . id = p
190+"association" forall p q r .
191+ (p . q) . r = p . (q . r)
192+ #-}
193+
194+instance Category (->) where
195+ id = Prelude.id
196+ (.) = (Prelude..)
stack-8.8.3.yamlnew file+1
@@ -0,0 +1 @@
1+resolver: lts-15.5
stack.yaml+1−66
@@ -1,66 +1 @@
1−# This file was automatically generated by 'stack init'
2−#
3−# Some commonly used options have been documented as comments in this file.
4−# For advanced use and comprehensive documentation of the format, please see:
5−# https://docs.haskellstack.org/en/stable/yaml_configuration/
6−
7−# Resolver to choose a 'specific' stackage snapshot or a compiler version.
8−# A snapshot resolver dictates the compiler version and the set of packages
9−# to be used for project dependencies. For example:
10−#
11−# resolver: lts-3.5
12−# resolver: nightly-2015-09-21
13−# resolver: ghc-7.10.2
14−#
15−# The location of a snapshot can be provided as a file or url. Stack assumes
16−# a snapshot provided as a file might change, whereas a url resource does not.
17−#
18−# resolver: ./custom-snapshot.yaml
19−# resolver: https://example.com/snapshots/2018-01-01.yaml
20−resolver: lts-14.18
21−
22−# User packages to be built.
23−# Various formats can be used as shown in the example below.
24−#
25−# packages:
26−# - some-directory
27−# - https://example.com/foo/bar/baz-0.0.2.tar.gz
28−# subdirs:
29−# - auto-update
30−# - wai
31−packages:
32−- .
33−# Dependency packages to be pulled from upstream that are not in the resolver.
34−# These entries can reference officially published versions as well as
35−# forks / in-progress versions pinned to a git hash. For example:
36−#
37−# extra-deps:
38−# - acme-missiles-0.3
39−# - git: https://github.com/commercialhaskell/stack.git
40−# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
41−#
42−# extra-deps: []
43−
44−# Override default flag values for local packages and extra-deps
45−# flags: {}
46−
47−# Extra package databases containing global packages
48−# extra-package-dbs: []
49−
50−# Control whether we use the GHC we find on the path
51−# system-ghc: true
52−#
53−# Require a specific version of stack, using version ranges
54−# require-stack-version: -any # Default
55−# require-stack-version: ">=2.1"
56−#
57−# Override the architecture used by stack, especially useful on Windows
58−# arch: i386
59−# arch: x86_64
60−#
61−# Extra directories used by stack for building
62−# extra-include-dirs: [/path/to/dir]
63−# extra-lib-dirs: [/path/to/dir]
64−#
65−# Allow a newer minor version of GHC than the snapshot specifies
66−# compiler-check: newer-minor
1+resolver: lts-14.3
stack.yaml.lock+4−4
@@ -6,7 +6,7 @@
66packages: []
77snapshots:
88- completed:
9− size: 524789
10− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/14/18.yaml
11− sha256: 646be71223e08234131c6989912e6011e01b9767bc447b6d466a35e14360bdf2
12− original: lts-14.18
9+ size: 523878
10+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/14/3.yaml
11+ sha256: 470c46c27746a48c7c50f829efc0cf00112787a7804ee4ac7a27754658f6d92c
12+ original: lts-14.3
test/Examples/Quantum.hsnew file+31
@@ -0,0 +1,31 @@
1+{-# LANGUAGE StandaloneDeriving #-}
2+module Examples.Quantum where
3+
4+import LAoP.Utils
5+import LAoP.Matrix.Type
6+import Data.Complex
7+import Prelude hiding (id, (.))
8+
9+deriving instance Ord a => Ord (Complex a)
10+
11+xor :: (Bool, Bool) -> Bool
12+xor (False, b) = b
13+xor (True, b) = not b
14+
15+ker :: Num e => Matrix e a b -> Matrix e a a
16+ker m = tr m . m
17+
18+cnot :: Matrix (Complex Double) (Bool, Bool) (Bool, Bool)
19+cnot = kr fstM (fromF xor)
20+
21+ccnot :: (Num e, Ord e) => Matrix e ((Bool, Bool), Bool) ((Bool, Bool), Bool)
22+ccnot = kr fstM (fromF f)
23+ where
24+ f = xor . tp (uncurry (&&)) id
25+ tp f g (a,b) = (f a, g b)
26+
27+had :: Matrix (Complex Double) Bool Bool
28+had = (1/sqrt 2) .| fromLists [[1, 1], [1, -1]]
29+
30+bell :: Matrix (Complex Double) (Bool, Bool) (Bool, Bool)
31+bell = cnot . (had >< iden)
app/Main.hs → test/Examples/Readme.hsrenamed+61−33
@@ -1,10 +1,13 @@
1+{-# LANGUAGE GADTs #-}
12{-# LANGUAGE DeriveGeneric #-}
23{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE TypeOperators #-}
44{-# LANGUAGE TypeApplications #-}
55{-# LANGUAGE DataKinds #-}
66
7−module Main where
7+module Examples.Readme
8+ ( exec
9+ )
10+ where
811
912import LAoP.Matrix.Type
1013import qualified LAoP.Relation as R
@@ -12,13 +15,12 @@ import LAoP.Utils
1215import LAoP.Dist
1316import GHC.TypeLits
1417import Data.Coerce
15−import GHC.Generics
16−import Control.Category hiding (id)
17−import Prelude hiding ((.))
18+import qualified GHC.Generics as G
19+import Prelude hiding (id, (.))
1820
1921-- Monty Hall Problem
2022data Outcome = Win | Lose
21− deriving (Bounded, Enum, Eq, Show, Generic)
23+ deriving (Bounded, Enum, Eq, Show, G.Generic)
2224
2325switch :: Outcome -> Outcome
2426switch Win = Lose
@@ -28,7 +30,7 @@ firstChoice :: Matrix Double () Outcome
2830firstChoice = col [1/3, 2/3]
2931
3032secondChoice :: Matrix Double Outcome Outcome
31−secondChoice = fromF' switch
33+secondChoice = fromF switch
3234
3335-- Dice sum
3436
@@ -37,7 +39,7 @@ type SS = Natural 1 6 -- Sample Space
3739sumSS :: SS -> SS -> Natural 2 12
3840sumSS = coerceNat (+)
3941
40−sumSSM = fromF' (uncurry sumSS)
42+sumSSM = fromF (uncurry sumSS)
4143
4244condition :: (Int, Int) -> Int -> Int
4345condition (fst, snd) thrd = if fst == snd
@@ -47,38 +49,64 @@ condition (fst, snd) thrd = if fst == snd
4749conditionSS :: (SS, SS) -> SS -> Natural 3 18
4850conditionSS = coerceNat2 condition
4951
50−conditionalThrows = fromF' (uncurry conditionSS) . khatri (khatri die die) die
52+conditionalThrows = fromF (uncurry conditionSS) . kr (kr die die) die
5153
5254die :: Matrix Double () SS
5355die = col $ map (const (1/6)) [nat @1 @6 1 .. nat 6]
5456
5557-- Sprinkler
58+data G = Dry | Wet
59+ deriving (Bounded, Enum, Eq, Show, G.Generic)
60+
61+data S = Off | On
62+ deriving (Bounded, Enum, Eq, Show, G.Generic)
5663
57−rain :: Matrix Double () Bool
58−rain = col [0.8, 0.2]
64+data R = No | Yes
65+ deriving (Bounded, Enum, Eq, Show, G.Generic)
66+
67+rain :: Matrix Double () R
68+rain = matrixBuilder gen
69+ where
70+ gen (_, No) = 0.8
71+ gen (_, Yes) = 0.2
5972
60−sprinkler :: Matrix Double Bool Bool
61−sprinkler = fromLists [[0.6, 0.99], [0.4, 0.01]]
73+sprinkler :: Matrix Double R S
74+sprinkler = matrixBuilder gen
75+ where
76+ gen (No, Off) = 0.6
77+ gen (No, On) = 0.4
78+ gen (Yes, Off) = 0.99
79+ gen (Yes, On) = 0.01
80+
81+grass :: Matrix Double (S, R) G
82+grass = matrixBuilder gen
83+ where
84+ gen ((Off, No), Dry) = 1
85+ gen ((Off, Yes), Dry) = 0.2
86+ gen ((On, No), Dry) = 0.1
87+ gen ((On, Yes), Dry) = 0.01
88+ gen ((Off, No), Wet) = 0
89+ gen ((Off, Yes), Wet) = 0.8
90+ gen ((On, No), Wet) = 0.9
91+ gen ((On, Yes), Wet) = 0.99
6292
63−grass :: Matrix Double (Bool, Bool) Bool
64−grass = fromLists [[1, 0.2, 0.1, 0.01], [0, 0.8, 0.9, 0.99]]
93+tag f = kr f id
6594
66−state :: Matrix Double () (Bool, (Bool, Bool))
67−state = khatri grass identity . khatri sprinkler identity . rain
95+state g s r = tag g . tag s . r
6896
69−grass_wet :: Matrix Double (Bool, (Bool, Bool)) One
70−grass_wet = row [0,1] . kp1
97+grass_wet :: Matrix Double () (G, (S, R)) -> Matrix Double One One
98+grass_wet state = row [0,1] . fstM . state
7199
72−rainning :: Matrix Double (Bool, (Bool, Bool)) One
73−rainning = row [0,1] . kp2 . kp2
100+rainning :: Matrix Double (G, (S, R)) One
101+rainning = row [0,1] . sndM . sndM
74102
75103-- Alcuin Puzzle
76104
77105data Being = Farmer | Fox | Goose | Beans
78− deriving (Bounded, Enum, Eq, Show, Generic)
106+ deriving (Bounded, Enum, Eq, Show, G.Generic)
79107
80108data Bank = LeftB | RightB
81− deriving (Bounded, Enum, Eq, Show, Generic)
109+ deriving (Bounded, Enum, Eq, Show, G.Generic)
82110
83111eats :: Being -> Being -> Bool
84112eats Fox Goose = True
@@ -93,21 +121,21 @@ cross LeftB = RightB
93121cross RightB = LeftB
94122
95123crossR :: R.Relation Bank Bank
96−crossR = R.fromF' cross
124+crossR = R.fromF cross
97125
98126-- | Initial state, everyone in the left bank
99127locationLeft :: Being -> Bank
100128locationLeft _ = LeftB
101129
102130locationLeftR :: R.Relation Being Bank
103−locationLeftR = R.fromF' locationLeft
131+locationLeftR = R.fromF locationLeft
104132
105133-- | Initial state, everyone in the right bank
106134locationRight :: Being -> Bank
107135locationRight _ = RightB
108136
109137locationRightR :: R.Relation Being Bank
110−locationRightR = R.fromF' locationRight
138+locationRightR = R.fromF locationRight
111139
112140-- Properties
113141
@@ -124,7 +152,7 @@ inv :: R.Relation Being Bank -> Bool
124152inv w = (w `R.comp` canEat w) `R.sse` (w `R.comp` farmer)
125153 where
126154 farmer :: R.Relation Being Being
127− farmer = R.fromF' (const Farmer)
155+ farmer = R.fromF (const Farmer)
128156
129157-- Arbitrary state
130158bankState :: Being -> Bank -> Bool
@@ -138,19 +166,19 @@ bankStateR :: R.Relation Being Bank
138166bankStateR = R.toRel bankState
139167
140168-- Main
141−main :: IO ()
142−main = do
169+exec :: IO ()
170+exec = do
143171 putStrLn "Monty Hall Problem solution:"
144172 prettyPrint (secondChoice . firstChoice)
145173 putStrLn "\n Sum of dices probability:"
146− prettyPrint (sumSSM `comp` khatri die die)
174+ prettyPrint (sumSSM . kr die die)
147175 putStrLn "\n Conditional dice throw:"
148176 prettyPrint conditionalThrows
149177 putStrLn "\n Checking that the last result is indeed a distribution: "
150− prettyPrint (bang . sumSSM . khatri die die)
178+ prettyPrint (bang . sumSSM . kr die die)
151179 putStrLn "\n Probability of grass being wet:"
152− prettyPrint (grass_wet . state)
180+ prettyPrint (grass_wet (state grass sprinkler rain))
153181 putStrLn "\n Probability of rain:"
154− prettyPrint (rainning . state)
182+ prettyPrint (rainning . state grass sprinkler rain)
155183 putStrLn "\n Is the arbitrary state a valid state? (Alcuin Puzzle)"
156184 print (inv bankStateR)
test/Examples/Spreadsheets.hsnew file+47
@@ -0,0 +1,47 @@
1+{-# LANGUAGE DeriveGeneric #-}
2+
3+module Examples.Spreadsheets
4+
5+import LAoP.Utils
6+import LAoP.Matrix.Type
7+import GHC.Generics
8+import Prelude hiding (id, (.))
9+
10+data Student = Student1 | Student2 | Student3 | Student4
11+ deriving (Eq, Show, Enum, Bounded, Generic)
12+
13+data Question = Question1 | Question2 | Question3 | Question4
14+ deriving (Eq, Show, Enum, Bounded, Generic)
15+
16+data Results = Exam | Test | Final
17+ deriving (Eq, Show, Enum, Bounded, Generic)
18+
19+test :: Matrix Float One Results
20+test = point Test
21+
22+exam :: Matrix Float One Results
23+exam = point Exam
24+
25+final :: Matrix Float One Results
26+final = point Final
27+
28+m :: Matrix Float Question Student
29+m = fromLists [[95, 90, 100, 40], [20, 90, 90, 0], [30, 20, 95, 0], [50, 80, 100, 30]]
30+
31+w :: Matrix Float Question One
32+w = fromLists [[0.2, 0.3, 0.2, 0.3]]
33+
34+xls :: Matrix Float Question One
35+ -> Matrix Float Question Student
36+ -> Matrix Float Student One
37+ -> Matrix Float (Either Question Results) (Either One Student)
38+xls w m t = join (fork w m) (fork zeros r)
39+ where
40+ rExam = m . tr w
41+ rTest = tr t
42+ rFinal = rTest `maxPW` rExam
43+ r = (rExam . tr exam) + (rTest . tr test) + (rFinal . tr final)
44+
45+-- | Overloaded, point-wise 'max' function
46+maxPW :: Ord e => Matrix e a b -> Matrix e a b -> Matrix e a b
47+maxPW = zipWithM max
test/Spec.hs+7−1
@@ -1,2 +1,8 @@
1+module Main (main) where
2+
3+import qualified Examples.Readme as RD
4+
15main :: IO ()
2−main = putStrLn "Test suite not yet implemented"
6+main = do
7+ putStrLn ("Testing if README works" :: String)
8+ RD.exec