updated the documentation

openfheorg · May 24, 2024 · 256f93c · 256f93c
1 parent a89c57e
commit 256f93c
Show file tree

Hide file tree

Showing 24 changed files with 341 additions and 285 deletions.
diff --git a/docs/doctrees/binfhe.doctree b/docs/doctrees/binfhe.doctree
diff --git a/docs/doctrees/binfhe_enums.doctree b/docs/doctrees/binfhe_enums.doctree
diff --git a/docs/doctrees/ciphertext.doctree b/docs/doctrees/ciphertext.doctree
diff --git a/docs/doctrees/cryptocontext.doctree b/docs/doctrees/cryptocontext.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/doctrees/keys.doctree b/docs/doctrees/keys.doctree
diff --git a/docs/doctrees/pke_enums.doctree b/docs/doctrees/pke_enums.doctree
diff --git a/docs/doctrees/plaintext.doctree b/docs/doctrees/plaintext.doctree
diff --git a/docs/html/_static/basic.css b/docs/html/_static/basic.css
@@ -670,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/docs/html/_static/pygments.css b/docs/html/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #E40000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #008400 } /* Generic.Inserted */

diff --git a/docs/html/binfhe.html b/docs/html/binfhe.html
@@ -1,21 +1,23 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>BinFHEContext &mdash; openfhe-python 0.8.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6a14807c"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />

diff --git a/docs/html/binfhe_enums.html b/docs/html/binfhe_enums.html
@@ -1,21 +1,23 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>BinFHE enums &mdash; openfhe-python 0.8.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6a14807c"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -438,22 +440,22 @@ <h2>Binary Gates<a class="headerlink" href="#binary-gates" title="Permalink to t
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="openfhe.BINGATE.XNOR">
-<span class="sig-name descname"><span class="pre">XNOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XNOR:</span> <span class="pre">13&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XNOR" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">XNOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XNOR:</span> <span class="pre">5&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XNOR" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="openfhe.BINGATE.XNOR_FAST">
-<span class="sig-name descname"><span class="pre">XNOR_FAST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XNOR_FAST:</span> <span class="pre">5&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XNOR_FAST" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">XNOR_FAST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XNOR_FAST:</span> <span class="pre">12&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XNOR_FAST" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="openfhe.BINGATE.XOR">
-<span class="sig-name descname"><span class="pre">XOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XOR:</span> <span class="pre">12&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XOR" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">XOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XOR:</span> <span class="pre">4&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XOR" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="openfhe.BINGATE.XOR_FAST">
-<span class="sig-name descname"><span class="pre">XOR_FAST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XOR_FAST:</span> <span class="pre">4&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XOR_FAST" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">XOR_FAST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;BINGATE.XOR_FAST:</span> <span class="pre">11&gt;</span></em><a class="headerlink" href="#openfhe.BINGATE.XOR_FAST" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py property">

diff --git a/docs/html/ciphertext.html b/docs/html/ciphertext.html
@@ -1,21 +1,23 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Ciphertext &mdash; openfhe-python 0.8.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=6a14807c"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -49,8 +51,10 @@
 <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>
 <li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.GetLevel"><code class="docutils literal notranslate"><span class="pre">Ciphertext.GetLevel()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.GetSlots"><code class="docutils literal notranslate"><span class="pre">Ciphertext.GetSlots()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.RemoveElement"><code class="docutils literal notranslate"><span class="pre">Ciphertext.RemoveElement()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.SetLevel"><code class="docutils literal notranslate"><span class="pre">Ciphertext.SetLevel()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#openfhe.Ciphertext.SetSlots"><code class="docutils literal notranslate"><span class="pre">Ciphertext.SetSlots()</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -115,6 +119,11 @@ <h1>Ciphertext<a class="headerlink" href="#ciphertext" title="Permalink to this
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="openfhe.Ciphertext.GetSlots">
+<span class="sig-name descname"><span class="pre">GetSlots</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"><a class="reference internal" href="#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#openfhe.Ciphertext.GetSlots" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="openfhe.Ciphertext.RemoveElement">
 <span class="sig-name descname"><span class="pre">RemoveElement</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"><a class="reference internal" href="#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</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"><span class="pre">None</span></span></span><a class="headerlink" href="#openfhe.Ciphertext.RemoveElement" title="Permalink to this definition"></a></dt>
@@ -137,6 +146,11 @@ <h1>Ciphertext<a class="headerlink" href="#ciphertext" title="Permalink to this
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="openfhe.Ciphertext.SetSlots">
+<span class="sig-name descname"><span class="pre">SetSlots</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"><a class="reference internal" href="#openfhe.Ciphertext" title="openfhe.Ciphertext"><span class="pre">openfhe.Ciphertext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg0</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"><span class="pre">None</span></span></span><a class="headerlink" href="#openfhe.Ciphertext.SetSlots" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 </dd></dl>
 
 </section>