Openfhe

‘openfhe’ Dialect

The openfhe dialect is an exit dialect for generating c++ code against the OpenFHE library API.

See https://github.com/openfheorg/openfhe-development

Openfhe types

CCParamsType

The CCParams required to create CryptoContext.

Syntax: !openfhe.cc_params

CiphertextType

An opaque OpenFHE ciphertext type

Syntax: !openfhe.ciphertext

CryptoContextType

The CryptoContext required to perform homomorphic operations in OpenFHE.

Syntax: !openfhe.crypto_context

DigitDecompositionType

A precomputed digit decomposition for for EvalFastRotation

Syntax: !openfhe.digit_decomp

EvalKeyType

The evaluation key required to keyswitch/relinearize/rotate/automorphism operation in OpenFHE.

Syntax: !openfhe.eval_key

PlaintextType

An opaque OpenFHE plaintext type

Syntax: !openfhe.plaintext

PrivateKeyType

The private key required to decrypt a ciphertext in OpenFHE.

Syntax: !openfhe.private_key

PublicKeyType

The public key required to encrypt plaintext in OpenFHE.

Syntax: !openfhe.public_key

Openfhe ops

openfhe.add_inplace (heir::openfhe::AddInPlaceOp)

In-place addition, modifying lhs.

Syntax:

operation ::= `openfhe.add_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.add (heir::openfhe::AddOp)

Addition of two ciphertexts.

Syntax:

operation ::= `openfhe.add` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.add_plain_inplace (heir::openfhe::AddPlainInPlaceOp)

In-place addition of a ciphertext and a plaintext, modifying the ciphertext operand.

Syntax:

operation ::= `openfhe.add_plain_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.add_plain (heir::openfhe::AddPlainOp)

Addition of a ciphertext and a plaintext.

Syntax:

operation ::= `openfhe.add_plain` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.automorph (heir::openfhe::AutomorphOp)

Syntax:

operation ::= `openfhe.automorph` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.bootstrap (heir::openfhe::BootstrapOp)

OpenFHE bootstrap operation of a ciphertext. (For CKKS)

Syntax:

operation ::= `openfhe.bootstrap` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.decode_ckks (heir::openfhe::DecodeCKKSOp)

Syntax:

operation ::= `openfhe.decode_ckks` operands attr-dict `:` type($input) `->` type($output)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.decode (heir::openfhe::DecodeOp)

Syntax:

operation ::= `openfhe.decode` operands attr-dict `:` type($input) `->` type($output)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.decrypt (heir::openfhe::DecryptOp)

Syntax:

operation ::= `openfhe.decrypt` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.encrypt (heir::openfhe::EncryptOp)

Syntax:

operation ::= `openfhe.encrypt` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.fast_rotation (heir::openfhe::FastRotationOp)

Syntax:

operation ::= `openfhe.fast_rotation` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: BatchVectorizableOpInterface, ConditionallySpeculatable, ElementwiseByOperandOpInterface, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

openfhe.fast_rotation_precompute (heir::openfhe::FastRotationPrecomputeOp)

Syntax:

operation ::= `openfhe.fast_rotation_precompute` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.gen_bootstrapkey (heir::openfhe::GenBootstrapKeyOp)

Syntax:

operation ::= `openfhe.gen_bootstrapkey` operands attr-dict `:` functional-type(operands, results)

Operands:

openfhe.gen_context (heir::openfhe::GenContextOp)

Syntax:

operation ::= `openfhe.gen_context` operands attr-dict `:` functional-type(operands, results)

Interfaces: InferTypeOpInterface

Attributes:

Operands:

Results:

openfhe.gen_mulkey (heir::openfhe::GenMulKeyOp)

Syntax:

operation ::= `openfhe.gen_mulkey` operands attr-dict `:` functional-type(operands, results)

Operands:

openfhe.gen_params (heir::openfhe::GenParamsOp)

Syntax:

operation ::= `openfhe.gen_params` operands attr-dict `:` functional-type(operands, results)

Generates the parameters for the OpenFHE scheme.

mulDepth is the depth of the multiplication circuit, including the bootstrapping depth.

plainMod is the modulus of the plaintext space. If we are using CKKS, this is 0.

insecure is a flag that determines whether the parameters are generated securely or not. In Openfhe, this means setting HEStd_NotSet for security level.

For other flags, see the OpenFHE documentation in https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples/README.md#description-of-the-cryptocontext-parameters-and-their-restrictions

Interfaces: InferTypeOpInterface

Attributes:

Results:

openfhe.gen_rotkey (heir::openfhe::GenRotKeyOp)

Syntax:

operation ::= `openfhe.gen_rotkey` operands attr-dict `:` functional-type(operands, results)

