v2.0.0 Release Docs Updates

* v2.0.0 Release Docs Updates

Co-authored-by: Hamish Hunt <hamishun@gmail.com>
Co-authored-by: Jack Crawford <jack.crawford@sky.com>

Author: 3 people

CHANGES.md

@@ -4,9 +4,10 @@ HElib 2.0.0, January 2021
 
 December-January 2021
 ---------------------
-* Changes to Context API
-* Must use ContextBuilder to build context
-* New serialization APIs: binary and JSON
+* Contains API changes that are not backwards compatible with v1.x.x
+  * Changes to Context API
+  * Must use ContextBuilder to build context
+  * New serialization APIs: binary and JSON
 * CKKS coding tutorials
 * Bug fixes
 

CONTRIBUTING.md

@@ -5,9 +5,9 @@ tests, designing and coding new examples or writing tutorials are all examples
 of helpful contributions. 
 
 A contribution to HElib can be initiated through GitHub pull request (PR).
-HElib is written in C++14 and uses `clang-format` for the formatting of the code.
-Requiremens and installation instructions can be found in [INSTALL.md](INSTALL.md).
-When making code contributions to HElib, we ask that you follow the `C++14` 
+HElib is written in C++17 and uses `clang-format` for the formatting of the code.
+Requirements and installation instructions can be found in [INSTALL.md](INSTALL.md).
+When making code contributions to HElib, we ask that you follow the `C++17` 
 coding standard and format your code using the [clang format](.clang-format) 
 style file included in this distribution. Please provide unit/regression 
 tests that are relevant to your code contribution. 
@@ -27,4 +27,3 @@ Whether you are contributing a new feature, updating or bug fixing the code else
 HElib test suite uses the [Google Test Framework](https://github.com/google/googletest). Additional information on HElib's test suite can be found in [TESTS.md](TESTS.md). Please remember to provide unit/regression tests that are relevant to your code contribution.
 
 Once all the tests have passed, and you are satisfied with your contribution, open a pull request into the `master` branch from **your fork of the repository** to request adding your contributions into the main code base.
-

README.md

@@ -1,7 +1,10 @@
 HElib
 =====
 
-[![Build Status](https://travis-ci.com/homenc/HElib.svg?branch=master)](https://travis-ci.com/homenc/HElib)
+<!--- Commenting travis banner out as we don't have access to the free tier anymore --->
+<!--- When and if the free tier is reinstated, we will put the banner back  --->
+<!--- Our releases are tested in 14 different configuration in a private DevOps environement   --->
+<!--- [![Build Status](https://travis-ci.com/homenc/HElib.svg?branch=master)](https://travis-ci.com/homenc/HElib) ---> 
 
 HElib is an open-source ([Apache License v2.0][5]) software library that
 implements [homomorphic encryption][6] (HE). Currently available schemes are the
@@ -13,7 +16,7 @@ packing techniques and the [Gentry-Halevi-Smart][3] optimizations. See [this
 report][7] for a description of a few of the algorithms using in this library.
 
 Please refer to [CKKS-security.md](CKKS-security.md) for the latest discussion
-on the security of the the CKKS scheme implementation in HElib.
+on the security of the CKKS scheme implementation in HElib.
 
 Since mid-2018 HElib has been under extensive refactoring for *Reliability*,
 *Robustness & Serviceability*, *Performance*, and most importantly *Usability*
@@ -23,7 +26,8 @@ HElib supports an *"assembly language for HE"*, providing low-level routines
 (set, add, multiply, shift, etc.), sophisticated automatic noise management,
 improved BGV bootstrapping, multi-threading, and also support for Ptxt
 (plaintext) objects which mimics the functionality of Ctxt (ciphertext) objects.
-See [CHANGES.md](CHANGES.md) for more details.
+The report [Design and implementation of HElib][11] contains additional details.
+Also, see [CHANGES.md](CHANGES.md) for more information on the HElib releases.
 
 Full installation instructions and a list of the required dependencies can be
 found in [INSTALL.md](INSTALL.md).
@@ -35,7 +39,7 @@ example programs and our CKKS tutorials located in the `examples` directory. See
 If you are interested in contributing to HElib, please read our
 [Contributing Guidelines](CONTRIBUTING.md).
 
-HElib is written in C++14 and uses the [NTL mathematical library][4].  
+HElib is written in C++17 and uses the [NTL mathematical library][4].  
 HElib is distributed under the terms of the [Apache License v2.0][5].  
 
   [1]: http://eprint.iacr.org/2011/277       "BGV12"
@@ -48,3 +52,5 @@ HElib is distributed under the terms of the [Apache License v2.0][5].
   [8]: http://eprint.iacr.org/2014/873       "bootstrapping"
   [9]: http://eprint.iacr.org/2016/421       "CKKS16"
   [10]: https://github.com/homenc/HElib      "GitHubPages"
+  [11]: https://eprint.iacr.org/2020/1481    "HElib Design"
+  

examples/README.md

@@ -2,17 +2,20 @@
 
 ## Introduction
 
-The `examples` directory provides standalone example programs expressing the
-various APIs as well as a simple use-case using HElib. The example programs
-provided currently only use the BGV scheme.
+The `examples` directory contains tutorials and standalone example programs
+expressing the various APIs as well as a simple use-case using HElib. 
 
 ## What is provided
 
-Currently the examples provided comprise:
+The [tutorials](tutorial/) cover primarily the CKKS scheme and comprise 8 documented examples 
+from basic operations to more complex serialization. 
 
-- BGV_binary_arithmetic
-- BGV_country_db_lookup
-- BGV_packed_arithmetic
+
+The example programs provided use the BGV scheme and comprise:
+
+- [BGV_binary_arithmetic](BGV_binary_arithmetic)
+- [BGV_country_db_lookup](BGV_country_db_lookup)
+- [BGV_packed_arithmetic](BGV_packed_arithmetic)
 
 More examples are expected to be released at a later date.
 

include/helib/NumbTh.h

@@ -892,16 +892,7 @@ inline void TofftRep_trunc(NTL::fftRep& y,
 }
 #endif
 
-#if 0
-//! @brief stand-in for make_unique, which is C++14, not C++11
-template<typename T, typename... Args>
-std::unique_ptr<T> build_unique(Args&&... args)
-{
-    return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
-}
-#endif
-
-// Generic routines for domputing absolute values and distances
+// Generic routines for computing absolute values and distances
 // on real and complex numbers
 
 template <typename T>