HElib v2.0.x release updates

HElib v2.0.x release updates
- Documentation Updates
- Build and Test DevOps pipeline updates

Author: faberga

.travis.yml

@@ -93,7 +93,9 @@ addons:
     - cmake
     - bats-core
     - ccache
-    update: true
+#    update: true
+# Uncomment this line if the latest update of homebrew is required.  This will
+# increase the overall build time of each platform.
 
 # activating ccache on MacOS.
 before_install:

README.md

@@ -1,10 +1,7 @@
 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) ---> 
+[![Build Status](https://travis-ci.com/IBM-HElib/HElib.svg?branch=master)](https://travis-ci.com/IBM-HElib/HElib)
 
 HElib is an open-source ([Apache License v2.0][5]) software library that
 implements [homomorphic encryption][6] (HE). Currently available schemes are the

ci/install_deps.sh

@@ -19,7 +19,7 @@ if [ "${PACKAGE_BUILD}" == "OFF" ]; then
   if [ "${TRAVIS_OS_NAME}" == "linux" ]; then
     if [ "${TRAVIS_DIST}" == "bionic" ]; then
       sudo apt-get -yq --no-install-suggests --no-install-recommends $(travis_apt_get_options) install m4 libgmp-dev
-      curl -O "https://www.shoup.net/ntl/ntl-11.4.3.tar.gz"
+      curl -O "https://libntl.org/ntl-11.4.3.tar.gz"
       tar --no-same-owner -xf ntl-11.4.3.tar.gz
       cd "$HOME/ntl-11.4.3/src"
       ./configure SHARED=on NTL_GMP_LIP=on NTL_THREADS=on NTL_THREAD_BOOST=on

documentation/Design_Document/HElib-design.pdf

@@ -607,6 +607,9 @@ class Ctxt
    * @brief Times equals operator with a `ZZX`.
    * @param poly Element by which to multiply.
    * @return Reference to `*this` post multiplication.
+   * @deprecated This function is deprecated in favor of a new
+   * `EncodedPtxt`-based API.\n
+   * Please use `Ctxt::operator*=(const EncodedPtxt& ptxt)` instead.
    **/
   // [[deprecated]]
   Ctxt& operator*=(const NTL::ZZX& poly);
@@ -648,34 +651,60 @@ class Ctxt
   }
 
   //! add a rational number in the form a/b, a,b are long
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(double ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(std::pair</*numerator=*/long, /*denominator=*/long>);
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(double ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(double x)
   { // FIXME: not enough precision when x is large
     addConstantCKKS(
         rationalApprox(x, /*denomBound=*/1L << getContext().getAlMod().getR()));
   }
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(const FatEncodedPtxt& ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(const DoubleCRT& dcrt,
                        NTL::xdouble size = NTL::xdouble(-1.0),
                        NTL::xdouble factor = NTL::xdouble(-1.0));
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(const EncodedPtxt& ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(const NTL::ZZX& poly,
                        NTL::xdouble size = NTL::xdouble(-1.0),
                        NTL::xdouble factor = NTL::xdouble(-1.0));
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(const PtxtArray& ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(const std::vector<std::complex<double>>& ptxt);
 
   /**
    * @brief Add a `CKKS` plaintext to this `Ctxt`.
    * @param ptxt Plaintext `Ptxt` object with which to add.
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(const PtxtArray& ptxt)` instead.
    **/
   // [[deprecated]]
   void addConstantCKKS(const Ptxt<CKKS>& ptxt);
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator+=(const NTL::ZZ& ptxt)` instead.
+   **/
   // [[deprecated]]
   void addConstantCKKS(const NTL::ZZ& c);
 
@@ -1061,6 +1090,10 @@ class Ctxt
   }
 
   //! multiply by a rational number or floating point
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(double ptxt)` instead.
+   **/
   // [[deprecated]]
   void multByConstantCKKS(double x)
   {
@@ -1082,18 +1115,30 @@ class Ctxt
       this->negate();
   }
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(double ptxt)` instead.
+   **/
   // [[deprecated]]
   void multByConstantCKKS(std::pair<long, long> num) // rational number
   {
     multByConstantCKKS(double(num.first) / num.second);
   }
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(const FatEncodedPtxt& ptxt)` instead.
+   **/
   // [[deprecated]]
   void multByConstantCKKS(const DoubleCRT& dcrt,
                           NTL::xdouble size = NTL::xdouble(-1.0),
                           NTL::xdouble factor = NTL::xdouble(-1.0),
                           double roundingErr = -1.0);
 
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(const EncodedPtxt& ptxt)` instead.
+   **/
   // [[deprecated]]
   void multByConstantCKKS(const NTL::ZZX& poly,
                           NTL::xdouble size = NTL::xdouble(-1.0),
@@ -1109,9 +1154,15 @@ class Ctxt
   /**
    * @brief Multiply a `CKKS` plaintext to this `Ctxt`.
    * @param ptxt Plaintext `Ptxt` object polynomial with which to multiply.
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(const PtxtArray& ptxt)` instead.
    **/
   // [[deprecated]]
   void multByConstantCKKS(const Ptxt<CKKS>& ptxt);
+  /**
+   * @deprecated This function is deprecated in favor of a newer API.
+   * Please use `Ctxt::operator*=(const PtxtArray& ptxt)` instead.
+   **/
   // [[deprecated]]
   void multByConstantCKKS(const std::vector<std::complex<double>>& ptxt);
 
@@ -1339,7 +1390,10 @@ class Ctxt
     return 0; // just to keep the compiler happy
   }
 
-  //! @brief Returns log(noiseBound) - log(q)
+  /**
+   * @brief Returns log(noiseBound) - log(q)
+   * @deprecated This is deprecated. Please use `Ctxt::capacity()` instead.
+   **/
   // [[deprecated]] // use capacity()
   double log_of_ratio() const
   {