| openfhe: R Interface to the OpenFHE Fully Homomorphic Encryption Library | openfhe-package openfhe |
| BFV Parameters | BFVParams |
| BGV Parameters | BGVParams |
| Generate BinFHE bootstrapping keys | bin_bt_key_gen |
| Decrypt a Binary FHE ciphertext | bin_decrypt |
| Encrypt a value for Binary FHE | bin_encrypt |
| Create a Binary FHE context | bin_fhe_context |
| Generate BinFHE secret key | bin_key_gen |
| Binary FHE Methods Source: binfhe/binfhe-constants.h enum BINFHE_METHOD | BinFHEMethod |
| Binary FHE Output Types Source: binfhe/binfhe-constants.h enum BINFHE_OUTPUT | BinFHEOutput |
| Binary FHE Parameter Sets Source: binfhe/binfhe-constants.h enum BINFHE_PARAMSET (sequential from 0) | BinFHEParamSet |
| Binary Gate Types Source: binfhe/binfhe-constants.h enum BINGATE (sequential from 0) | BinGate |
| CCParams getters (all schemes) | ccparams_getters get_batch_size get_ckks_data_type get_composite_degree get_decryption_noise_mode get_desired_precision get_digit_size get_encryption_technique get_eval_add_count get_execution_mode get_first_mod_size get_interactive_boot_compression_level get_key_switch_count get_key_switch_technique get_max_relin_sk_deg get_multiparty_mode get_multiplication_technique get_multiplicative_depth get_noise_estimate get_num_adversarial_queries get_num_large_digits get_plaintext_modulus get_pre_mode get_pre_num_hops get_register_word_size get_ring_dim get_scaling_mod_size get_scaling_technique get_scheme get_secret_key_dist get_security_level get_standard_deviation get_statistical_security get_threshold_num_of_parties |
| Ciphertext class | Ciphertext |
| CKKS scaling-mod-size in bits | ckks_scaling_factor_bits |
| CKKS Data Type Source: pke/constants-defs.h enum CKKSDataType | CKKSDataType |
| CKKS Parameters | CKKSParams |
| Clear the EvalAutomorphism key cache | clear_eval_automorphism_keys |
| Clear the EvalMult key cache | clear_eval_mult_keys |
| Clear cached evaluation keys and contexts | clear_fhe_state |
| Clear OpenFHE static maps and vectors | clear_static_maps_and_vectors |
| Compress a ciphertext to fewer towers | compress |
| Compression Level (interactive multi-party bootstrap) Source: pke/constants-defs.h enum CompressionLevel NOTE: values start at 2, not 0. The header comment explains that compression levels 0 and 1 are not supported and the values are not renumbered. | CompressionLevel |
| Crypto Context | CryptoContext |
| Crypto Parameters (opaque) | CryptoParameters |
| Decrypt a ciphertext | decrypt |
| Decryption Noise Mode Source: pke/constants-defs.h enum DecryptionNoiseMode | DecryptionNoiseMode |
| Deserialize evaluation keys from file | deserialize_eval_keys |
| Distribution Type (lattice parameters) Source: core/lattice/stdlatticeparms.h enum DistributionType | DistributionType |
| Element Parameters (opaque) | ElementParams |
| Enable a feature on a CryptoContext | enable_feature |
| Encoding Parameters (opaque) | EncodingParams |
| Encrypt a plaintext | encrypt |
| Encryption Technique Source: pke/constants-defs.h enum EncryptionTechnique | EncryptionTechnique |
| Homomorphic addition | eval_add |
| Homomorphic addition in place | eval_add_in_place |
| Homomorphic add, mutable variant | eval_add_mutable |
| Generate at-index (rotation) keys for a secret key | eval_at_index_key_gen |
| Apply an automorphism to a ciphertext | eval_automorphism |
| Generate automorphism evaluation keys for a set of indices | eval_automorphism_key_gen |
| Evaluate a binary gate on encrypted values | eval_bin_gate |
| Perform CKKS bootstrapping | eval_bootstrap |
| Generate bootstrapping keys | eval_bootstrap_key_gen |
| Set up CKKS bootstrapping | eval_bootstrap_setup |
| Evaluate a Chebyshev series on a ciphertext | eval_chebyshev |
| Chebyshev coefficients for a real-valued function | eval_chebyshev_coefficients |
| Evaluate a user-supplied function on a CKKS ciphertext via Chebyshev approximation | eval_chebyshev_function |
| Evaluate a Chebyshev series via the linear evaluator | eval_chebyshev_linear |
| Evaluate a Chebyshev series via the Paterson-Stockmeyer method | eval_chebyshev_ps |
| Evaluate cosine on a ciphertext | eval_cos |
| Evaluate division approximation on a ciphertext | eval_divide |
| Hoisted slot rotation using precomputed digits | eval_fast_rotation |
| Extended hoisted slot rotation | eval_fast_rotation_ext |
| Precompute digit decomposition for hoisted fast rotations | eval_fast_rotation_precompute |
| Evaluate a floor (rounding) function on an LWE ciphertext | eval_floor |
| Evaluate an arbitrary function on an encrypted value | eval_func |
| Evaluate logistic function on a ciphertext | eval_logistic |
| Homomorphic multiplication | eval_mult |
| Fused multiply-and-relinearize | eval_mult_and_relinearize |
| Homomorphic multiplication in place | eval_mult_in_place |
| Generate relinearization (eval-mult) keys for a secret key | eval_mult_key_gen |
| Homomorphic multiply, mutable variant | eval_mult_mutable |
| Homomorphic multiplication without relinearization | eval_mult_no_relin |
| Homomorphic negation | eval_negate |
| Homomorphic negation in place | eval_negate_in_place |
| Evaluate NOT on an encrypted value | eval_not |
| Evaluate a polynomial on a ciphertext | eval_poly |
| Evaluate a polynomial via the linear evaluator | eval_poly_linear |
| Evaluate a polynomial via the Paterson-Stockmeyer method | eval_poly_ps |
| Rotate ciphertext slots | eval_rotate |
| Generate rotation keys for a secret key | eval_rotate_key_gen |
| Evaluate sign on an encrypted value (functional bootstrapping) | eval_sign |
| Evaluate sine on a ciphertext (Chebyshev approximation) | eval_sin |
| Homomorphic squaring | eval_square |
| Homomorphic square, mutable variant | eval_square_mutable |
| Homomorphic subtraction | eval_sub |
| Homomorphic subtraction in place | eval_sub_in_place |
| Homomorphic subtract, mutable variant | eval_sub_mutable |
| Sum all slots in a ciphertext | eval_sum |
| Generate sum keys for a secret key | eval_sum_key_gen |
| EvalKey class for multi-party key operations | EvalKey |
| Map of homomorphic evaluation keys | EvalKeyMap |
| Execution Mode Source: pke/constants-defs.h enum ExecutionMode | ExecutionMode |
| Precomputed digit decomposition for hoisted rotations | FastRotationPrecomputation |
| PKE Scheme Features (bitmask) Source: pke/constants-defs.h enum PKESchemeFeature | Feature |
| Per-test CKKS precision tolerance | fhe_ckks_tolerance |
| Create a fully homomorphic encryption context | fhe_context |
| Deserialize an OpenFHE object from file | fhe_deserialize |
| Serialize an OpenFHE object to file | fhe_serialize |
| Compute the automorphism index for a single slot index | find_automorphism_index |
| Compute the automorphism indices for a list of slot indices | find_automorphism_indices |
| Generate a lookup table for an arbitrary plaintext function | generate_lut_via_function |
| Retrieve all registered EvalAutomorphism key maps | get_all_eval_automorphism_keys |
| Retrieve all registered EvalMult key vectors | get_all_eval_mult_keys |
| Retrieve all registered EvalSum key maps | get_all_eval_sum_keys |
| Get the required multiplicative depth for CKKS bootstrapping | get_bootstrap_depth |
| Get the CKKS bootstrap correction factor | get_ckks_boot_correction_factor |
| Get complex values from a CKKS plaintext | get_complex_packed_value |
| Associated CryptoContext of a Ciphertext | get_crypto_context |
| Crypto parameters of a CryptoContext | get_crypto_parameters |
| Cyclotomic order of a CryptoContext | get_cyclotomic_order |
| Element parameters of a CryptoContext | get_element_params |
| Encoding parameters of a CryptoContext | get_encoding_params |
| Retrieve the automorphism-key map for a given key tag | get_eval_automorphism_key_map |
| Retrieve the EvalMult key vector for a given key tag | get_eval_mult_key_vector |
| Retrieve the sum-key map for a given key tag | get_eval_sum_key_map |
| Key-generation level of a CryptoContext | get_key_gen_level |
| Maximum supported plaintext space for functional bootstrapping | get_max_plaintext_space |
| Get the native integer size of the OpenFHE build | get_native_int |
| Get packed integer values from a plaintext | get_packed_value |
| Get real values from a CKKS plaintext | get_real_packed_value |
| Real-valued CKKS scaling factor at a modulus-chain level | get_scaling_factor_real |
| Insert a joined automorphism-key map into the cc registry | insert_eval_automorphism_key |
| Insert an EvalMult key vector into the cc registry | insert_eval_mult_key |
| Insert a joined sum-key map into the cc registry | insert_eval_sum_key |
| Combine encrypted and unencrypted masked decryptions | int_boot_add |
| Prepare a ciphertext for interactive bootstrap | int_boot_adjust_scale |
| Server-side masked decryption for interactive bootstrap | int_boot_decrypt |
| Client-side re-encryption for interactive bootstrap | int_boot_encrypt |
| Aggregate multi-party shares pairs | int_mp_boot_add |
| Prepare a ciphertext for multi-party interactive bootstrap | int_mp_boot_adjust_scale |
| Multi-party masked decryption for interactive bootstrap | int_mp_boot_decrypt |
| Final re-encryption for multi-party interactive bootstrap | int_mp_boot_encrypt |
| Generate a common random element for multi-party bootstrap | int_mp_boot_random_element_gen |
| Is a KeyPair valid? | is_good |
| Generate key pair | key_gen |
| Scale a ciphertext down from extended CRT basis to Q | key_switch_down |
| Key tag accessors | get_key_tag key_tag set_key_tag |
| Key Generation Mode Source: binfhe/binfhe-constants.h enum KEYGEN_MODE | KeygenMode |
| Key Pair | KeyPair |
| Key Switching Techniques Source: pke/constants-defs.h enum KeySwitchTechnique | KeySwitchTechnique |
| Reduce the modulus chain by multiple levels | level_reduce |
| Reduce the modulus chain by multiple levels, in place | level_reduce_in_place |
| LWE Ciphertext (Binary FHE) | LWECiphertext |
| LWE Private Key (Binary FHE) | LWEPrivateKey |
| Make a CKKS packed plaintext from real numbers | make_ckks_packed_plaintext |
| Make a coefficient-packed integer plaintext | make_coef_packed_plaintext |
| Make a packed integer plaintext | make_packed_plaintext |
| Reduce the modulus chain by one level | mod_reduce |
| Reduce the modulus chain by one level, in place | mod_reduce_in_place |
| Combine two automorphism-key map shares | multi_add_eval_automorphism_keys |
| Combine evaluation keys from multiple parties | multi_add_eval_keys |
| Combine partial eval-mult keys from multiple parties | multi_add_eval_mult_keys |
| Combine two sum-key map shares into a joint sum-key map | multi_add_eval_sum_keys |
| Combine public keys from multiple parties | multi_add_pub_keys |
| Generate a joint rotation-at-index key share | multi_eval_at_index_key_gen |
| Generate a joint automorphism-key share for multi-party rotation | multi_eval_automorphism_key_gen |
| Generate a joint sum-key share for multi-party EvalSum | multi_eval_sum_key_gen |
| Multi-party key-switch eval-key generation | multi_key_switch_gen |
| Fuse partial decryptions into final plaintext | multiparty_decrypt_fusion |
| Lead party's partial decryption | multiparty_decrypt_lead |
| Non-lead party's partial decryption | multiparty_decrypt_main |
| Generate a key pair for a secondary party in threshold FHE | multiparty_key_gen |
| Multiparty Mode Source: pke/constants-defs.h enum MultipartyMode | MultipartyMode |
| Multiplication Technique (BFV) Source: pke/constants-defs.h enum MultiplicationTechnique | MultiplicationTechnique |
| Base class for OpenFHE objects | OpenFHEObject |
| Plaintext | Plaintext |
| Plaintext accessors | get_coef_packed_value get_element_ring_dimension get_encoding_type get_formatted_values get_length get_level get_log_error get_log_precision get_noise_scale_deg get_scaling_factor get_scaling_factor_int get_scheme_id get_slots get_string_value high_bound is_encoded low_bound plaintext_accessors set_ckks_data_type set_int_vector_value set_level set_noise_scale_deg set_scaling_factor set_scaling_factor_int set_slots set_string_value |
| Deterministic hash of a plaintext's identifying parameters | plaintext_params_hash |
| Plaintext Encoding Types Source: pke/constants-defs.h enum PlaintextEncodings | PlaintextEncodings |
| Proxy Re-encryption Mode Source: pke/constants-defs.h enum ProxyReEncryptionMode R-side name 'PREMode' matches the design.md §8 shortening convention (same pattern as 'Feature' for 'PKESchemeFeature'). | PREMode |
| Private Key | PrivateKey |
| Public Key | PublicKey |
| Recover a secret key from distributed shares | recover_shared_key |
| Relinearize a higher-degree ciphertext | relinearize |
| Rescale a CKKS ciphertext (alias for ModReduce) | rescale |
| Ring dimension of a CryptoContext | ring_dimension |
| Scaling Techniques (CKKS) Source: pke/constants-defs.h enum ScalingTechnique | ScalingTechnique |
| Scheme Identifier | SchemeId |
| Secret Key Distribution Source: core/lattice/constants-lattice.h enum SecretKeyDist | SecretKeyDist |
| Map of secret-key shares for threshold-FHE abort recovery | SecretShareMap |
| Security Levels Source: core/lattice/stdlatticeparms.h enum SecurityLevel | SecurityLevel |
| Serialize evaluation keys to file | serialize_eval_keys |
| Set the CKKS bootstrap correction factor | set_ckks_boot_correction_factor |
| Set the key-generation level of a CryptoContext | set_key_gen_level |
| Set the effective length of a plaintext | set_length |
| Distribute a secret key into shares | share_keys |
| Threshold decryption convenience: lead + main + fusion in one call | threshold_decrypt |
| Execute code with automatic cleanup of FHE state | with_fhe_context |
