Man pages for openfhe.R
R Interface to the 'OpenFHE' Fully Homomorphic Encryption Library

BFVParamsBFV Parameters
BGVParamsBGV Parameters
bin_bootstrapBootstrap an LWE ciphertext
bin_bt_key_genGenerate BinFHE bootstrapping keys
bin_decryptDecrypt a Binary FHE ciphertext
bin_encryptEncrypt a value for Binary FHE
bin_fhe_contextCreate a Binary FHE context
BinFHEContextBinFHE context (Binary FHE)
BinFHEMethodBinary FHE Methods
BinFHEOutputBinary FHE Output Types
BinFHEParamSetBinary FHE Parameter Sets
BinGateBinary Gate Types
bin_key_genGenerate BinFHE secret key
bin_key_gen_pairKeys of the LWE scheme of a BinFHE context
ccparams_gettersCCParams getters (all schemes)
ccparams_settersSet a parameter on a parameter object
CiphertextCiphertext class
CKKSDataTypeCKKS Data Type
CKKSParamsCKKS Parameters
ckks_scaling_factor_bitsCKKS scaling-mod-size in bits
clear_all_ckks_cachesRelease the precomputations a CKKS context has cached
clear_eval_automorphism_keysClear the EvalAutomorphism key cache
clear_eval_mult_keysClear the EvalMult key cache
clear_eval_sum_keysRemove summation keys from the registry
clear_fhe_stateClear cached evaluation keys and contexts
clear_static_maps_and_vectorsClear OpenFHE static maps and vectors
cloneCopy a ciphertext
composed_eval_multMultiply two ciphertexts and reduce the modulus
compressCompress a ciphertext to fewer towers
CompressionLevelCompression Level (interactive multi-party bootstrap)
CryptoContextCrypto Context
CryptoParametersCrypto Parameters (opaque)
DCRTPolyA ring element of a ciphertext
decryptDecrypt a ciphertext
DecryptionNoiseModeDecryption Noise Mode
deserialize_eval_keysDeserialize evaluation keys from file
deserialize_eval_keys_stringDeserialize evaluation keys held in memory
DistributionTypeDistribution Type (lattice parameters)
ElementParamsElement Parameters (opaque)
enable_featureEnable a feature on a CryptoContext
enable_precompute_crt_tables_after_deserializatonPrecompute CRT tables when a context is deserialized
encodeEncode or decode a plaintext
EncodingParamsEncoding Parameters (opaque)
encryptEncrypt a plaintext
EncryptionTechniqueEncryption Technique
eval_addHomomorphic addition
eval_add_in_placeHomomorphic addition in place
eval_add_in_place_no_checkArithmetic without the library's operand checks
eval_add_manyAdd or multiply a list of ciphertexts
eval_add_mutableHomomorphic add, mutable variant
eval_add_mutable_in_placeMutable arithmetic on two ciphertexts, in place
eval_at_indexRotate the slots of a ciphertext by an index
eval_at_index_key_genGenerate at-index (rotation) keys for a secret key
eval_automorphismApply an automorphism to a ciphertext
eval_automorphism_key_genGenerate automorphism evaluation keys for a set of indices
eval_bin_gateEvaluate a binary gate on encrypted values
eval_bootstrapPerform CKKS bootstrapping
eval_bootstrap_key_genGenerate bootstrapping keys
eval_bootstrap_precomputePrecompute the plaintexts of CKKS bootstrapping
eval_bootstrap_setupSet up CKKS bootstrapping
eval_bootstrap_stc_firstCKKS bootstrapping with slots-to-coefficients first
eval_chebyshevEvaluate a Chebyshev series on a ciphertext
eval_chebyshev_coefficientsChebyshev coefficients for a real-valued function
eval_chebyshev_functionEvaluate a user-supplied function on a CKKS ciphertext via...
eval_chebyshev_function_ptxtChebyshev approximation of a function, in the clear
eval_chebyshev_linearEvaluate a Chebyshev series via the linear evaluator
eval_chebyshev_psEvaluate a Chebyshev series via the Paterson-Stockmeyer...
eval_ckks_to_fhew_setupSwitch a CKKS ciphertext to FHEW ciphertexts
eval_constantA constant as an LWE ciphertext
eval_cosEvaluate cosine on a ciphertext
eval_decompDecompose a large-precision ciphertext into digits
eval_divideEvaluate division approximation on a ciphertext
eval_fast_rotationHoisted slot rotation using precomputed digits
eval_fast_rotation_extExtended hoisted slot rotation
eval_fast_rotation_precomputePrecompute digit decomposition for hoisted fast rotations
eval_fbt_setupCKKS functional bootstrapping of a look-up table
eval_fe_func_bootstrap_setupCKKS functional bootstrapping of a Fourier series
eval_fhew_to_ckks_setupSwitch FHEW ciphertexts to a CKKS ciphertext
eval_floorEvaluate a floor (rounding) function on an LWE ciphertext
eval_funcEvaluate an arbitrary function on an encrypted value
eval_hermite_trig_seriesEvaluate a trigonometric Hermite series on a ciphertext
eval_inner_productInner product of two encrypted vectors
EvalKeyEvalKey class for multi-party key operations
EvalKeyMapMap of homomorphic evaluation keys
eval_linear_wsumWeighted sum of ciphertexts (CKKS)
eval_logisticEvaluate logistic function on a ciphertext
eval_mergeMerge the first slots of several ciphertexts into one
eval_multHomomorphic multiplication
eval_mult_and_relinearizeFused multiply-and-relinearize
eval_mult_in_placeHomomorphic multiplication by a number, in place
eval_mult_key_genGenerate relinearization (eval-mult) keys for a secret key
eval_mult_keys_genGenerate relinearization keys for higher powers of the secret...
eval_mult_mutableHomomorphic multiply, mutable variant
eval_mult_no_relinHomomorphic multiplication without relinearization
eval_mvb_precomputeSeveral look-up tables on one input (multi-value...
eval_negateHomomorphic negation
eval_negate_in_placeHomomorphic negation in place
eval_notEvaluate NOT on an encrypted value
eval_polyEvaluate a polynomial on a ciphertext
eval_poly_linearEvaluate a polynomial via the linear evaluator
eval_poly_psEvaluate a polynomial via the Paterson-Stockmeyer method
eval_powersEvaluate several series on one ciphertext
eval_rotateRotate ciphertext slots
eval_rotate_key_genGenerate rotation keys for a secret key
eval_scheme_switching_setupComparison, minimum and maximum through scheme switching
eval_signEvaluate sign on an encrypted value (functional...
eval_sinEvaluate sine on a ciphertext (Chebyshev approximation)
eval_squareHomomorphic squaring
eval_square_in_placeSquare, rescale or relinearize a ciphertext in place
eval_square_mutableHomomorphic square, mutable variant
eval_subHomomorphic subtraction
eval_sub_in_placeHomomorphic subtraction in place
eval_sub_mutableHomomorphic subtract, mutable variant
eval_sumSum all slots in a ciphertext
eval_sum_key_genGenerate sum keys for a secret key
eval_sum_rowsSum the rows or the columns of an encrypted matrix
ExecutionModeExecution Mode
FastRotationPrecomputationPrecomputed digit decomposition for hoisted rotations
FeaturePKE Scheme Features (bitmask)
fhe_ckks_tolerancePer-test CKKS precision tolerance
fhe_contextCreate a fully homomorphic encryption context
fhe_deserializeDeserialize an OpenFHE object from file
fhe_deserialize_stringDeserialize an OpenFHE object held in memory
fhe_serializeSerialize an OpenFHE object
find_automorphism_indexCompute the automorphism index for a single slot index
find_automorphism_indicesCompute the automorphism indices for a list of slot indices
FormatPolynomial representation
gen_crypto_contextGenerate a CryptoContext from a parameter object
generate_lut_via_functionGenerate a lookup table for an arbitrary plaintext function
get_all_contextsAll contexts the library currently holds
get_all_eval_automorphism_keysRetrieve all registered EvalAutomorphism key maps
get_all_eval_mult_keysRetrieve all registered EvalMult key vectors
get_all_eval_sum_keysRetrieve all registered EvalSum key maps
get_bin_cc_for_scheme_switchThe FHEW side of a scheme-switching context
get_bootstrap_depthGet the required multiplicative depth for CKKS bootstrapping
get_bt_keyThe bootstrapping keys of a BinFHE context
get_ckks_boot_correction_factorGet the CKKS bootstrap correction factor
get_complex_packed_valueGet complex values from a CKKS plaintext
get_crypto_contextAssociated CryptoContext of a Ciphertext
get_crypto_parametersCrypto parameters of a CryptoContext
get_cyclotomic_orderCyclotomic order of a CryptoContext
get_element_modulusModulus and representation of a plaintext's element
get_element_paramsElement parameters of a CryptoContext
get_encoding_paramsEncoding parameters of a CryptoContext
get_eval_automorphism_key_mapRetrieve the automorphism-key map for a given key tag
get_eval_mult_key_vectorRetrieve the EvalMult key vector for a given key tag
get_eval_sum_key_mapRetrieve the sum-key map for a given key tag
get_existing_eval_automorphism_key_indicesWhich automorphism keys exist
get_fbt_depthMultiplicative depth of functional bootstrapping
get_hermite_trig_coefficientsTrigonometric Hermite interpolation of a look-up table
get_hop_levelHop level and encoding type of a ciphertext
get_key_gen_levelKey-generation level of a CryptoContext
get_max_plaintext_spaceMaximum supported plaintext space for functional...
get_modulusThe ciphertext modulus
get_modulus_ckksModuli and root of unity of a CryptoContext
get_multiplicative_depth_by_coeff_vectorMultiplicative depth of a polynomial evaluation
get_nParameters of a BinFHE context
get_native_intGet the native integer size of the OpenFHE build
get_num_threadsReport the number of OpenMP threads available to OpenFHE
get_packed_valueGet packed integer values from a plaintext
get_plaintext_for_decryptAn empty plaintext of the type a decryption will fill
get_plaintext_generatorThe plaintext generator of an encoding
get_pt_modulusModuli of an LWE ciphertext
get_ptrExtract pointer with validation
get_public_keyThe public key an object holds
get_real_packed_valueGet real values from a CKKS plaintext
get_scaling_factor_realReal-valued CKKS scaling factor at a modulus-chain level
insert_eval_automorphism_keyInsert a joined automorphism-key map into the cc registry
insert_eval_mult_keyInsert an EvalMult key vector into the cc registry
insert_eval_sum_keyInsert a joined sum-key map into the cc registry
int_boot_addCombine encrypted and unencrypted masked decryptions
int_boot_adjust_scalePrepare a ciphertext for interactive bootstrap
int_boot_decryptServer-side masked decryption for interactive bootstrap
int_boot_encryptClient-side re-encryption for interactive bootstrap
int_mp_boot_addAggregate multi-party shares pairs
int_mp_boot_adjust_scalePrepare a ciphertext for multi-party interactive bootstrap
int_mp_boot_decryptMulti-party masked decryption for interactive bootstrap
int_mp_boot_encryptFinal re-encryption for multi-party interactive bootstrap
int_mp_boot_random_element_genGenerate a common random element for multi-party bootstrap
is_goodIs a KeyPair valid?
key_genGenerate key pair
KeygenModeKey Generation Mode
KeyPairKey Pair
key_switch_downScale a ciphertext down from extended CRT basis to Q
key_switch_extSteps of hybrid key switching
key_switch_genSwitch a ciphertext from one secret key to another
KeySwitchTechniqueKey Switching Techniques
key_tagKey tag accessors
level_reduceReduce the modulus chain by multiple levels
level_reduce_in_placeReduce the modulus chain by multiple levels, in place
LWECiphertextLWE Ciphertext (Binary FHE)
LWEKeyPairLWE key pair (Binary FHE)
LWEPrivateKeyLWE Private Key (Binary FHE)
LWEPublicKeyLWE public key (Binary FHE)
LWESwitchingKeyLWE switching key (Binary FHE)
make_ckks_packed_plaintextMake a CKKS packed plaintext from real numbers
make_coef_packed_plaintextMake a coefficient-packed integer plaintext
make_packed_plaintextMake a packed integer plaintext
make_string_plaintextEncode a character string as a plaintext
mod_reduceReduce the modulus chain by one level
mod_reduce_in_placeReduce the modulus chain by one level, in place
multi_add_eval_automorphism_keysCombine two automorphism-key map shares
multi_add_eval_keysCombine evaluation keys from multiple parties
multi_add_eval_mult_keysCombine partial eval-mult keys from multiple parties
multi_add_eval_sum_keysCombine two sum-key map shares into a joint sum-key map
multi_add_pub_keysCombine public keys from multiple parties
multi_eval_at_index_key_genGenerate a joint rotation-at-index key share
multi_eval_automorphism_key_genGenerate a joint automorphism-key share for multi-party...
multi_eval_sum_key_genGenerate a joint sum-key share for multi-party EvalSum
multi_key_switch_genMulti-party key-switch eval-key generation
multi_mult_eval_keyA party's share of the joint multiplication key (threshold...
multiparty_decrypt_fusionFuse partial decryptions into final plaintext
multiparty_decrypt_leadLead party's partial decryption
multiparty_decrypt_mainNon-lead party's partial decryption
multiparty_key_genGenerate a key pair for a secondary party in threshold FHE
MultipartyModeMultiparty Mode
MultiplicationTechniqueMultiplication Technique (BFV)
number_ciphertext_elementsThe ring elements of a ciphertext
OpenFHEObjectBase class for OpenFHE objects
openfhe.R-packageopenfhe.R: R Interface to the 'OpenFHE' Fully Homomorphic...
PlaintextPlaintext
plaintext_accessorsPlaintext accessors
PlaintextEncodingsPlaintext Encoding Types
plaintext_params_hashDeterministic hash of a plaintext's identifying parameters
PolyVectorAn RLWE ciphertext
PREModeProxy Re-encryption Mode
PrivateKeyPrivate Key
ptr_is_validCheck if an external pointer is valid (non-NULL)
PublicKeyPublic Key
recover_shared_keyRecover a secret key from distributed shares
re_key_genProxy re-encryption
relinearizeRelinearize a higher-degree ciphertext
rescaleRescale a CKKS ciphertext (alias for ModReduce)
ring_dimensionRing dimension of a CryptoContext
RingGSWBTKeyBootstrapping key (Binary FHE)
ScalingTechniqueScaling Techniques (CKKS)
SchemeBaseThe scheme object of a CryptoContext
SchemeIdScheme Identifier
schemelet_convert_rlwe_to_ckksConvert between RLWE and CKKS ciphertexts
schemelet_get_element_paramsRLWE encryption under a CKKS secret key
SchemeSwitchingDataSerializerWrite and read the data of a scheme-switching computation
SchSwchParamsParameters of scheme switching
SecretKeyDistSecret Key Distribution
SecretShareMapMap of secret-key shares for threshold-FHE abort recovery
SecurityLevelSecurity Levels
serialized_object_nameName and version of a serialized object
serialize_eval_bootstrap_keySerialize the keys CKKS bootstrapping uses
serialize_eval_keysSerialize evaluation keys from the key registry
SeriesPowersPrecomputed powers of a ciphertext
set_ckks_boot_correction_factorSet the CKKS bootstrap correction factor
set_key_gen_levelSet the key-generation level of a CryptoContext
set_lengthSet the effective length of a plaintext
set_num_threadsSet the number of OpenMP threads OpenFHE may use
set_params_from_ckks_cryptocontextFill scheme-switching parameters from a CKKS context
set_scheme_idSet the scheme identifier of a CryptoContext
share_keysDistribute a secret key into shares
sparse_key_genGenerate a sparse key pair
switch_ct_to_qnSwitch a public-key ciphertext to the small modulus and...
threshold_decryptThreshold decryption convenience: lead + main + fusion in one...
with_fhe_contextExecute code with automatic cleanup of FHE state
openfhe.R documentation built on Nov. 13, 2026, 5:07 p.m.