Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit 3971bf5

Browse files
fabergafaberga
authored
Helib v1.0.2 documentation update
Includes the HElib v1.0.2 Reference manual in PDF and HTML formats.
1 parent 1d40331 commit 3971bf5

File tree

894 files changed

+101555
-16876
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

894 files changed

+101555
-16876
lines changed

‎Documentation/HElib/HElib-v1.0.2-refman.pdf‎

366 KB
Binary file not shown.

‎Documentation/HElib/html/_arg_map_8h.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
99
<meta name="generator" content="Doxygen 1.8.18"/>
1010
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11-
<title>HElib: include/helib/ArgMap.h File Reference</title>
11+
<title>HElib: /HElib/include/helib/ArgMap.h File Reference</title>
1212
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
1313
<script type="text/javascript" src="dynsections.js"></script>
1414
<link href="search/search.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
3030
<nav class="navbar navbar-default" role="navigation">
3131
<div class="container">
3232
<div class="navbar-header">
33-
<a class="navbar-brand">HElib </a>
33+
<a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
3434
</div>
3535
</div>
3636
</nav>
@@ -78,7 +78,8 @@
7878
</div><!-- top -->
7979
<div class="header">
8080
<div class="summary">
81-
<a href="#nested-classes">Classes</a> </div>
81+
<a href="#nested-classes">Classes</a> &#124;
82+
<a href="#namespaces">Namespaces</a> </div>
8283
<div class="headertitle">
8384
<div class="title">ArgMap.h File Reference</div> </div>
8485
</div><!--header-->
@@ -114,6 +115,11 @@
114115
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
115116
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhelib_1_1_arg_map_1_1_arg_processor.html">helib::ArgMap::ArgProcessor</a></td></tr>
116117
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
118+
</table><table class="memberdecls">
119+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
120+
Namespaces</h2></td></tr>
121+
<tr class="memitem:namespacehelib"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehelib.html">helib</a></td></tr>
122+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
117123
</table>
118124
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
119125
<div class="textblock"><p>Easier arg parsing. </p>

‎Documentation/HElib/html/_arg_map_8h_source.html‎

Lines changed: 31 additions & 21 deletions
Large diffs are not rendered by default.

