Monster PR - vectors, matrices, number theory bindings

.travis.yml

@@ -46,49 +46,30 @@ matrix:
   #- env: BUILD=cabal GHCVER=7.2.2 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
   #  compiler: ": #GHC 7.2.2"
   #  addons: {apt: {packages: [cabal-install-1.16,ghc-7.2.2,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
-  - env: BUILD=cabal GHCVER=7.4.2 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
-    compiler: ": #GHC 7.4.2"
-    addons: {apt: {packages: [libgmp-dev,
-                              libmpfr-dev,
-                              libmpc-dev,
-                              binutils-dev,
-                              g++-4.7,
-                              gcc, cabal-install-1.16,ghc-7.4.2,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
-  - env: BUILD=cabal GHCVER=7.6.3 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
-    compiler: ": #GHC 7.6.3"
-    addons: {apt: {packages: [libgmp-dev,
-                              libmpfr-dev,
-                              libmpc-dev,
-                              binutils-dev,
-                              g++-4.7,
-                              gcc, cabal-install-1.16,ghc-7.6.3,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
-  - env: BUILD=cabal GHCVER=7.8.4 CABALVER=1.18 HAPPYVER=1.19.5 ALEXVER=3.1.7
+  - env: BUILD=cabal CABALVER=1.24 GHCVER=7.8.4 STACK_YAML=stack-7.8.yaml
     compiler: ": #GHC 7.8.4"
     addons: {apt: {packages: [libgmp-dev,
                               libmpfr-dev,
                               libmpc-dev,
                               binutils-dev,
                               g++-4.7,
-                              gcc, cabal-install-1.18,ghc-7.8.4,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
-  - env: BUILD=cabal GHCVER=7.10.3 CABALVER=1.22 HAPPYVER=1.19.5 ALEXVER=3.1.7
+                              gcc, cabal-install-1.24,ghc-7.8.4,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
+  - env: BUILD=cabal CABALVER=1.22 GHCVER=7.10.3
     compiler: ": #GHC 7.10.3"
     addons: {apt: {packages: [libgmp-dev,
                               libmpfr-dev,
                               libmpc-dev,
                               binutils-dev,
                               g++-4.7,
                               gcc, cabal-install-1.22,ghc-7.10.3,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
-
-  # Build with the newest GHC and cabal-install. This is an accepted failure,
-  # see below.
-  - env: BUILD=cabal GHCVER=head  CABALVER=head HAPPYVER=1.19.5 ALEXVER=3.1.7
-    compiler: ": #GHC HEAD"
+  - env: BUILD=cabal CABALVER=1.24 GHCVER=8.0.1
+    compiler: ": #GHC 8.0.1"
     addons: {apt: {packages: [libgmp-dev,
                               libmpfr-dev,
                               libmpc-dev,
                               binutils-dev,
                               g++-4.7,
-                              gcc, cabal-install-head,ghc-head,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
+                              gcc, cabal-install-1.24,ghc-8.0.1,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc, ubuntu-toolchain-r-test]}}
 
   # The Stack builds. We can pass in arbitrary Stack arguments via the ARGS
   # variable, such as using --stack-yaml to point to a different file.
@@ -210,6 +191,8 @@ install:
 
 # Download and unpack the stack executable
 - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:/opt/alex/$ALEXVER/bin:/opt/happy/$HAPPYVER/bin:$HOME/.cabal/bin:$PATH
+# add cabal install path
+- export PATH=PATH="$HOME/.cabal/bin:$PATH"
 - mkdir -p ~/.local/bin
 - |
   if [ `uname` = "Darwin" ]

README.md

@@ -26,12 +26,18 @@ as well as the libraries
 
 Since these are *hard* dependencies for SymEngine-hs to build.
 
+Compile `SymEngine` with the `CMake` flags
+
+```bash
+cmake -DWITH_SYMENGINE_THREAD_SAFE=yes -DBUILD_SHARED_LIBS:BOOL=ON
+```
+
 # Getting started
 
 To quickly build and check everything is working, run
 
 ```
-stack build && stack test
+stack build && stack test --test-arguments "--quickcheck-tests 2000" --verbose
 ```
 
 All of the test cases should pass with SymEngine
@@ -68,14 +74,58 @@ GHCi session with Symengine loaded
 -1
 ```
 
-# Things to Do
+# Development
 
-`[TODO: fill this up]`
+clone `Symengine`, build it with the setting
 
-# Contributing
+```
+cmake -DWITH_SYMENGINE_THREAD_SAFE=yes -DBUILD_SHARED_LIBS:BOOL=ON
+```
+
+this makes sure that dynamically linked libraries are being built, so we can
+link to them.
+
+
+to test changes, use
+```
+stack test --force-dirty  --test-arguments "--quickcheck-tests 2000" --verbose
+```
+
+* change `--quickcheck-tests" to some number (preferably > 100), since it generates those many instances to
+test on
+
+* the `--force-dirty` ensures that the library and the test builds are both
+rebuilt.
 
-`[TODO: fill this up]`
 
 # License
 
 All code is released under the [MIT License](https://github.com/symengine/symengine.hs/blob/master/LICENSE).
+
+
+# Things Learnt 
+
+* you can use `toEnum` to convert from `Int` to the `C<Int | Long | ..>` variants
+of C types
+
+* API design - how to best handle exceptions?
+
+# Bugs
+
+* if I create a lazy list of BasicSym, then what happens? it gets forced to evaluate
+when I pass it through something like `densematrix_diag`
+
+
+* `densematrix_new_vec  2 3 []` crashes. We need to check for this in our code
+
+
+* What exactly does 'unsafePerformIO' do? why does `unsafePerformIO` on `basicsym_new`
+yield weird as hell errors?
+
+* take proper care of ref. transparency. eg: `densematrix_set`
+
+* Maybe allow GHC to tell about "typo errors" when looking for modules
+
+* `merijn	You'll want newPinnedByteArray# :: Int# -> State# s -> (#State# s, MutableByteArray# s#)`
+
+* is the API Thread-safe?