Docs

Author: jamesdbrock

src/Data/Int64.purs

@@ -1,4 +1,50 @@
--- | Signed 2’s-complement 64-bit integers.
+-- | Signed two’s-complement 64-bit integers and operations.
+-- |
+-- | All of the usual arithmetic operations are supplied by typeclass
+-- | instances from typeclasses in the __Prelude__.
+-- |
+-- | The `Show` instance will suffix a lowercase ‘l’ for “long”.
+-- |
+-- | #### Usage
+-- |
+-- | ```purescript
+-- | import Prelude
+-- | import Data.Int64 as Int64
+-- |
+-- | let
+-- |   hundred = Int64.fromInt 100
+-- |   billion = Int64.fromInt 1000000000
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > hundred * billion
+-- | 100000000000l
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > billion / hundred
+-- | 10000000l
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > hundred + one
+-- | 101l
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > hundred * zero
+-- | 0l
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > Int64.lowBits (hundred * billion)
+-- | 1215752192
+-- | ```
+-- | ---
+-- | ```purescript
+-- | > Int64.highBits (hundred * billion)
+-- | 23
+-- | ```
 module Data.Int64
   ( module R
   , fromLowHighBits

test/Main.purs

@@ -2,14 +2,32 @@ module Test.Main where
 
 import Prelude
 
+import Data.Int64 as Int64
 import Data.Long.FFISpec (ffiSpec)
 import Data.Long.InternalSpec (internalSpec)
 import Effect (Effect)
 import Effect.Aff (launchAff_)
+import Test.Spec (describe, it)
+import Test.Spec.Assertions (shouldEqual)
 import Test.Spec.Reporter (consoleReporter)
 import Test.Spec.Runner (runSpec)
 
 main :: Effect Unit
 main = launchAff_ $ runSpec [ consoleReporter ] do
   ffiSpec
   internalSpec
+  describe "Examples" do
+    it "Example1" do
+      let
+        hundred = Int64.fromInt 100
+        billion = Int64.fromInt 1000000000
+        hundredbillion = hundred * billion
+      shouldEqual
+        (show hundredbillion)
+        ("100000000000l")
+      shouldEqual (Int64.fromInt 0) zero
+      shouldEqual
+        (billion / hundred)
+        (Int64.fromInt 10000000)
+      shouldEqual (show $ Int64.lowBits hundredbillion) "1215752192"
+      shouldEqual (show $ Int64.highBits hundredbillion) "23"