feat(core): implement not operator

This deprecates the inv method

Author: ObserverOfTime

kbigint/src/androidMain/kotlin/io/github/observeroftime/kbigint/KBigInt.kt

@@ -90,6 +90,13 @@ actual class KBigInt private constructor(private var value: BigInteger) : Compar
     @JvmName("negate")
     actual operator fun unaryMinus() = KBigInt(-value)
 
+    /**
+     * Compute the two's-complement of the value.
+     *
+     * @since 0.5.0
+     */
+    actual operator fun not() = KBigInt(!value)
+
     /** Perform a bitwise `AND` operation. */
     actual infix fun and(other: KBigInt) = KBigInt(value and other.value)
 
@@ -217,8 +224,8 @@ actual class KBigInt private constructor(private var value: BigInteger) : Compar
     }
 
     /** Compute the two's-complement of the value. */
-    @JvmName("not")
-    actual fun inv() = KBigInt(!value)
+    @Deprecated("Use the not operator instead", ReplaceWith("!this"))
+    actual fun inv() = not()
 
     /** Get the absolute value. */
     actual fun abs() = KBigInt(value.abs())

kbigint/src/androidUnitTest/kotlin/io/github/observeroftime/kbigint/KBigIntTest.kt

@@ -73,9 +73,9 @@ actual class KBigIntTest {
     }
 
     @Test
