Add EncodingParams (#30)

* Add EncodingParams * Add module name to unexported symbol
hpsc-lab · Feb 12, 2024 · 96341f8 · 96341f8
1 parent 8e3a53e
commit 96341f8
Show file tree

Hide file tree

Showing 4 changed files with 167 additions and 9 deletions.
diff --git a/src/OpenFHE.jl b/src/OpenFHE.jl
@@ -31,18 +31,26 @@ export SetMultiplicativeDepth, SetScalingModSize, SetBatchSize, SetSecretKeyDist
 # FHECKKSRNS
 export GetBootstrapDepth
 
+# EncodingParams
+export EncodingParams
+export GetPlaintextModulus, SetPlaintextModulus, GetPlaintextRootOfUnity,
+       SetPlaintextRootOfUnity, GetPlaintextBigModulus, SetPlaintextBigModulus,
+       GetPlaintextBigRootOfUnity, SetPlaintextBigRootOfUnity, GetPlaintextGenerator,
+       SetPlaintextGenerator, GetBatchSize, SetBatchSize
+
 # CryptoObject
 export GetCryptoContext
 
 # CryptoContext
 export CryptoContext
-export GenCryptoContext, Enable, GetKeyGenLevel, SetKeyGenLevel, GetCyclotomicOrder,
-       GetModulus, GetRingDimension, GetRootOfUnity, KeyGen, MakeCKKSPackedPlaintext,
-       Encrypt, Decrypt, EvalNegate, EvalAdd, EvalSub, EvalMultKeyGen, EvalMult, EvalSquare,
-       EvalMultNoRelin, Relinearize, RelinearizeInPlace, EvalRotate, EvalRotateKeyGen,
-       ComposedEvalMult, Rescale, RescaleInPlace, ModReduce, ModReduceInPlace, EvalSin,
-       EvalCos, EvalLogistic, EvalDivide, EvalSumKeyGen, EvalSum, EvalBootstrapSetup,
-       EvalBootstrapKeyGen, EvalBootstrap
+export GenCryptoContext, Enable, GetKeyGenLevel, SetKeyGenLevel, GetEncodingParams,
+       GetCyclotomicOrder, GetModulus, GetRingDimension, GetRootOfUnity, KeyGen,
+       MakeCKKSPackedPlaintext, Encrypt, Decrypt, EvalNegate, EvalAdd, EvalSub,
+       EvalMultKeyGen, EvalMult, EvalSquare, EvalMultNoRelin, Relinearize,
+       RelinearizeInPlace, EvalRotate, EvalRotateKeyGen, ComposedEvalMult, Rescale,
+       RescaleInPlace, ModReduce, ModReduceInPlace, EvalSin, EvalCos, EvalLogistic,
+       EvalDivide, EvalSumKeyGen, EvalSum, EvalBootstrapSetup, EvalBootstrapKeyGen,
+       EvalBootstrap
 
 # Plaintext
 export Plaintext

diff --git a/src/convenience.jl b/src/convenience.jl
@@ -1,4 +1,13 @@
-# Define CryptoContext for convenience
+"""
+    EncodingParams
+
+Type alias for `CxxWrap.StdLib.SharedPtr{EncodingParamsImpl}`.
+
+The `EncodingParams` store the parameters for encoding. These parameters are kept with
+multiple OpenFHE objects and are continually reused during the encoding of new values.
+"""
+const EncodingParams = CxxWrap.StdLib.SharedPtr{EncodingParamsImpl}
+
 """
     CryptoContext{T}
 
@@ -88,6 +97,7 @@ for (WrappedT, fun) in [
     :(CryptoContext{DCRTPoly}) => :Enable,
     :(CryptoContext{DCRTPoly}) => :GetKeyGenLevel,
     :(CryptoContext{DCRTPoly}) => :SetKeyGenLevel,
+    :(CryptoContext{DCRTPoly}) => :GetEncodingParams,
     :(CryptoContext{DCRTPoly}) => :GetCyclotomicOrder,
     :(CryptoContext{DCRTPoly}) => :GetModulus,
     :(CryptoContext{DCRTPoly}) => :GetRingDimension,
@@ -139,6 +149,18 @@ for (WrappedT, fun) in [
     :(Plaintext) => :GetCoefPackedValue,
     :(Plaintext) => :GetPackedValue,
     :(Plaintext) => :GetRealPackedValue,
+    :(EncodingParams) => :GetPlaintextModulus,
+    :(EncodingParams) => :SetPlaintextModulus,
+    :(EncodingParams) => :GetPlaintextRootOfUnity,
+    :(EncodingParams) => :SetPlaintextRootOfUnity,
+    :(EncodingParams) => :GetPlaintextBigModulus,
+    :(EncodingParams) => :SetPlaintextBigModulus,
+    :(EncodingParams) => :GetPlaintextBigRootOfUnity,
+    :(EncodingParams) => :SetPlaintextBigRootOfUnity,
+    :(EncodingParams) => :GetPlaintextGenerator,
+    :(EncodingParams) => :SetPlaintextGenerator,
+    :(EncodingParams) => :GetBatchSize,
+    :(EncodingParams) => :SetBatchSize,
 ]
     @eval function $fun(arg::$WrappedT, args...; kwargs...)
         $fun(arg[], args...; kwargs...)
@@ -157,6 +179,7 @@ for (T, str) in [
     :(PublicKey{DCRTPoly}) => "PublicKey{DCRTPoly}()",
     :(PrivateKey{DCRTPoly}) => "PrivateKey{DCRTPoly}()",
     :(DecryptResult) => "DecryptResult()",
+    :(EncodingParams) => "EncodingParams()",
 ]
     @eval function Base.show(io::IO, ::$T)
         print(io, $str)
@@ -323,4 +346,4 @@ function EvalSumKeyGen(context::CxxWrap.CxxWrapCore.CxxRef{OpenFHE.CryptoContext
                        privateKey;
                        publicKey = OpenFHE.CxxWrap.StdLib.SharedPtr{OpenFHE.PublicKeyImpl{OpenFHE.DCRTPoly}}())
     EvalSumKeyGen(context, privateKey, publicKey)
-end
+end
diff --git a/src/documentation.jl b/src/documentation.jl
@@ -115,6 +115,118 @@ SetKeySwitchTechnique
 # FHECKKSRNS
 # `GetBootstrapDepth` is documented in `src/convenience.jl`
 
+
+# EncodingParams
+"""
+    GetPlaintextModulus(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetPlaintextModulus`](@ref)
+"""
+GetPlaintextModulus
+
+"""
+    SetPlaintextModulus(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetPlaintextModulus`](@ref)
+"""
+SetPlaintextModulus
+
+"""
+    GetPlaintextRootOfUnity(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetPlaintextRootOfUnity`](@ref)
+"""
+GetPlaintextRootOfUnity
+
+"""
+    SetPlaintextRootOfUnity(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetPlaintextRootOfUnity`](@ref)
+"""
+SetPlaintextRootOfUnity
+
+"""
+    GetPlaintextBigModulus(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetPlaintextBigModulus`](@ref)
+"""
+GetPlaintextBigModulus
+
+"""
+    SetPlaintextBigModulus(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetPlaintextBigModulus`](@ref)
+"""
+SetPlaintextBigModulus
+
+"""
+    GetPlaintextBigRootOfUnity(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetPlaintextBigRootOfUnity`](@ref)
+"""
+GetPlaintextBigRootOfUnity
+
+"""
+    SetPlaintextBigRootOfUnity(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetPlaintextBigRootOfUnity`](@ref)
+"""
+SetPlaintextBigRootOfUnity
+
+"""
+    GetPlaintextGenerator(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetPlaintextGenerator`](@ref)
+"""
+GetPlaintextGenerator
+
+"""
+    SetPlaintextGenerator(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetPlaintextGenerator`](@ref)
+"""
+SetPlaintextGenerator
+
+"""
+    GetBatchSize(parameters::EncodingParams)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`SetBatchSize`](@ref)
+"""
+GetBatchSize
+
+"""
+    SetBatchSize(parameters::EncodingParams, FIXME::Integer)
+
+FIXME!
+
+See also: [`EncodingParams`](@ref), [`GetBatchSize`](@ref)
+"""
+SetBatchSize
+
+
+
 # CryptoContext
 """
     GenCryptoContext(parameters::CCParams)::CryptoContext
@@ -156,6 +268,15 @@ See also: [`CryptoContext`](@ref), [`GetKeyGenLevel`](@ref)
 """
 SetKeyGenLevel
 
+"""
+    GetEncodingParams(crypto_context::CryptoContext)
+
+Return the [`EncodingParams`](@ref) used by a given `crypto_context`.
+
+See also: [`CryptoContext`](@ref), [`EncodingParams`](@ref)
+"""
+GetEncodingParams
+
 """
     GetCyclotomicOrder(crypto_context::CryptoContext)::UInt32
 

diff --git a/test/test_convenience.jl b/test/test_convenience.jl
@@ -26,6 +26,12 @@ using OpenFHE
 
     @test_nowarn show(PrivateKey{DCRTPoly}())
     println()
+
+    @test_nowarn show(OpenFHE.DecryptResult())
+    println()
+
+    @test_nowarn show(EncodingParams())
+    println()
 end
 
 end # @testset "test_convenience.jl"