HElib v1.1.0 (#380)

HElib 1.1.0 Beta 0, August 2020
===============================
(tagged as v1.1.0-beta.0)

June-August 2020
------------------
* Utils
  * create-context
  * encrypt/decrypt
  * encode/decode examples
* Improvements to noise management
* Move to CMake >= 3.10.2
* Doxygen improved look and feel
* Improved docs
* New examples and mini-tutorial on private preserving db query
* Configurable PSI/PIR beta
* Some tools in `misc/` for code formatting and algebra generation
* `Warning` messages are now logged (default `helib.log`)
* Bug fixes

Co-authored-by: Hamish C Hunt <HAMISHUN@uk.ibm.com>
Co-authored-by: Jack L Crawford <Jack.Crawford@ibm.com>

Author: 3 people

changes.md CHANGES.md

@@ -1,3 +1,23 @@
+HElib 1.1.0, August 2020
+===============================
+(tagged as v1.1.0)
+
+June-August 2020
+------------------
+* Utils
+  * create-context
+  * encrypt/decrypt
+  * encode/decode examples
+* Improvements to noise management
+* Move to CMake >= 3.10.2
+* Doxygen improved look and feel
+* Improved docs
+* New examples and mini-tutorial on private preserving db query
+* Configurable PSI/PIR beta
+* Some tools in `misc/` for code formatting and algebra generation
+* `Warning` messages are now logged (default `helib.log`)
+* Bug fixes
+
 HElib 1.0.2, June 2020
 ===============================
 (tagged as v1.0.2)

ISSUES.md

@@ -0,0 +1,10 @@
+# Known Issues
+
+These issues listed below are known to be current and are expected to be
+addressed. 
+
+The function in BinaryArith `fifteenOrLess4Four` is known to not be currently
+thread safe. Therefore set NTL's thread pool to 1 to avoid this issue.  The
+function `NTL::SetNumThreads` can be used to set the number of threads in the
+pool and `NTL::AvailableThreads` gives the current available threads in the
+pool.

LICENSE LICENSE.md

@@ -1,3 +1,6 @@
+# LICENSE
+
+```
 
                                  Apache License
                            Version 2.0, January 2004
@@ -200,3 +203,5 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
+
+```

TESTS.md

@@ -1,5 +1,6 @@
 # Building and running the new tests
-1. To build and run the new tests, one must pass `-DENABLE_TEST=on` to cmake -
+
+To build and run the new tests, one must pass `-DENABLE_TEST=on` to cmake -
 see [INSTALL.md](INSTALL.md).  The google test library will then be downloaded
 and the correct targets will be defined for cmake.  2. To compile them, `make`
 as normal from a build directory.  3. The entire set of tests  can be run with

doc/Readme.md

@@ -698,14 +698,14 @@ MAX_INITIALIZER_LINES  = 30
 # list will mention the files that were used to generate the documentation.
 # The default value is: YES.
 
-SHOW_USED_FILES        = YES
+SHOW_USED_FILES        = NO
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
 # will remove the Files entry from the Quick Index and from the Folder Tree View
 # (if specified).
 # The default value is: YES.
 
-SHOW_FILES             = YES
+SHOW_FILES             = NO
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
 # page. This will remove the Namespaces entry from the Quick Index and from the
@@ -824,9 +824,16 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = ./mainpage.dox \
+                         ../CONTRIBUTING.md \
+                         ../CODE_OF_CONDUCT.md \
+                         ../LICENSE.md \
+                         ../INSTALL.md \
+                         ../TESTS.md \
                          ../include/helib \
                          ../src \
-                         ../examples/*
+                         ../utils \
+                         ../misc/psi \
+                         ../ISSUES.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/designDocument/HElibrary.pdf documentation/Design_Document/HElibrary.pdf

@@ -9,6 +9,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License. See accompanying LICENSE file.
  */
+
+// This is a sample program for education purposes only.
+// It attempts to demonstrate the use of the API for the
+// binary arithmetic operations that can be performed.
+
 #include <iostream>
 
 #include <helib/helib.h>
@@ -44,15 +49,32 @@ int main(int argc, char* argv[])
   // Orders of the previous generators.
   std::vector<long> ords = {6, 4, 6};
 
+  std::cout << "\n*********************************************************";
+  std::cout << "\n*            Basic Binary Arithmetic Example            *";
+  std::cout << "\n*            ===============================            *";
+  std::cout << "\n*                                                       *";
+  std::cout << "\n* This is a sample program for education purposes only. *";
+  std::cout << "\n* It attempts to demonstrate the use of the API for the *";
+  std::cout << "\n* binary arithmetic operations that can be performed.   *";
+  std::cout << "\n*                                                       *";
+  std::cout << "\n*********************************************************";
+  std::cout << std::endl;
+
   std::cout << "Initialising context object..." << std::endl;
   // Initialize the context.
+  // This object will hold information about the algebra created from the
+  // previously set parameters.
   helib::Context context(m, p, r, gens, ords);
 
   // Modify the context, adding primes to the modulus chain.
+  // This defines the ciphertext space.
   std::cout << "Building modulus chain..." << std::endl;
   buildModChain(context, bits, c);
 
   // Make bootstrappable.
+  // Modify the context, providing bootstrapping capabilities.
+  // Boostrapping has the affect of 'refreshing' a ciphertext back to a higher
+  // level so more operations can be performed.
   context.makeBootstrappable(
       helib::convert<NTL::Vec<long>, std::vector<long>>(mvec));
 
@@ -94,9 +116,17 @@ int main(int argc, char* argv[])
   // the result.
   // Next, calculate a + b + c with HElib's binary arithmetic functions, then
   // decrypt the result.
-  // Finally, calculate popcnt(a) with HElib's binary arithmetic functions, then
-  // decrypt the result.  Note that popcnt, also known as hamming weight or bit
-  // summation, returns the count of non-zero bits.
+  // Finally, calculate popcnt(a) with HElib's binary arithmetic functions,
+  // then decrypt the result.  Note that popcnt, also known as hamming weight
+  // or bit summation, returns the count of non-zero bits.
+
+  // Each bit of the binary number is encoded into a single ciphertext. Thus
+  // for a 16 bit binary number, we will represent this as an array of 16
+  // unique ciphertexts.
+  // i.e. b0 = [0] [0] [0] ... [0] [0] [0]        ciphertext for bit 0
+  //      b1 = [1] [1] [1] ... [1] [1] [1]        ciphertext for bit 1
+  //      b2 = [1] [1] [1] ... [1] [1] [1]        ciphertext for bit 2
+  // These 3 ciphertexts represent the 3-bit binary number 110b = 6
 
   // Note: several numbers can be encoded across the slots of each ciphertext
   // which would result in several parallel slot-wise operations.
@@ -153,8 +183,8 @@ int main(int argc, char* argv[])
       product_wrapper,
       helib::CtPtrs_vectorCt(encrypted_a),
       helib::CtPtrs_vectorCt(encrypted_b),
-      /*rhsTwosComplement=*/false, // This means the rhs is unsigned rather than
-                                   // 2's complement.
+      /*rhsTwosComplement=*/false, // This means the rhs is unsigned rather
+                                   // than 2's complement.
       outSize, // Outsize is the limit on the number of bits in the output.
       &unpackSlotEncoding); // Information needed for bootstrapping.
 

doc/designDocument/HElibrary.pptx documentation/Design_Document/HElibrary.pptx

@@ -20,7 +20,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 project(BGV_binary_arithmetic LANGUAGES CXX)
 
-find_package(helib 1.0.0 EXACT REQUIRED)
+find_package(helib 1.1.0 EXACT REQUIRED)
 
 add_executable(BGV_binary_arithmetic BGV_binary_arithmetic.cpp)