update README

Author: NicklasXYZ

README.md

@@ -11,18 +11,17 @@ The library supports both targets: Erlang and JavaScript.
 
 ```gleam
 import gleam/float
+import gleam/list
 import gleam/yielder
 import gleam_community/maths
 import gleeunit/should
 
 pub fn example() {
   // Evaluate the sine function
   let result = maths.sin(maths.pi())
-
   // Set the relative and absolute tolerance
   let assert Ok(absolute_tol) = float.power(10.0, -6.0)
   let relative_tol = 0.0
-
   // Check that the value is very close to 0.0
   // That is, if 'result' is within +/- 10^(-6)
   maths.is_close(result, 0.0, relative_tol, absolute_tol)
@@ -32,6 +31,10 @@ pub fn example() {
   maths.gcd(54, 24)
   |> should.equal(6)
 
+  // Determine if 999983 is a prime number
+  maths.is_prime(999_983)
+  |> should.equal(True)
+
   // Find the minimum and maximum of a list
   maths.extrema([10.0, 3.0, 50.0, 20.0, 3.0], float.compare)
   |> should.equal(Ok(#(3.0, 50.0)))
@@ -46,9 +49,17 @@ pub fn example() {
   |> yielder.to_list()
   |> should.equal([[1, 2], [1, 3], [2, 3]])
 
-  // Compute the Cosine Similarity between two (orthogonal) vectors
+  // Compute the Cosine Similarity between two (orthogonal) "vectors"
   maths.cosine_similarity([#(-1.0, 1.0), #(1.0, 1.0), #(0.0, -1.0)])
   |> should.equal(Ok(0.0))
+
+  // Generate a list of 3 logarithmically-spaced points over a specified 
+  // interval, i.e., [10^1, 10^3]
+  let assert Ok(logspace) = maths.logarithmic_space(1.0, 3.0, 3, True, 10.0)
+  let pairs = logspace |> list.zip([10.0, 100.0, 1000.0])
+  pairs
+  |> list.all(fn(x) { x.0 == x.1 })
+  |> should.be_true()
 }
 
 ```