‎Documentation/HElib/html/_benes_network_8cpp.html‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!-- HTML header for doxygen 1.8.8-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<!-- For Mobile Devices -->
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
9+
<meta name="generator" content="Doxygen 1.8.18"/>
10+
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11+
<title>HElib: /HElib/src/BenesNetwork.cpp File Reference</title>
12+
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
13+
<script type="text/javascript" src="dynsections.js"></script>
14+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="search/searchdata.js"></script>
16+
<script type="text/javascript" src="search/search.js"></script>
17+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
18+
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
19+
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
20+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;1,700&family=Merriweather&family=Merriweather+Sans&family=Open+Sans&family=Poppins:ital@1&family=Roboto:ital,wght@0,400;1,300;1,900&display=swap" rel="stylesheet">
21+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
22+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
23+
<link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
24+
<script type="text/javascript" src="jquery.smartmenus.js"></script>
25+
<!-- SmartMenus jQuery Bootstrap Addon -->
26+
<script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
27+
<!-- SmartMenus jQuery plugin -->
28+
</head>
29+
<body style="font-family: 'Merriweather', serif;">
30+
<nav class="navbar navbar-default" role="navigation">
31+
<div class="container">
32+
<div class="navbar-header">
33+
<a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
34+
</div>
35+
</div>
36+
</nav>
37+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38+
<div class="content" id="content">
39+
<div class="container">
40+
<div class="row">
41+
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
42+
<div style="margin-bottom: 15px;">
43+
<!-- end header part -->
44+
<!-- Generated by Doxygen 1.8.18 -->
45+
<script type="text/javascript">
46+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
47+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
48+
/* @license-end */
49+
</script>
50+
<script type="text/javascript" src="menudata.js"></script>
51+
<script type="text/javascript" src="menu.js"></script>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
54+
$(function() {
55+
initMenu('',true,false,'search.php','Search');
56+
$(document).ready(function() { init_search(); });
57+
});
58+
/* @license-end */</script>
59+
<div id="main-nav"></div>
60+
<!-- window showing the filter options -->
61+
<div id="MSearchSelectWindow"
62+
onmouseover="return searchBox.OnSearchSelectShow()"
63+
onmouseout="return searchBox.OnSearchSelectHide()"
64+
onkeydown="return searchBox.OnSearchSelectKey(event)">
65+
</div>
66+
67+
<!-- iframe showing the search results (closed by default) -->
68+
<div id="MSearchResultsWindow">
69+
<iframe src="javascript:void(0)" frameborder="0"
70+
name="MSearchResults" id="MSearchResults">
71+
</iframe>
72+
</div>
73+
74+
<div id="nav-path" class="navpath">
75+
<ul>
76+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
77+
</div>
78+
</div><!-- top -->
79+
<div class="header">
80+
<div class="summary">
81+
<a href="#namespaces">Namespaces</a> </div>
82+
<div class="headertitle">
83+
<div class="title">BenesNetwork.cpp File Reference</div> </div>
84+
</div><!--header-->
85+
<div class="contents">
86+
<div class="textblock"><code>#include &lt;NTL/lzz_pXFactoring.h&gt;</code><br />
87+
<code>#include &lt;<a class="el" href="_encrypted_array_8h_source.html">helib/EncryptedArray.h</a>&gt;</code><br />
88+
<code>#include &lt;cstdlib&gt;</code><br />
89+
<code>#include &lt;list&gt;</code><br />
90+
<code>#include &lt;sstream&gt;</code><br />
91+
<code>#include &lt;memory&gt;</code><br />
92+
<code>#include &lt;NTL/vector.h&gt;</code><br />
93+
<code>#include &lt;<a class="el" href="_numb_th_8h_source.html">helib/NumbTh.h</a>&gt;</code><br />
94+
<code>#include &lt;<a class="el" href="permutations_8h_source.html">helib/permutations.h</a>&gt;</code><br />
95+
</div><table class="memberdecls">
96+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
97+
Namespaces</h2></td></tr>
98+
<tr class="memitem:namespacehelib"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehelib.html">helib</a></td></tr>
99+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
100+
</table>
101+
</div><!-- contents -->
102+
<!-- HTML footer for doxygen 1.8.8-->
103+
<!-- start footer part -->
104+
</div>
105+
</div>
106+
</div>
107+
</div>
108+
</div>
109+
<hr class="footer"/><address class="footer"><small>
110+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
111+
<img class="footer" src="doxygen.png" alt="doxygen"/>
112+
</a> 1.8.18
113+
</small></address>
114+
</body>
115+
<script type="text/javascript" src="doxy-boot.js"></script>
116+
</html>

