add get_native_int

Author: ArseniyKholod

.github/workflows/ci.yml

@@ -54,15 +54,15 @@ jobs:
       - run: julia -e 'using InteractiveUtils; versioninfo(verbose=true)'
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
-      - name: Run tests for NATIVEINT=64 (default)
+      - name: Run tests for native_int=64 (default)
         uses: julia-actions/julia-runtest@v1
-      - name: Set NATIVEINT=128
+      - name: Set native_int=128
         run: |
           using Preferences: set_preferences!
           using UUIDs: UUID
           set_preferences!(UUID("77ce9b8e-ecf5-45d1-bd8a-d31f384f2f95"), "native_int" => 128; force=true)
         shell: julia --project=. --color=yes {0}
-      - name: Run tests for NATIVEINT=128
+      - name: Run tests for native_int=128
         uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
         with:

Project.toml

@@ -14,6 +14,6 @@ openfhe_julia_jll = "e5e97983-1b8c-50fe-92b7-0e05c8c202e2"
 CxxWrap = "0.16"
 Preferences = "1.4"
 UUIDs = "1"
-openfhe_julia_jll = "0.3.8"
-openfhe_julia_int128_jll = "0.3.8"
+openfhe_julia_jll = "0.3.9"
+openfhe_julia_int128_jll = "0.3.9"
 julia = "1.10"

examples/simple_ckks_bootstrapping.jl

@@ -12,7 +12,7 @@ rescale_technique = FLEXIBLEAUTO
 dcrt_bits = 59;
 first_modulus = 60;
 
-if NATIVEINT == 128
+if get_native_int() == 128
     rescale_technique = FIXEDAUTO;
     dcrt_bits = 78;
     first_modulus = 89;

src/OpenFHE.jl

@@ -24,7 +24,6 @@ else
     else
         throw(ErrorException("Unsupported value `native_int` = '$native_int' loaded from LocalPreferences.toml (must be `64` or `128`)"))
     end
-    const NATIVEINT = native_int
     const libopenfhe_julia_path = libopenfhe_julia
 end
 @wrapmodule(() -> libopenfhe_julia_path)
@@ -115,8 +114,8 @@ export SecretKeyDist, GAUSSIAN, UNIFORM_TERNARY, SPARSE_TERNARY
 export SecurityLevel, HEStd_128_classic, HEStd_192_classic, HEStd_256_classic,
        HEStd_128_quantum, HEStd_192_quantum, HEStd_256_quantum, HEStd_NotSet
 
-# NATIVEINT
-export NATIVEINT
+# native_int
+export get_native_int
 
 
 include("auxiliary.jl")

src/auxiliary.jl

@@ -24,6 +24,8 @@ end
 
 Set the native integer size for an OpenFHE-julia installation, it can be `64` or `128` bits.
 Restart the Julia session after executing this function such that the changes take effect.
+
+See also: [`get_native_int`](@ref)
 """
 function set_native_int!(native_int::Integer = 64; force = true)
     if native_int != 64 && native_int != 128

src/documentation.jl

@@ -1155,3 +1155,12 @@ Return the private key from a `key_pair`.
 See also: [`KeyPair`](@ref), [`public_key`](@ref)
 """
 private_key
+
+"""
+    get_native_int()
+
+Return the native integer size for an OpenFHE-julia installation, it can be `64` or `128` bits.
+
+See also: [` OpenFHE.set_native_int!`](@ref)
+"""
+get_native_int

test/test_auxiliary.jl

@@ -3,7 +3,7 @@ module TestAuxiliary
 using Test
 using OpenFHE
 
-println("Tests for NATIVEINT = $NATIVEINT")
+println("Tests for native_int = $(get_native_int())")
 
 @testset verbose=true showtiming=true "test_auxiliary.jl" begin
 
@@ -19,9 +19,13 @@ end
 
 @testset verbose=true showtiming=true "set_native_int!" begin
     msg = "[ Info: Please restart Julia and reload OpenFHE.jl for the library changes to take effect\n"
+    # remember initial native integer size
+    native_int = get_native_int()
     @test_warn msg OpenFHE.set_native_int!()
     @test_warn msg OpenFHE.set_native_int!(128)
     @test_throws ArgumentError OpenFHE.set_native_int!(129)
+    # return to initial native integer size
+    @test_warn msg OpenFHE.set_native_int!(native_int)
 end
 
 end # @testset "test_auxiliary.jl"

test/test_ckks.jl

@@ -7,6 +7,7 @@ using OpenFHE
 
 multDepth = 1
 scaleModSize = 50
+scaleModSize_int128 = 71
 batchSize = 8
 
 @testset verbose=true showtiming=true "CCParams" begin
@@ -18,9 +19,23 @@ batchSize = 8
     @test_nowarn SetBatchSize(parameters, batchSize)
 end
 
+@testset verbose=true showtiming=true "get_native_int" begin
+    parameters = CCParams{CryptoContextCKKSRNS}()
+    @test_nowarn SetScalingModSize(parameters, scaleModSize_int128)
+    if get_native_int() == 128
+        @test_nowarn GenCryptoContext(parameters)
+    elseif get_native_int() == 64
+        @test_throws "" GenCryptoContext(parameters)
+    end
+end
+
 parameters = CCParams{CryptoContextCKKSRNS}()
 SetMultiplicativeDepth(parameters, multDepth)
-SetScalingModSize(parameters, scaleModSize)
+if get_native_int() == 128
+    SetScalingModSize(parameters, scaleModSize_int128)
+elseif get_native_int() == 64
+    SetScalingModSize(parameters, scaleModSize)
+end
 SetBatchSize(parameters, batchSize)
 
 @testset verbose=true showtiming=true "CryptoContext" begin