Skip to content

Commit 0232d60

Browse files
authoredJan 19, 2021
v2.0.0 Release Docs Updates
* Doxygen Docs Updates
1 parent 5fe2a8a commit 0232d60

File tree

4 files changed

+15
-10
lines changed

4 files changed

+15
-10
lines changed
 

‎CHANGES.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
Release Changes
2+
===============
3+
14
HElib 2.0.0, January 2021
25
=========================
36
(tagged as v2.0.0)
47

5-
December-January 2021
6-
---------------------
78
* Contains API changes that are not backwards compatible with v1.x.x
89
* Changes to Context API
910
* Must use ContextBuilder to build context

‎documentation/Doxyfile

+3
Original file line numberDiff line numberDiff line change
@@ -827,12 +827,15 @@ INPUT = ./mainpage.dox \
827827
../CONTRIBUTING.md \
828828
../CODE_OF_CONDUCT.md \
829829
../LICENSE.md \
830+
../CHANGES.md \
830831
../INSTALL.md \
831832
../TESTS.md \
833+
../examples/README.md \
832834
../include/helib \
833835
../src \
834836
../utils \
835837
../misc/psi \
838+
../CKKS-security.md \
836839
../ISSUES.md
837840

838841
# This tag can be used to specify the character encoding of the source files

‎documentation/mainpage.dox

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22
@mainpage HElib Documentation
33

44
HElib is an open-source (<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>)
5-
software library that implements homomorphic encryption (HE).
5+
software library that implements <a href="http://en.wikipedia.org/wiki/Homomorphic_encryption">homomorphic encryption</a> (HE).
66
Currently available schemes are the implementations of the
7-
<a href="http://eprint.iacr.org/2011/277">Brakerski-Gentry-Vaikuntanathan</a> (BGV) scheme and the Approximate Number
7+
<a href="http://eprint.iacr.org/2011/277">Brakerski-Gentry-Vaikuntanathan</a> (BGV) scheme with bootstrapping and the Approximate Number
88
scheme of <a href="http://eprint.iacr.org/2016/421">Cheon-Kim-Kim-Song</a> (CKKS), along with many
99
optimizations to make homomorphic evaluation runs faster, focusing mostly on
1010
effective use of the <a href="http://eprint.iacr.org/2011/133">Smart-Vercauteren</a> ciphertext packing techniques and
11-
the <a href="http://eprint.iacr.org/2012/099">Gentry-Halevi-Smart</a> optimizations.
11+
the <a href="http://eprint.iacr.org/2012/099">Gentry-Halevi-Smart</a> optimizations.
12+
13+
Please refer to <a href="https://github.com/homenc/HElib/blob/master/CKKS-security.md">CKKS-security.md</a> for the latest discussion on the security of the CKKS scheme implementation in HElib.
1214

1315
Articles that describe some aspects of HElib include:
1416

15-
- <a href="https://homenc.github.io/HElib/documentation/Design_Document/HElib-design.pdf">HElib Design Principles</a>, Shai Halevi and Victor Shoup, August 2020.
17+
- <a href="https://eprint.iacr.org/2020/1481">HElib Design Principles</a>, Shai Halevi and Victor Shoup, November 2020.
1618
- <a href="http://eprint.iacr.org/2014/106">Algorithms in HElib</a>, Shai Halevi and Victor Shoup, published in <a href="http://www.iacr.org/conferences/crypto2014/">CRYPTO 2014</a>.
1719
- <a href="http://eprint.iacr.org/2014/873">Bootstrapping for HElib</a>, Shai Halevi and Victor Shoup, <a href="https://www.cosic.esat.kuleuven.be/eurocrypt_2015/">EUROCRYPT 2015</a>.
1820

@@ -24,12 +26,11 @@ HElib supports an <b>"assembly language for HE"</b>, providing low-level routine
2426
(set, add, multiply, shift, etc.), sophisticated automatic noise management,
2527
improved BGV bootstrapping, multi-threading, and also support for Ptxt (plaintext)
2628
objects which mimics the functionality of Ctxt (ciphertext) objects.
27-
See <a href="https://github.com/homenc/HElib/changes.md">changes.md</a> for more details.
2829

29-
HElib is written in C++14 and uses the <a href="http://www.shoup.net/ntl/">NTL</a> mathematical library.
30+
HElib is written in C++17 and uses the <a href="http://www.shoup.net/ntl/">NTL</a> mathematical library.
3031

3132
HElib is distributed under the terms of the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.
3233

33-
For code downloads and full installation instructions, visit <a href="https://github.com/homenc/HElib">HElib GitHub Pages</a>.
34+
For code downloads, full installation instructions, example programs and tutorials, visit <a href="https://github.com/homenc/HElib">HElib GitHub Pages</a>.
3435

3536
**/

‎examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Examples
1+
# Examples and Tutorials
22

33
## Introduction
44

0 commit comments

Comments
 (0)
Please sign in to comment.