Merge pull request #31 from Clonkk/devel

Devel
SciNim · Sep 29, 2021 · 3c39afc · 3c39afc
2 parents 3f387b3 + f17cd5d
commit 3c39afc
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 5 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,10 @@
 Changelog for Nimjl. Date in format YYYY_MM_DD
 
+Release v0.5.8 - 2021_09_29
+===========================
+* Renamed examples so it's easier to read in order
+
+
 Release v0.5.7 - 2021_08_16
 ===========================
 * Added dot operators and broadcast mechanism.
@@ -71,7 +76,6 @@ Release v0.4.2 - 2021_03_18
 
 Release v0.4.1 - 2021_03_10
 ===========================
-
 * Add seq support when converting types
 * Add Tensor support when converting types
 * Improved dispatch using generic proc instead of ``when T is ...``
@@ -82,7 +86,6 @@ Release v0.4.1 - 2021_03_10
 
 Release v0.4.0 - 2021_03_08
 ===========================
-
 * First official release
 * Support Arrays / Tuple / Dict of POD
 * Supports Julia Arrays from Buffer.

diff --git a/examples/ex_helloworld.nim → examples/ex01_helloworld.nim b/examples/ex_helloworld.nim → examples/ex01_helloworld.nim
diff --git a/examples/ex_sqrt.nim → examples/ex02_sqrt.nim b/examples/ex_sqrt.nim → examples/ex02_sqrt.nim
diff --git a/examples/ex_sugar.nim → examples/ex03_sugar.nim b/examples/ex_sugar.nim → examples/ex03_sugar.nim
diff --git a/examples/ex_dict.nim → examples/ex04_dict.nim b/examples/ex_dict.nim → examples/ex04_dict.nim
diff --git a/examples/ex_module.nim → examples/ex05_module.nim b/examples/ex_module.nim → examples/ex05_module.nim
@@ -10,7 +10,7 @@ type
 Julia.init() # Initialize Julia VM. This should be done once in the lifetime of your program.
 
 # Include Julia file
-jlInclude("ex_module.jl")
+jlInclude("localmodule.jl")
 # Use the module. If you're confused by the syntax, go and read through Julia's Manual where module usage is explained
 jlUseModule(".nimjlExample")
 
@@ -63,3 +63,8 @@ block:
   echo jlfoo
   echo foo
 
+block:
+  let res = Julia.returnDoubleValue()
+  echo res.myint
+  echo res.mystr
+
diff --git a/examples/ex_tensor.nim → examples/ex06_tensor.nim b/examples/ex_tensor.nim → examples/ex06_tensor.nim
diff --git a/examples/ex_arrays.nim → examples/ex07_arrays.nim b/examples/ex_arrays.nim → examples/ex07_arrays.nim
diff --git a/examples/ex_arrays_index.nim → examples/ex08_arrays_index.nim b/examples/ex_arrays_index.nim → examples/ex08_arrays_index.nim
@@ -12,6 +12,8 @@ proc do1darray() =
 
     echo s1
     echo s
+    # s1 was created using s buffer therefore assigning s1 modify s
+    doAssert s == @[122, 2, 123, 4, 124, 6, 7, 125, 9]
 
   block:
     var s = @[1, 2, 3, 4, 5, 6, 7, 8, 9]
@@ -23,6 +25,8 @@ proc do1darray() =
 
       echo s1
       echo s
+      # s1 was created by copy therefore assigning s1 does not modify s
+      doAssert s == @[1, 2, 3, 4, 5, 6, 7, 8, 9]
 
 proc do2darray() =
   block:

diff --git a/examples/ex_module.jl → examples/localmodule.jl b/examples/ex_module.jl → examples/localmodule.jl
@@ -30,6 +30,11 @@ module nimjlExample
     foo.z *= " -> AppendMeBaby"
   end
 
+  function returnDoubleValue()
+    return (myint=36, mystr="Hello, world")
+  end
+
+  export returnDoubleValue
   export customFunction
   export Foo
   export makeFoo

diff --git a/nimjl.nim b/nimjl.nim
@@ -29,3 +29,12 @@ proc jlVmProcessExit() =
   jlVmExit(0.cint)
 
 addExitProc jlVmProcessExit
+
+runnableExamples:
+  import nimjl
+
+  Julia.init() # Initialize Julia VM. Subsequent call to init will be ignored
+  var myval = 4.0'f64
+  discard Julia.println("Hello world") # No need for \n with Julia println function
+  var res = Julia.sqrt(myval).to(float64) # Call Julia function "sqrt" and convert the result to a float
+  echo res # sqrt(4.0) == 2.0
diff --git a/nimjl.nimble b/nimjl.nimble
@@ -1,6 +1,6 @@
 # Nimjl
 # Licensed and distributed under MIT license (license terms in the root directory or at http://opensource.org/licenses/MIT).
-version       = "0.5.7"
+version       = "0.5.8"
 author        = "Regis Caillaud"
 description   = "Nim Julia bridge"
 license       = "MIT"

diff --git a/readme.md b/readme.md
@@ -77,7 +77,7 @@ echo res # 2.0
 
 ```
 
-Take a look at the ``examples/`` folder for  more examples. There's also the ``tests/`` folder with more application.
+Take a look at ``tests/`` or ``examples/`` folder for typical examples.
 
 
 # License
-Original file line number
+Diff line change
@@ Expand Up / @@ -77,7 +77,7 @@ echo res # 2.0 @@
     ```
-    Take a look at the ``examples/`` folder for  more examples. There's also the ``tests/`` folder with more application.
+    Take a look at ``tests/`` or ``examples/`` folder for typical examples.
     # License
@@ Expand Down @@