updated documentation

openfheorg · Jun 13, 2024 · ab978e9 · ab978e9
1 parent 117368f
commit ab978e9
Show file tree

Hide file tree

Showing 19 changed files with 1,940 additions and 21 deletions.
diff --git a/docs/doctrees/cryptocontext.doctree b/docs/doctrees/cryptocontext.doctree
diff --git a/docs/doctrees/cryptoparams.doctree b/docs/doctrees/cryptoparams.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/html/_sources/cryptoparams.rst.txt b/docs/html/_sources/cryptoparams.rst.txt
@@ -0,0 +1,24 @@
+CryptoParams
+============
+
+The following crypto parameter objects are available per scheme **BFV**, **BGV** and **CKKS** respectively.
+
+CyrptoParamsBFVRNS
+##################
+.. autoclass:: openfhe.CCParamsBFVRNS
+    :members:
+    :show-inheritance:
+
+CryptoParamsBGVRNS
+##################
+.. autoclass:: openfhe.CCParamsBGVRNS
+    :members:
+    :show-inheritance:
+
+
+CryptoParamsCKKSRNS
+###################
+.. autoclass:: openfhe.CCParamsCKKSRNS
+    :members:
+    :show-inheritance:
+
diff --git a/docs/html/_sources/index.rst.txt b/docs/html/_sources/index.rst.txt
@@ -14,10 +14,11 @@ Fully Homomorphic Encryption (FHE) is a powerful cryptographic primitive that en
 while keeping the efficiency of C++ FHE operations.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 3
    :caption: API Reference:
 
    cryptocontext
+   cryptoparams
    ciphertext
    plaintext
    keys

diff --git a/docs/html/binfhe.html b/docs/html/binfhe.html
@@ -47,6 +47,7 @@
               <p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="cryptocontext.html">CryptoContext</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cryptoparams.html">CryptoParams</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ciphertext.html">Ciphertext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="plaintext.html">Plaintext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="keys.html">Public Key</a></li>

diff --git a/docs/html/binfhe_enums.html b/docs/html/binfhe_enums.html
@@ -46,6 +46,7 @@
               <p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="cryptocontext.html">CryptoContext</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cryptoparams.html">CryptoParams</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ciphertext.html">Ciphertext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="plaintext.html">Plaintext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="keys.html">Public Key</a></li>

diff --git a/docs/html/ciphertext.html b/docs/html/ciphertext.html
@@ -22,7 +22,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Plaintext" href="plaintext.html" />
-    <link rel="prev" title="CryptoContext" href="cryptocontext.html" /> 
+    <link rel="prev" title="CryptoParams" href="cryptoparams.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -47,6 +47,7 @@
               <p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="cryptocontext.html">CryptoContext</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cryptoparams.html">CryptoParams</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Ciphertext</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#openfhe.Ciphertext"><code class="docutils literal notranslate"><span class="pre">Ciphertext</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.Clone"><code class="docutils literal notranslate"><span class="pre">Ciphertext.Clone()</span></code></a></li>
@@ -159,7 +160,7 @@ <h1>Ciphertext<a class="headerlink" href="#ciphertext" title="Permalink to this
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="cryptocontext.html" class="btn btn-neutral float-left" title="CryptoContext" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="cryptoparams.html" class="btn btn-neutral float-left" title="CryptoParams" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="plaintext.html" class="btn btn-neutral float-right" title="Plaintext" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/html/cryptocontext.html b/docs/html/cryptocontext.html
@@ -21,7 +21,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Ciphertext" href="ciphertext.html" />
+    <link rel="next" title="CryptoParams" href="cryptoparams.html" />
     <link rel="prev" title="Welcome to OpenFHE - Python’s documentation!" href="index.html" /> 
 </head>
 
@@ -47,6 +47,7 @@
               <p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">CryptoContext</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cryptoparams.html">CryptoParams</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ciphertext.html">Ciphertext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="plaintext.html">Plaintext</a></li>
 <li class="toctree-l1"><a class="reference internal" href="keys.html">Public Key</a></li>
@@ -383,6 +384,11 @@ <h1>CryptoContext<a class="headerlink" href="#cryptocontext" title="Permalink to
 </ol>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">EvalAddManyInPlace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">openfhe.CryptoContext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertextVec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></span></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py">
 <span class="sig-name descname"><span class="pre">EvalAddMutable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
@@ -905,6 +911,16 @@ <h1>CryptoContext<a class="headerlink" href="#cryptocontext" title="Permalink to
 </ol>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">EvalLinearWSum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">openfhe.CryptoContext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coefficients</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></span></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">EvalLinearWSumMutable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">openfhe.CryptoContext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coefficients</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></span></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py">
 <span class="sig-name descname"><span class="pre">EvalLogistic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">openfhe.CryptoContext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">a</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degree</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></span></dt>
@@ -1074,6 +1090,11 @@ <h1>CryptoContext<a class="headerlink" href="#cryptocontext" title="Permalink to
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py">
+<span class="sig-name descname"><span class="pre">EvalMultMany</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">openfhe.CryptoContext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ciphertextVec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="ciphertext.html#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></span></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py">
 <span class="sig-name descname"><span class="pre">EvalMultMutable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
@@ -2590,7 +2611,7 @@ <h1>CryptoContext<a class="headerlink" href="#cryptocontext" title="Permalink to
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="index.html" class="btn btn-neutral float-left" title="Welcome to OpenFHE - Python’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="ciphertext.html" class="btn btn-neutral float-right" title="Ciphertext" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="cryptoparams.html" class="btn btn-neutral float-right" title="CryptoParams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>