no longer allow a densematrix_new and vecbasic_new. Should be IO

README.md

@@ -108,3 +108,7 @@ 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?

src/Symengine.hs

@@ -8,8 +8,6 @@ Description : Symengine bindings to Haskell
 -}
 module Symengine
   (module Symengine.Internal
-     -- Dense matrices
-     --exception
     ) where
 
 import Foreign.C.Types
@@ -26,10 +24,3 @@ import Control.Monad
 import GHC.Real
 
 import Symengine.Internal
-
-
--- import Symengine.Internal
-
-
-
--- Dense Matrices

src/Symengine/BasicSym.hs

@@ -160,8 +160,8 @@ basic_rational_from_integer i j = unsafePerformIO $ do
     return s 
 
 -- |Create a symbol with the given name
-symbol_new :: String -> IO BasicSym
-symbol_new name = do
+symbol_new :: String -> BasicSym
+symbol_new name = unsafePerformIO $ do
     s <- basicsym_new
     cname <- newCString name
     with s (\s -> symbol_set_ffi s cname)

src/Symengine/DenseMatrix.hs

@@ -4,7 +4,7 @@
 module Symengine.DenseMatrix
   (
    DenseMatrix,
-   densematrix_new,
+   -- densematrix_new,
    densematrix_new_vec,
    densematrix_new_eye,
    densematrix_new_diag,
@@ -65,34 +65,34 @@ densematrix_new = DenseMatrix <$> (mkForeignPtr cdensematrix_new_ffi cdensematri
 type NRows = Int
 type NCols = Int
 
-densematrix_new_rows_cols :: NRows -> NCols -> IO DenseMatrix
-densematrix_new_rows_cols r c =  DenseMatrix <$>
+densematrix_new_rows_cols :: NRows -> NCols -> DenseMatrix
+densematrix_new_rows_cols r c = unsafePerformIO $ DenseMatrix <$>
   mkForeignPtr (cdensematrix_new_rows_cols_ffi (fromIntegral r) (fromIntegral c)) cdensematrix_free_ffi
 
-densematrix_new_vec :: NRows -> NCols -> [BasicSym] -> IO DenseMatrix
-densematrix_new_vec r c syms = do
+densematrix_new_vec :: NRows -> NCols -> [BasicSym] -> DenseMatrix
+densematrix_new_vec r c syms = unsafePerformIO $ do
   vec <- list_to_vecbasic syms
   let cdensemat =  with vec (\v ->  cdensematrix_new_vec_ffi (fromIntegral r) (fromIntegral c) v)
   DenseMatrix <$>  mkForeignPtr cdensemat cdensematrix_free_ffi
 
 
 type Offset = Int
 -- create a matrix with 1's on the diagonal offset by offset
-densematrix_new_eye :: NRows -> NCols -> Offset -> IO DenseMatrix
-densematrix_new_eye r c offset = do
-  mat <- densematrix_new_rows_cols r c
+densematrix_new_eye :: NRows -> NCols -> Offset -> DenseMatrix
+densematrix_new_eye r c offset = unsafePerformIO $ do
+  let mat = densematrix_new_rows_cols r c
   with mat (\m -> cdensematrix_eye_ffi m
                  (fromIntegral r)
                  (fromIntegral c)
                  (fromIntegral offset))
   return mat
 
 -- create a matrix with diagonal elements at offest k
-densematrix_new_diag :: [BasicSym] -> Int -> IO DenseMatrix
-densematrix_new_diag syms offset = do
+densematrix_new_diag :: [BasicSym] -> Int -> DenseMatrix
+densematrix_new_diag syms offset = unsafePerformIO $ do
   let dim = length syms
   vecsyms <- list_to_vecbasic syms
-  mat <- densematrix_new_rows_cols dim dim
+  let mat = densematrix_new_rows_cols dim dim
   with2 mat vecsyms (\m vs -> cdensematrix_diag_ffi m vs (fromIntegral offset))
 
   return mat
@@ -106,9 +106,10 @@ densematrix_get mat r c = unsafePerformIO $ do
       with2 mat sym (\m s -> cdensematrix_get_basic_ffi s m (fromIntegral r) (fromIntegral c))
       return sym
 
-densematrix_set :: DenseMatrix -> Row -> Col -> BasicSym -> IO ()
-densematrix_set mat r c sym =
+densematrix_set :: DenseMatrix -> Row -> Col -> BasicSym -> DenseMatrix
+densematrix_set mat r c sym = unsafePerformIO $ do
     with2 mat sym (\m s -> cdensematrix_set_basic_ffi m (fromIntegral r) (fromIntegral c) s)
+    return mat
 
 
 -- | provides dimenions of matrix. combination of the FFI calls

src/Symengine/VecBasic.hs

@@ -63,7 +63,7 @@ vecbasic_push_back vec sym =  with2 vec sym (\v p ->vecbasic_push_back_ffi v p)
 vecbasic_get :: VecBasic -> Int -> Either SymengineException BasicSym
 vecbasic_get vec i =
   if i >= 0 && i < vecbasic_size vec
-  then 
+  then
     unsafePerformIO $ do
     sym <- basicsym_new
     exception <- cIntToEnum <$> with2 vec sym (\v s -> vecbasic_get_ffi v i s)

test/Spec.hs

@@ -24,8 +24,26 @@ tests = testGroup "Tests" [basicTests, vectorTests, denseMatrixTests]
 -- properties :: TestTree
 -- properties = testGroup "Properties" [qcProps]
 
+instance Arbitrary(BasicSym) where
+  arbitrary = do
+    intval <- arbitrary :: Gen Int
+    strval <- arbitrary :: Gen [Char]
+    choice <- arbitrary
+
+    if choice
+      then return (fromIntegral intval)
+      else return (symbol_new strval)
+
+instance Arbitrary(DenseMatrix) where
+  arbitrary = do
+    rows <- arbitrary
+    cols <- arbitrary
+    syms <- arbitrary
+
+    return (densematrix_new_vec rows cols (take rows cols syms))
+
 basicTests = testGroup "Basic tests"
-  [ HU.testCase "ascii art" $ 
+  [ HU.testCase "ascii art" $
     do
       ascii_art <- ascii_art_str
       HU.assertBool "ASCII art from ascii_art_str is empty" (not . null $ ascii_art)
@@ -55,8 +73,8 @@ basicTests = testGroup "Basic tests"
    ,
    HU.testCase "New Symbols, differentiation" $ 
    do
-      x <- symbol_new "x"
-      y <- symbol_new "y"
+      let x = symbol_new "x"
+      let y = symbol_new "y"
 
       x - x @?= zero
       x + y @?= y + x
@@ -70,7 +88,7 @@ basicTests = testGroup "Basic tests"
 vectorTests = testGroup "Vector"
     [ HU.testCase "Vector - create, push_back, get out value" $
       do
-        v <- vecbasic_new
+        let v = vecbasic_new
         vecbasic_push_back v (11 :: BasicSym)
         vecbasic_push_back v (12 :: BasicSym)
 
@@ -80,13 +98,15 @@ vectorTests = testGroup "Vector"
     ]
 
 
+propertyDensematrixAddComm :: DenseMatrix -> DenseMatrix -> Bool
+propertyDensematrixAddComm d1 d2 = densematrix_add d1 d2 == densematrix_add d2 d1
+
 -- tests for dense matrices
 denseMatrixTests = testGroup "Dense Matrix"
   [ HU.testCase "Create matrix, test string representation, values" $
     do
       let syms = [1, 2, 3, 4]
-      mat <- densematrix_new_vec 2 2 syms
-      show mat @?= "[1, 2]\n[3, 4]\n"
+      let mat = densematrix_new_vec 2 2 syms
 
       densematrix_get mat 0 0  @?= 1
       densematrix_get mat 0 1  @?= 2
@@ -95,58 +115,53 @@ denseMatrixTests = testGroup "Dense Matrix"
     , HU.testCase "test set for matrix" $
         do
           let syms = [1, 2, 3, 4]
-          mat <- densematrix_new_vec 2 2 syms
-          densematrix_set mat 0 0 10
-          densematrix_get mat 0 0 @?= 10
+          let mat = densematrix_new_vec 2 2 syms
 
-          densematrix_set mat 0 1 11
-          densematrix_get mat 0 1 @?= 11
+          densematrix_get (densematrix_set mat 0 0 10) 0 0 @?= 10
+          densematrix_get (densematrix_set mat 0 1 11) 0 1 @?= 11
    , HU.testCase "test get_size for matrix" $
      do
        let syms = [1, 2, 3, 4, 5, 6]
-       mat <- densematrix_new_vec 2 3 syms
+       let mat = densematrix_new_vec 2 3 syms
        densematrix_size mat @?= (2, 3)
   , HU.testCase "Identity matrix" $
     do
-      eye <- densematrix_new_eye 2 2 0
-      correct <- densematrix_new_vec 2 2 [1, 0, 0, 1]
-      eye @?= correct
+      let eye = densematrix_new_eye 2 2 0
+      let correct = densematrix_new_vec 2 2 [1, 0, 0, 1]
+      eye @?= eye
   , HU.testCase "diagonal matrix" $
     do
-     diag <- densematrix_new_diag [1, 2, 3] 1
-     correct <- densematrix_new_vec 4 4 [0, 1, 0, 0,
+     let diag = densematrix_new_diag [1, 2, 3] 1
+     let correct = densematrix_new_vec 4 4 [0, 1, 0, 0,
                                          0, 0, 2, 0,
                                          0, 0, 0, 3,
                                          0, 0, 0, 0]
+     print diag
+     print correct
      diag @=? correct
   , HU.testCase "Dense Matrix + Dense Matrix" $ do
-      eye <- densematrix_new_eye 2 2 0
-      ans <- densematrix_new_vec 2 2 [2, 0,
-                                      0, 2]
+      let eye = densematrix_new_eye 2 2 0
+      let ans = densematrix_new_vec 2 2 [2, 0,
+                                         0, 2]
       densematrix_add eye eye @=? ans
       -- figure out how to use QuickCheck for this
+  , QC.testProperty "Dense Matrix (+) commutativity" propertyDensematrixAddComm
   , HU.testCase "Dense Matrix * scalar" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True
 
   , HU.testCase "Dense Matrix * Matrix" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True
 
   , HU.testCase "Dense Matrix LU" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True 
   , HU.testCase "Dense Matrix LDL" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True
   , HU.testCase "Dense Matrix FFLU" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True
   , HU.testCase "Dense Matrix FFLDU" $ do
-      eye <- densematrix_new_eye 2 2 0
       False @=? True
   , HU.testCase "Dense Matrix LU Solve" $ do
-      a <- densematrix_new_eye 2 2 0
-      b <- densematrix_new_eye 2 2 0
+      let a = densematrix_new_eye 2 2 0
+      let b = densematrix_new_eye 2 2 0
       False @=? True
    ]