-    actual fun testInvert() {
-        assertEquals(KBigInt(-2147483649L), long.inv())
-        assertEquals(KBigInt(2147483649L), -long.inv())
+    actual fun testNot() {
+        assertEquals(KBigInt(-2147483649L), !long)
+        assertEquals(KBigInt(2147483649L), -!long)
     }
 
     @Test

kbigint/src/commonMain/kotlin/io/github/observeroftime/kbigint/KBigInt.kt

@@ -66,6 +66,13 @@ expect class KBigInt : Comparable<KBigInt> {
     /** Negate the value. */
     operator fun unaryMinus(): KBigInt
 
+    /**
+     * Compute the two's-complement of the value.
+     *
+     * @since 0.5.0
+     */
+    operator fun not(): KBigInt
+
     /** Perform a bitwise `AND` operation. */
     infix fun and(other: KBigInt): KBigInt
 
@@ -133,11 +140,8 @@ expect class KBigInt : Comparable<KBigInt> {
      */
     fun sqrt(): KBigInt
 
-    /**
-     * Compute the two's-complement of the value.
-     *
-     * @throws [ArithmeticException] if the value is negative
-     */
+    /** Compute the two's-complement of the value. */
+    @Deprecated("Use the not operator instead", ReplaceWith("!this"))
     fun inv(): KBigInt
 
     /** Get the absolute value. */

kbigint/src/commonTest/kotlin/io/github/observeroftime/kbigint/KBigIntTest.kt

@@ -12,7 +12,7 @@ expect class KBigIntTest {
     fun testNegate()
     fun testBitOps()
     fun testShifts()
-    fun testInvert()
+    fun testNot()
     fun testGcdLcm()
     fun testPow()
     fun testRoot()

kbigint/src/jsMain/kotlin/io/github/observeroftime/kbigint/KBigInt.kt

@@ -114,6 +114,17 @@ actual class KBigInt private constructor(@JsExternalArgument private var value:
         return KBigInt(js("-x").unsafeCast<BigInt>())
     }
 
+    /**
+     * Compute the two's-complement of the value.
+     *
+     * @since 0.5.0
+     */
+    @JsName("not")
+    actual operator fun not(): KBigInt {
+        val x = this.value
+        return KBigInt(js("~x").unsafeCast<BigInt>())
+    }
+
     /** Perform a bitwise `AND` operation. */
     actual infix fun and(other: KBigInt): KBigInt {
         val a = this.value
@@ -241,11 +252,8 @@ actual class KBigInt private constructor(@JsExternalArgument private var value:
     }
 
     /** Compute the two's-complement of the value. */
-    @JsName("not")
-    actual fun inv(): KBigInt {
-        val x = this.value
-        return KBigInt(js("~x").unsafeCast<BigInt>())
-    }
+    @Deprecated("Use the not operator instead", ReplaceWith("!this"))
+    actual fun inv() = not()
 
     /** Get the absolute value. */
     actual fun abs() = KBigInt(KBigIntUtils.abs(value))

kbigint/src/jsTest/kotlin/io/github/observeroftime/kbigint/KBigIntTest.kt

@@ -74,9 +74,9 @@ actual class KBigIntTest {
     }
 
     @Test
-    actual fun testInvert() {
-        assertEquals(KBigInt(-2147483649L), long.inv())
-        assertEquals(KBigInt(2147483649L), -long.inv())
+    actual fun testNot() {
+        assertEquals(KBigInt(-2147483649L), !long)
+        assertEquals(KBigInt(2147483649L), -!long)
     }
 
     @Test

kbigint/src/jvmMain/kotlin/io/github/observeroftime/kbigint/KBigInt.kt

@@ -3,6 +3,7 @@
 package io.github.observeroftime.kbigint
 
 import java.math.BigInteger
+import kotlin.ArithmeticException
 import kotlin.math.floor
 import kotlin.math.log2
 
@@ -87,6 +88,13 @@ actual class KBigInt private constructor(private var value: BigInteger) : Compar
     @JvmName("negate")
     actual operator fun unaryMinus() = KBigInt(-value)
 
+    /**
+     * Compute the two's-complement of the value.
+     *
+     * @since 0.5.0
+     */
+    actual operator fun not() = KBigInt(!value)
+
     /** Perform a bitwise `AND` operation. */
     actual infix fun and(other: KBigInt) = KBigInt(value and other.value)
 
@@ -214,8 +222,8 @@ actual class KBigInt private constructor(private var value: BigInteger) : Compar
     }
 
     /** Compute the two's-complement of the value. */
-    @JvmName("not")
-    actual fun inv() = KBigInt(!value)
+    @Deprecated("Use the not operator instead", ReplaceWith("!this"))
+    actual fun inv() = not()
 
     /** Get the absolute value. */
     actual fun abs() = KBigInt(value.abs())

kbigint/src/jvmTest/kotlin/io/github/observeroftime/kbigint/KBigIntTest.kt

@@ -74,9 +74,9 @@ actual class KBigIntTest {
     }
 
     @Test
-    actual fun testInvert() {
-        assertEquals(KBigInt(-2147483649L), long.inv())
-        assertEquals(KBigInt(2147483649L), -long.inv())
+    actual fun testNot() {
+        assertEquals(KBigInt(-2147483649L), !long)
+        assertEquals(KBigInt(2147483649L), -!long)
     }
 
     @Test

kbigint/src/nativeMain/kotlin/io/github/observeroftime/kbigint/KBigInt.kt

@@ -264,6 +264,17 @@ actual class KBigInt private constructor(private var value: mp_int) : Comparable
         KBigInt(result.ptr)
     }
 
+    /**
+     * Compute the two's-complement of the value.
+     *
+     * @since 0.5.0
+     */
+    actual operator fun not(): KBigInt = memScoped {
+        val result = alloc<mp_int>()
+        mp_complement(value.ptr, result.ptr).check()
+        KBigInt(result.ptr)
+    }
+
     /**
      * Perform a bitwise `AND` operation.
      *
@@ -430,12 +441,9 @@ actual class KBigInt private constructor(private var value: mp_int) : Comparable
      *
      * @throws [IllegalStateException] if the operation fails
      */
-    @ObjCName("not")
-    actual fun inv() = memScoped {
-        val result = alloc<mp_int>()
-        mp_complement(value.ptr, result.ptr).check()
-        KBigInt(result.ptr)
-    }
+    @Suppress("unused") // deprecating not enough I guess
+    @Deprecated("Use the not operator instead", ReplaceWith("!this"))
+    actual fun inv() = not()
 
     /**
      * Get the absolute value.

kbigint/src/nativeTest/kotlin/io/github/observeroftime/kbigint/KBigIntTest.kt

@@ -94,9 +94,9 @@ actual class KBigIntTest {
     }
 
     @Test
-    actual fun testInvert() {
-        assertEquals(KBigInt(-2147483649L), long.inv())
-        assertEquals(KBigInt(2147483649L), -long.inv())
+    actual fun testNot() {
+        assertEquals(KBigInt(-2147483649L), !long)
+        assertEquals(KBigInt(2147483649L), -!long)
     }
 
     @Test