‎Documentation/HElib/html/_c_modulus_8cpp.html‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<!-- HTML header for doxygen 1.8.8-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<!-- For Mobile Devices -->
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
9+
<meta name="generator" content="Doxygen 1.8.18"/>
10+
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11+
<title>HElib: /HElib/src/CModulus.cpp File Reference</title>
12+
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
13+
<script type="text/javascript" src="dynsections.js"></script>
14+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="search/searchdata.js"></script>
16+
<script type="text/javascript" src="search/search.js"></script>
17+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
18+
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
19+
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
20+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;1,700&family=Merriweather&family=Merriweather+Sans&family=Open+Sans&family=Poppins:ital@1&family=Roboto:ital,wght@0,400;1,300;1,900&display=swap" rel="stylesheet">
21+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
22+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
23+
<link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
24+
<script type="text/javascript" src="jquery.smartmenus.js"></script>
25+
<!-- SmartMenus jQuery Bootstrap Addon -->
26+
<script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
27+
<!-- SmartMenus jQuery plugin -->
28+
</head>
29+
<body style="font-family: 'Merriweather', serif;">
30+
<nav class="navbar navbar-default" role="navigation">
31+
<div class="container">
32+
<div class="navbar-header">
33+
<a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
34+
</div>
35+
</div>
36+
</nav>
37+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38+
<div class="content" id="content">
39+
<div class="container">
40+
<div class="row">
41+
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
42+
<div style="margin-bottom: 15px;">
43+
<!-- end header part -->
44+
<!-- Generated by Doxygen 1.8.18 -->
45+
<script type="text/javascript">
46+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
47+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
48+
/* @license-end */
49+
</script>
50+
<script type="text/javascript" src="menudata.js"></script>
51+
<script type="text/javascript" src="menu.js"></script>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
54+
$(function() {
55+
initMenu('',true,false,'search.php','Search');
56+
$(document).ready(function() { init_search(); });
57+
});
58+
/* @license-end */</script>
59+
<div id="main-nav"></div>
60+
<!-- window showing the filter options -->
61+
<div id="MSearchSelectWindow"
62+
onmouseover="return searchBox.OnSearchSelectShow()"
63+
onmouseout="return searchBox.OnSearchSelectHide()"
64+
onkeydown="return searchBox.OnSearchSelectKey(event)">
65+
</div>
66+
67+
<!-- iframe showing the search results (closed by default) -->
68+
<div id="MSearchResultsWindow">
69+
<iframe src="javascript:void(0)" frameborder="0"
70+
name="MSearchResults" id="MSearchResults">
71+
</iframe>
72+
</div>
73+
74+
<div id="nav-path" class="navpath">
75+
<ul>
76+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
77+
</div>
78+
</div><!-- top -->
79+
<div class="header">
80+
<div class="summary">
81+
<a href="#namespaces">Namespaces</a> &#124;
82+
<a href="#func-members">Functions</a> </div>
83+
<div class="headertitle">
84+
<div class="title">CModulus.cpp File Reference</div> </div>
85+
</div><!--header-->
86+
<div class="contents">
87+
<div class="textblock"><code>#include &lt;<a class="el" href="_c_modulus_8h_source.html">helib/CModulus.h</a>&gt;</code><br />
88+
<code>#include &lt;<a class="el" href="timing_8h_source.html">helib/timing.h</a>&gt;</code><br />
89+
</div><table class="memberdecls">
90+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
91+
Namespaces</h2></td></tr>
92+
<tr class="memitem:namespacehelib"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehelib.html">helib</a></td></tr>
93+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
94+
</table><table class="memberdecls">
95+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
96+
Functions</h2></td></tr>
97+
<tr class="memitem:af02b70fdba8bb78c1f19964759f497b5"><td class="memItemLeft" align="right" valign="top">NTL::zz_pContext&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehelib.html#af02b70fdba8bb78c1f19964759f497b5">helib::BuildContext</a> (long p, long maxroot)</td></tr>
98+
<tr class="separator:af02b70fdba8bb78c1f19964759f497b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
99+
</table>
100+
</div><!-- contents -->
101+
<!-- HTML footer for doxygen 1.8.8-->
102+
<!-- start footer part -->
103+
</div>
104+
</div>
105+
</div>
106+
</div>
107+
</div>
108+
<hr class="footer"/><address class="footer"><small>
109+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
110+
<img class="footer" src="doxygen.png" alt="doxygen"/>
111+
</a> 1.8.18
112+
</small></address>
113+
</body>
114+
<script type="text/javascript" src="doxy-boot.js"></script>
115+
</html>

‎Documentation/HElib/html/_c_modulus_8h.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
99
<meta name="generator" content="Doxygen 1.8.18"/>
1010
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
11-
<title>HElib: include/helib/CModulus.h File Reference</title>
11+
<title>HElib: /HElib/include/helib/CModulus.h File Reference</title>
1212
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
1313
<script type="text/javascript" src="dynsections.js"></script>
1414
<link href="search/search.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
3030
<nav class="navbar navbar-default" role="navigation">
3131
<div class="container">
3232
<div class="navbar-header">
33-
<a class="navbar-brand">HElib </a>
33+
<a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
3434
</div>
3535
</div>
3636
</nav>
@@ -78,7 +78,8 @@
7878
</div><!-- top -->
7979
<div class="header">
8080
<div class="summary">
81-
<a href="#nested-classes">Classes</a> </div>
81+
<a href="#nested-classes">Classes</a> &#124;
82+
<a href="#namespaces">Namespaces</a> </div>
8283
<div class="headertitle">
8384
<div class="title">CModulus.h File Reference</div> </div>
8485
</div><!--header-->
@@ -98,6 +99,11 @@
9899
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_cmodulus.html">helib::Cmodulus</a></td></tr>
99100
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides FFT and iFFT routines modulo a single-precision prime. <a href="classhelib_1_1_cmodulus.html#details">More...</a><br /></td></tr>
100101
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
102+
</table><table class="memberdecls">
103+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
104+
Namespaces</h2></td></tr>
105+
<tr class="memitem:namespacehelib"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehelib.html">helib</a></td></tr>
106+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
101107
</table>
102108
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
103109
<div class="textblock"><p>Supports forward and backward length-m FFT transformations. </p>

0 commit comments

Comments
 (0)