feat(math): add new bitwise builtins

Author: SuperFola

Math.ark

@@ -158,6 +158,87 @@
 # @author https://github.com/SuperFola
 (let NaN builtin__math:NaN)
 
+# @brief Count the number of '1' bits in the given value
+# @param value the Number, must be an integer
+# =begin
+# (math:countOnes 5)  # 2
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let countOnes (fun (_x) (builtin__math:countOnes _x)))
+
+# @brief Count the number of '0' bits in the given value
+# @param value the Number, must be an integer
+# =begin
+# (math:countZeros 5)  # 1
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let countZeros (fun (_x) (builtin__math:countZeros _x)))
+
+# @brief Invert a number on 64 bits
+# @param value Number, must be an integer
+# =begin
+# (math:bitNot 5)  # -6
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let bitNot (fun (_x) (builtin__math:bitNot _x)))
+
+# @brief Bitwise and
+# @param lhs Number, must be an integer
+# @param rhs Number, must be an integer
+# =begin
+# (math:bitAnd 4 12)  # 4
+# (math:bitAnd 4 10)  # 0
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let bitAnd (fun (_a _b) (builtin__math:bitAnd _a _b)))
+
+# @brief Bitwise or
+# @param lhs Number, must be an integer
+# @param rhs Number, must be an integer
+# =begin
+# (math:bitOr 4 10)  # 14
+# (math:bitOr 4 1)  # 5
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let bitOr (fun (_a _b) (builtin__math:bitOr _a _b)))
+
+# @brief Bitwise exclusive or of lhs and rhs
+# @param lhs Number, must be an integer
+# @param rhs Number, must be an integer
+# =begin
+# (math:bitXor 4 12)  # 8
+# (math:bitXor 4 10)  # 14
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let bitXor (fun (_a _b) (builtin__math:bitXor _a _b)))
+
+# @brief Left bit shift
+# @param lhs Number, must be an integer
+# @param rhs Number, must be an integer
+# =begin
+# (math:lshift 3 2)  # 12
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let lshift (fun (_a _b) (builtin__math:lshift _a _b)))
+
+# @brief Right bit shift
+# @param lhs Number, must be an integer
+# @param rhs Number, must be an integer
+# =begin
+# (math:rshift 13 2)  # 3
+# (math:rshift -14 2)  # -4
+# =end
+# @author https://github.com/SuperFola
+# @require 4.6.0 Requires ArkScript 4.6.0 or later
+(let rshift (fun (_a _b) (builtin__math:rshift _a _b)))
+
 # @brief Return the absolute value of a number
 # @param _x the number to get the absolute value of
 # @author https://github.com/rstefanic

tests/math-tests.ark

@@ -29,7 +29,32 @@
     (test:eq (builtin__math:tanh 5) (math:tanh 5))
     (test:eq (builtin__math:acosh 5) (math:acosh 5))
     (test:eq (builtin__math:asinh 5) (math:asinh 5))
-    (test:eq (builtin__math:atanh 0.5) (math:atanh 0.5)) })
+    (test:eq (builtin__math:atanh 0.5) (math:atanh 0.5))
+    (test:eq (builtin__math:countOnes 1234) (math:countOnes 1234))
+    (test:eq (builtin__math:countZeros 1234) (math:countZeros 1234))
+    (test:eq (builtin__math:bitNot 1234) (math:bitNot 1234))
+    (test:eq (builtin__math:bitAnd 1234 5678) (math:bitAnd 1234 5678))
+    (test:eq (builtin__math:bitOr 1234 5678) (math:bitOr 1234 5678))
+    (test:eq (builtin__math:bitXor 1234 5678) (math:bitXor 1234 5678))
+    (test:eq (builtin__math:lshift 1234 2) (math:lshift 1234 2))
+    (test:eq (builtin__math:rshift 1234 6) (math:rshift 1234 6)) })
+
+  (test:case "bitwise" {
+    (test:eq (math:countOnes 5) 2)
+    (test:eq (math:countOnes 63) 6)
+    (test:eq (math:countZeros 63) 58)
+    (test:eq (math:countZeros 65535) 48)
+
+    (test:eq (math:bitNot 5) -6)
+    (test:eq (math:bitAnd 4 12) 4)
+    (test:eq (math:bitAnd 4 10) 0)
+    (test:eq (math:bitOr 4 10) 14)
+    (test:eq (math:bitOr 4 1) 5)
+    (test:eq (math:bitXor 4 12) 8)
+    (test:eq (math:bitXor 4 10) 14)
+    (test:eq (math:lshift 3 2) 12)
+    (test:eq (math:rshift 13 2) 3)
+    (test:eq (math:rshift -14 2) -4) })
 
   (test:case "abs" {
     (test:eq (math:abs -1) 1)