Merge pull request #1017 from openfheorg/dev

Update to v1.3.1

Author: dsuponitskiy

CMakeLists.txt

@@ -27,7 +27,7 @@ project (OpenFHE C CXX)
 
 set(OPENFHE_VERSION_MAJOR 1)
 set(OPENFHE_VERSION_MINOR 3)
-set(OPENFHE_VERSION_PATCH 0)
+set(OPENFHE_VERSION_PATCH 1)
 set(OPENFHE_VERSION ${OPENFHE_VERSION_MAJOR}.${OPENFHE_VERSION_MINOR}.${OPENFHE_VERSION_PATCH})
 
 set(CMAKE_CXX_STANDARD 17)
@@ -207,8 +207,14 @@ set(OpenFHE_PACKAGE_LIBS ${OpenFHE_STATIC_LIBS} ${OpenFHE_SHARED_LIBS})
 # Installation logic
 #--------------------------------------------------------------------
 ### set up for install
+# include(GNUInstallDirs)
+
 set(INSTALL_LIB_DIR lib CACHE PATH "Installation directory for libraries")
 set(INSTALL_INCLUDE_DIR include/openfhe CACHE PATH "Installation directory for headers")
+if(NOT IS_ABSOLUTE "${INSTALL_INCLUDE_DIR}")
+    set(INSTALL_INCLUDE_DIR "${CMAKE_INSTALL_PREFIX}/${INSTALL_INCLUDE_DIR}")
+endif()
+
 if(WIN32 AND NOT CYGWIN)
     set(DEF_INSTALL_CMAKE_DIR CMake)
 else()
@@ -717,19 +723,16 @@ export(EXPORT OpenFHETargets FILE "${PROJECT_BINARY_DIR}/OpenFHETargets.cmake")
 export(PACKAGE OpenFHE)
 
 # Create the OpenFHEConfig.cmake and OpenFHEConfigVersion files
-file(RELATIVE_PATH REL_INCLUDE_DIR "${INSTALL_CMAKE_DIR}"
-   "${INSTALL_INCLUDE_DIR}")
+file(RELATIVE_PATH REL_INCLUDE_DIR "${INSTALL_CMAKE_DIR}" "${INSTALL_INCLUDE_DIR}")
 # ... for the build tree
 set(CONF_INCLUDE_DIRS "${PROJECT_SOURCE_DIR}" "${PROJECT_BINARY_DIR}")
-configure_file(OpenFHEConfig.cmake.in
-  "${PROJECT_BINARY_DIR}/OpenFHEConfig.cmake" @ONLY)
+configure_file(OpenFHEConfig.cmake.in "${PROJECT_BINARY_DIR}/OpenFHEConfig.cmake" @ONLY)
 # ... for the install tree
 set(CONF_INCLUDE_DIRS "\${OpenFHE_CMAKE_DIR}/${REL_INCLUDE_DIR}")
-configure_file(OpenFHEConfig.cmake.in
-  "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/OpenFHEConfig.cmake" @ONLY)
+# set(CONF_INCLUDE_DIRS "\${OpenFHE_CMAKE_DIR}/../../include/openfhe") # supposed to be relocatable?
+configure_file(OpenFHEConfig.cmake.in "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/OpenFHEConfig.cmake" @ONLY)
 # ... for both