Attributes:

Operands:

openfhe.key_switch_inplace (heir::openfhe::KeySwitchInPlaceOp)

In-place key switch of a ciphertext.

Syntax:

operation ::= `openfhe.key_switch_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.key_switch (heir::openfhe::KeySwitchOp)

Key switch a ciphertext.

Syntax:

operation ::= `openfhe.key_switch` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.level_reduce_inplace (heir::openfhe::LevelReduceInPlaceOp)

In-place level reduction of a ciphertext.

Syntax:

operation ::= `openfhe.level_reduce_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Attributes:

Operands:

Results:

openfhe.level_reduce (heir::openfhe::LevelReduceOp)

Reduce the level of a ciphertext.

Syntax:

operation ::= `openfhe.level_reduce` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

openfhe.make_ckks_packed_plaintext (heir::openfhe::MakeCKKSPackedPlaintextOp)

Syntax:

operation ::= `openfhe.make_ckks_packed_plaintext` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.make_packed_plaintext (heir::openfhe::MakePackedPlaintextOp)

Syntax:

operation ::= `openfhe.make_packed_plaintext` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.mod_reduce_inplace (heir::openfhe::ModReduceInPlaceOp)

In-place mod_reduce of a ciphertext. (used only for BGV/CKKS)

Syntax:

operation ::= `openfhe.mod_reduce_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.mod_reduce (heir::openfhe::ModReduceOp)

Mod_reduce of a ciphertext. (used only for BGV/CKKS)

Syntax:

operation ::= `openfhe.mod_reduce` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.mul_const_inplace (heir::openfhe::MulConstInPlaceOp)

In-place multiplication of a ciphertext and a constant, modifying the ciphertext.

Syntax:

operation ::= `openfhe.mul_const_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.mul_const (heir::openfhe::MulConstOp)

Multiplication of a ciphertext and a constant.

Syntax:

operation ::= `openfhe.mul_const` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.mul_no_relin (heir::openfhe::MulNoRelinOp)

Multiplication of two ciphertexts without relinearization.

Syntax:

operation ::= `openfhe.mul_no_relin` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, IncreasesMulDepthOpInterface, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.mul (heir::openfhe::MulOp)

Multiplication of two ciphertexts with relinearization.

Syntax:

operation ::= `openfhe.mul` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, IncreasesMulDepthOpInterface, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.mul_plain (heir::openfhe::MulPlainOp)

Multiplication of a ciphertext and a plaintext.

Syntax:

operation ::= `openfhe.mul_plain` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, IncreasesMulDepthOpInterface, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.negate_inplace (heir::openfhe::NegateInPlaceOp)

In-place negation of a ciphertext.

Syntax:

operation ::= `openfhe.negate_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.negate (heir::openfhe::NegateOp)

Negation of a ciphertext.

Syntax:

operation ::= `openfhe.negate` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.relin_inplace (heir::openfhe::RelinInPlaceOp)

In-place relinearization of a ciphertext.

Syntax:

operation ::= `openfhe.relin_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.relin (heir::openfhe::RelinOp)

Relinearization of a ciphertext.

Syntax:

operation ::= `openfhe.relin` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.rot (heir::openfhe::RotOp)

Syntax:

operation ::= `openfhe.rot` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

openfhe.setup_bootstrap (heir::openfhe::SetupBootstrapOp)

Syntax:

operation ::= `openfhe.setup_bootstrap` operands attr-dict `:` functional-type(operands, results)

Attributes:

Operands:

openfhe.square_inplace (heir::openfhe::SquareInPlaceOp)

In-place square of a ciphertext.

Syntax:

operation ::= `openfhe.square_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.square (heir::openfhe::SquareOp)

Square of a ciphertext.

Syntax:

operation ::= `openfhe.square` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.sub_inplace (heir::openfhe::SubInPlaceOp)

In-place subtraction, modifying lhs.

Syntax:

operation ::= `openfhe.sub_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.sub (heir::openfhe::SubOp)

Subtraction of two ciphertexts.

Syntax:

operation ::= `openfhe.sub` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

openfhe.sub_plain_inplace (heir::openfhe::SubPlainInPlaceOp)

In-place subtraction of a ciphertext and a plaintext, modifying the ciphertext operand.

Syntax:

operation ::= `openfhe.sub_plain_inplace` operands attr-dict `:` functional-type(operands, results)

Interfaces: InPlaceOpInterface, InferTypeOpInterface

Operands:

Results:

openfhe.sub_plain (heir::openfhe::SubPlainOp)

Subtraction of a ciphertext and a plaintext.

Syntax:

operation ::= `openfhe.sub_plain` operands attr-dict `:` functional-type(operands, results)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results: