123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116 |
- #ifndef BINFHECONTEXT_DOCSTRINGS_H
- #define BINFHECONTEXT_DOCSTRINGS_H
- const char* binfhe_GenerateBinFHEContext_parset_docs = R"pbdoc(
- Creates a crypto context using predefined parameter sets. Recommended for most users.
- :param set: The parameter set: TOY, MEDIUM, STD128, STD192, STD256.
- :type set: BINFHE_PARAMSET
- :param method: The bootstrapping method (DM or CGGI).
- :type method: BINFHE_METHOD
- :return: The created crypto context.
- :rtype: BinFHEContext
- )pbdoc";
- const char* binfhe_KeyGen_docs = R"pbdoc(
- Generates a secret key for the main LWE scheme.
- :return: The secret key.
- :rtype: LWEPrivateKey
- )pbdoc";
- const char* binfhe_BTKeyGen_docs = R"pbdoc(
- Generates bootstrapping keys.
- :param sk: The secret key.
- :type sk: LWEPrivateKey
- )pbdoc";
- const char* binfhe_Encrypt_docs = R"pbdoc(
- Encrypts a bit using a secret key (symmetric key encryption).
- :param sk: The secret key.
- :type sk: LWEPrivateKey
- :param m: The plaintext.
- :type m: int
- :param output: FRESH to generate a fresh ciphertext, BOOTSTRAPPED to generate a refreshed ciphertext (default).
- :type output: BINFHE_OUTPUT
- :param p: Plaintext modulus (default 4).
- :type p: int
- :param mod: Encrypt according to mod instead of m_q if mod != 0.
- :type mod: int
- :return: The ciphertext.
- :rtype: LWECiphertext
- )pbdoc";
- const char* binfhe_Decrypt_docs = R"pbdoc(
- Decrypts a ciphertext using a secret key.
- :param sk: The secret key.
- :type sk: LWEPrivateKey
- :param ct: The ciphertext.
- :type ct: LWECiphertext
- :param p: Plaintext modulus (default 4).
- :type p: int
- :return: The plaintext.
- :rtype: int
- )pbdoc";
- const char* binfhe_EvalBinGate_docs = R"pbdoc(
- Evaluates a binary gate (calls bootstrapping as a subroutine).
- :param gate: The gate; can be AND, OR, NAND, NOR, XOR, or XNOR.
- :type gate: BINGATE
- :param ct1: First ciphertext.
- :type ct1: LWECiphertext
- :param ct2: Second ciphertext.
- :type ct2: LWECiphertext
- :return: The resulting ciphertext.
- :rtype: LWECiphertext
- )pbdoc";
- const char* binfhe_EvalNOT_docs = R"pbdoc(
- Evaluates the NOT gate.
- :param ct: The input ciphertext.
- :type ct: LWECiphertext
- :return: The resulting ciphertext.
- :rtype: LWECiphertext
- )pbdoc";
- #endif
|