-configure_file(OpenFHEConfigVersion.cmake.in
-  "${PROJECT_BINARY_DIR}/OpenFHEConfigVersion.cmake" @ONLY)
+configure_file(OpenFHEConfigVersion.cmake.in "${PROJECT_BINARY_DIR}/OpenFHEConfigVersion.cmake" @ONLY)
 
 # Install the OpenFHEConfig.cmake and OpenFHEConfigVersion.cmake
 install(FILES
@@ -738,5 +741,5 @@ install(FILES
   DESTINATION "${INSTALL_CMAKE_DIR}" COMPONENT dev)
 
 # Install the export set for use with the install-tree
-install(EXPORT OpenFHETargets DESTINATION
-  "${INSTALL_CMAKE_DIR}" COMPONENT dev)
+install(EXPORT OpenFHETargets DESTINATION "${INSTALL_CMAKE_DIR}" COMPONENT dev)
+# install(EXPORT OpenFHETargets DESTINATION "${INSTALL_CMAKE_DIR}" NAMESPACE OpenFHE:: COMPONENT dev)

OpenFHEConfig.cmake.in

@@ -10,6 +10,8 @@ if(NOT OpenFHE_BINARY_DIR)
 endif()
 
 # These are IMPORTED targets created by OpenFHETargets.cmake
+# set(OpenFHE_INCLUDE "${OpenFHE_CMAKE_DIR}/../../include/openfhe")
+# set(OpenFHE_LIBDIR "${OpenFHE_CMAKE_DIR}/../../lib")
 set(OpenFHE_INCLUDE "@INSTALL_INCLUDE_DIR@")
 set(OpenFHE_LIBDIR "@INSTALL_LIB_DIR@")
 set(OpenFHE_LIBRARIES @OpenFHE_PACKAGE_LIBS@ @THIRDPARTYLIBS@ @OpenMP_CXX_FLAGS@)

README.md

@@ -78,9 +78,9 @@ To get familiar with the main API of OpenFHE, we recommend looking at the code o
        1. [Examples with Scheme Switching between CKKS and FHEW/TFHE](src/pke/examples/scheme-switching.cpp)
    1. Threshold FHE:
        1. [Code Example for BGV, BFV, and CKKS](src/pke/examples/threshold-fhe.cpp)
-       1. [$2$-party Interactive Bootstrapping Examples](src/pke/examples/interactive-bootstrapping.cpp)
-       1. [Simple $n$-party Interactive Bootstrapping Example](src/pke/examples/tckks-interactive-mp-bootstrapping.cpp)
-       1. [$n$-party Interactive Bootstrapping after Chebyshev Approximation](src/pke/examples/tckks-interactive-mp-bootstrapping-Chebyshev.cpp)
+       1. [2-party Interactive Bootstrapping Examples](src/pke/examples/interactive-bootstrapping.cpp)
+       1. [Simple n-party Interactive Bootstrapping Example](src/pke/examples/tckks-interactive-mp-bootstrapping.cpp)
+       1. [n-party Interactive Bootstrapping after Chebyshev Approximation](src/pke/examples/tckks-interactive-mp-bootstrapping-Chebyshev.cpp)
        1. [Code Example for BFV with 5 parties](src/pke/examples/threshold-fhe-5p.cpp)
 
 ## Main API

docs/sphinx_rsts/misc/contributors.rst

@@ -55,6 +55,8 @@ We gratefully acknowledge intellectual and software contributions to the library
 
 * Kevin King (Massachusetts Institute of Technology)
 
+* Jeremy Kun (Google)
+
 * Yongwoo Lee (Samsung Advanced Institute of Technology, Inha University)
 
 * Thomas (Zeyu) Liu (Duality Technologies, Columbia University, Yale University)
@@ -109,6 +111,8 @@ We gratefully acknowledge intellectual and software contributions to the library
 
 * Michael Walter (University of California San Diego)
 
+* Hongren Zheng (Tsinghua University)
+
 * Vincent Zucca (Universite de Perpignan Via Domitia, LIRMM, University of Montpellier, KU Leuven)
 
 **Note.** We have attempted to make an as inclusive a list as possible to identify contributors, but we may of forgotten some important contributors.  Any oversights are unintentional.  If we neglected to identify your contribution, please let us know and we'll update our listing.  If you are on the list of contributors and you'd prefer not to be, please let us know and we'll similarly update our list.

docs/static_docs/Release_Notes.md

@@ -1,3 +1,13 @@
+07/11/2025: OpenFHE 1.3.1 (stable) is released
+
+* Updates the noise estimation models for BGV and BFV, making them slightly more conservative (roughly 1 extra bit is added for each multiplicative level) (#1004)
+* Removes extra rotation indices in CKKS bootstrapping (#998)
+* Fixes a bug with CKKS bootstrapping for N=2^17 (#996)
+* Improves exception handling
+* Fixes several other bugs
+
+The detailed list of changes is available at https://github.com/openfheorg/openfhe-development/issues?q=is%3Aissue+milestone%3A%22Release+1.3.1%22
+
 05/21/2025: OpenFHE 1.3.0 (development) is released
 
 * Adds the composite scaling modes to CKKS based on https://eprint.iacr.org/2023/1462 (see https://github.com/openfheorg/openfhe-development/blob/main/src/pke/examples/COMPOSITE_SCALING.md for more details)

src/core/include/lattice/hal/default/dcrtpoly-impl.h

@@ -1696,15 +1696,14 @@ void DCRTPolyImpl<VecType>::ScaleAndRoundPOverQ(const std::shared_ptr<Params>& p
                                                 const std::vector<NativeInteger>& pInvModq) {
     m_params = paramsQ;
 
-    const uint32_t sizeQ   = m_vectors.size() - 1;
-    const auto& q          = m_params->GetParams();
-    const uint32_t ringDim = m_params->GetRingDimension();
+    const uint32_t sizeQ = m_vectors.size() - 1;
+    const auto& lastPoly = m_vectors.back();
 
 #pragma omp parallel for num_threads(OpenFHEParallelControls.GetThreadLimit(sizeQ))
     for (uint32_t i = 0; i < sizeQ; ++i) {
-        const auto& qi = q[i]->GetModulus();
-        for (uint32_t ri = 0; ri < ringDim; ++ri)
-            m_vectors[i][ri].ModSubEq(m_vectors[sizeQ][ri], qi);
+        auto tmp = lastPoly;
+        tmp.SwitchModulus(m_vectors[i].GetModulus(), m_vectors[i].GetRootOfUnity(), 0, 0);
+        m_vectors[i] -= tmp;
         m_vectors[i] *= pInvModq[i];
     }
     m_vectors.resize(sizeQ);

src/core/include/utils/memory.h

@@ -38,6 +38,7 @@
 
 #include <cstdint>
 #include <cstddef>
+#include <iterator>
 #include <utility>
 #include <vector>
 

src/core/lib/math/discretegaussiangeneratorgeneric.cpp

@@ -47,6 +47,7 @@
 #include "utils/exception.h"
 #include "utils/inttypes.h"
 
+#include <algorithm>
 #include <cmath>
 #include <memory>
 #include <random>

src/core/lib/utils/demangle.cpp

@@ -29,7 +29,9 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 //==================================================================================
 #include "utils/demangle.h"
-#include <memory>
+
+#include <cstdlib>
+#include <string>
 
 #if defined(__clang__) || defined(__GNUC__)
     #include <cxxabi.h>

src/core/lib/utils/get-call-stack.cpp

@@ -34,8 +34,9 @@
 // clang-format off
 #include "utils/demangle.h"
 
-#include <execinfo.h>
+#include <cstdlib>
 #include <cxxabi.h>
+#include <execinfo.h>
 #include <memory>
 // clang-format on