From f0b83d78e4983e672ddf5ec785912ba613ecb9e8 Mon Sep 17 00:00:00 2001 From: hamishun <60481960+hamishun@users.noreply.github.com> Date: Thu, 24 Dec 2020 10:51:27 +0000 Subject: [PATCH 1/8] Serialization 2.0 * Major changes to Context API * New serialization APIs for JSON and binary * CKKS tutorials Co-authored-by: Enrico Steffinlongo Co-authored-by: Jack Crawford Co-authored-by: Victor Shoup --- CHANGES.md | 12 + CMakeLists.txt | 12 + INSTALL.md | 176 +- README.md | 45 +- VERSION | 1 + benchmarks/CMakeLists.txt | 11 +- benchmarks/IO.cpp | 254 + benchmarks/bgv_common.h | 31 +- benchmarks/bgv_fatboot.cpp | 30 +- benchmarks/bgv_thinboot.cpp | 29 +- benchmarks/ckks_common.h | 21 +- dependencies/json/json.hpp | 25447 ++++++++++++++++ .../BGV_binary_arithmetic.cpp | 28 +- .../BGV_country_db_lookup.cpp | 19 +- .../BGV_packed_arithmetic.cpp | 16 +- examples/CMakeLists.txt | 8 +- examples/README.md | 56 +- examples/tests/BGV_packed_arithmetic.bats | 4 +- examples/tests/std.bash | 5 + examples/tutorial/01_ckks_basics.cpp | 229 + examples/tutorial/02_ckks_depth.cpp | 140 + examples/tutorial/03_ckks_data_movement.cpp | 153 + examples/tutorial/04_ckks_matmul.cpp | 171 + examples/tutorial/05_ckks_multlowlvl.cpp | 129 + examples/tutorial/06_ckks_serialization.cpp | 98 + examples/tutorial/07_ckks_deserialization.cpp | 238 + examples/tutorial/CMakeLists.txt | 26 + include/helib/Context.h | 794 +- include/helib/Ctxt.h | 209 +- include/helib/DoubleCRT.h | 66 +- include/helib/EncodedPtxt.h | 3 +- include/helib/EncryptedArray.h | 26 +- include/helib/IndexSet.h | 52 +- include/helib/JsonWrapper.h | 28 + include/helib/NumbTh.h | 47 - include/helib/PAlgebra.h | 2 +- include/helib/PolyMod.h | 111 +- include/helib/Ptxt.h | 201 +- include/helib/binio.h | 136 - include/helib/helib.h | 2 + include/helib/keySwitching.h | 68 +- include/helib/keys.h | 147 +- include/helib/matmul.h | 4 +- include/helib/partialMatch.h | 10 +- include/helib/permutations.h | 1 + include/helib/randomMatrices.h | 4 +- include/helib/recryption.h | 11 +- include/helib/scheme.h | 10 + include/helib/set.h | 2 +- include/helib/version.in.h | 2 +- misc/format.sh | 1 + misc/psi/CMakeLists.txt | 7 +- misc/psi/README.md | 35 +- misc/psi/lookup/CMakeLists.txt | 7 +- misc/psi/scoring/CMakeLists.txt | 7 +- misc/psi/tests/gen-expected-mask.py | 12 +- misc/psi/tests/gen-params.batx | 15 +- misc/psi/tests/lookup.bats | 6 +- misc/psi/tests/scoring.bats | 6 +- src/CMakeLists.txt | 16 +- src/Context.cpp | 1127 +- src/Ctxt.cpp | 444 +- src/DoubleCRT.cpp | 205 +- src/EncryptedArray.cpp | 1 - src/IndexSet.cpp | 92 +- src/JsonWrapper.cpp | 47 + src/NumbTh.cpp | 132 - src/PolyMod.cpp | 103 +- src/Ptxt.cpp | 281 +- src/binaryArith.cpp | 4 +- src/binio.cpp | 46 +- src/binio.h | 235 + src/debugging.cpp | 5 +- src/extractDigits.cpp | 4 +- src/io.cpp | 83 + src/io.h | 210 + src/keySwitching.cpp | 155 +- src/keys.cpp | 520 +- src/matmul.cpp | 24 +- src/permutations.cpp | 2 +- src/powerful.cpp | 10 +- src/primeChain.cpp | 521 +- src/recryption.cpp | 108 +- src/sample.cpp | 29 +- src/tableLookup.cpp | 2 +- src/tapprox.cpp | 2 +- tests/CMakeLists.txt | 19 +- tests/GTestApproxNums.cpp | 21 +- tests/GTestBinIO.cpp | 420 - tests/GTestBinaryArith.cpp | 49 +- tests/GTestBinaryCompare.cpp | 28 +- tests/GTestBootstrapping.cpp | 44 +- tests/GTestEaCx.cpp | 9 +- tests/GTestEvalMap.cpp | 54 +- tests/GTestExtractDigits.cpp | 16 +- tests/GTestFatboot.cpp | 62 +- tests/GTestGeneral.cpp | 39 +- tests/GTestIO.cpp | 359 - tests/GTestIntraSlot.cpp | 24 +- tests/GTestMatmul.cpp | 33 +- tests/GTestPAlgebra.cpp | 22 +- tests/GTestPolyEval.cpp | 14 +- tests/GTestPowerful.cpp | 15 +- tests/GTestReplicate.cpp | 20 +- tests/GTestTableLookup.cpp | 19 +- tests/GTestThinBootstrapping.cpp | 60 +- tests/GTestThinEvalMap.cpp | 59 +- tests/GTestThinboot.cpp | 72 +- tests/TestBGV.cpp | 19 +- tests/TestBinIO.cpp | 1054 + .../TestBootstrappingWithMultiplications.cpp | 57 +- tests/TestCKKS.cpp | 27 +- tests/TestContext.cpp | 281 +- tests/TestCtxt.cpp | 17 +- tests/TestIO.cpp | 1632 + tests/TestMatmulCKKS.cpp | 37 +- tests/TestMatrix.cpp | 14 +- tests/TestPartialMatch.cpp | 67 +- tests/TestPermutations.cpp | 25 +- tests/TestPolyMod.cpp | 73 +- tests/TestPtxt.cpp | 941 +- tests/TestSet.cpp | 19 +- tests/TestVersion.in.cpp | 18 +- tests/test_common.cpp | 7 +- utils/CMakeLists.txt | 7 +- utils/coders/decode.py | 14 +- utils/coders/encode.py | 18 +- utils/common/Writer.h | 2 +- utils/common/common.h | 35 +- utils/create-context/create-context.cpp | 72 +- utils/crypto/decrypt.cpp | 4 +- utils/crypto/encrypt.cpp | 4 +- utils/test_bootstrapping/test_bootstrap.cpp | 4 +- utils/tests/crypto.bats | 4 +- utils/tests/diff-threshold.py | 26 +- utils/tests/std.bash | 5 + 136 files changed, 34897 insertions(+), 4873 deletions(-) create mode 100644 VERSION create mode 100644 benchmarks/IO.cpp create mode 100644 dependencies/json/json.hpp create mode 100644 examples/tutorial/01_ckks_basics.cpp create mode 100644 examples/tutorial/02_ckks_depth.cpp create mode 100644 examples/tutorial/03_ckks_data_movement.cpp create mode 100644 examples/tutorial/04_ckks_matmul.cpp create mode 100644 examples/tutorial/05_ckks_multlowlvl.cpp create mode 100644 examples/tutorial/06_ckks_serialization.cpp create mode 100644 examples/tutorial/07_ckks_deserialization.cpp create mode 100644 examples/tutorial/CMakeLists.txt create mode 100644 include/helib/JsonWrapper.h delete mode 100644 include/helib/binio.h create mode 100644 src/JsonWrapper.cpp create mode 100644 src/binio.h create mode 100644 src/io.cpp create mode 100644 src/io.h delete mode 100644 tests/GTestBinIO.cpp delete mode 100644 tests/GTestIO.cpp create mode 100644 tests/TestBinIO.cpp create mode 100644 tests/TestIO.cpp diff --git a/CHANGES.md b/CHANGES.md index b051f6854..81ce7f330 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,15 @@ +HElib 2.0.0, January 2021 +========================= +(tagged as v2.0.0) + +December-January 2021 +--------------------- +* Changes to Context API +* Must use ContextBuilder to build context +* New serialization APIs: binary and JSON +* CKKS coding tutorials +* Bug fixes + HElib 1.3.1, December 2020 ========================= (tagged as v1.3.1) diff --git a/CMakeLists.txt b/CMakeLists.txt index 884149d45..84583faab 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,6 +14,11 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) project(helib_superbuild LANGUAGES C CXX) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "${PROJECT_SOURCE_DIR}/VERSION" HELIB_VERSION) + # Fail if the target architecture is not 64-bit. if (NOT (CMAKE_SIZEOF_VOID_P EQUAL 8)) message(FATAL_ERROR "HElib requires a 64-bit architecture.") @@ -43,6 +48,8 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}) +# Location of the root folder of HElib (the one where this file is) +set(HELIB_PROJECT_ROOT_DIR "${PROJECT_SOURCE_DIR}") # Location of the cmake extra files set(HELIB_CMAKE_EXTRA_DIR "${PROJECT_SOURCE_DIR}/cmake") # Prefix of the header files (directory to be added to the include list) @@ -53,6 +60,8 @@ set(HELIB_HEADER_DIR "${HELIB_INCLUDE_DIR}/helib") set(HELIB_SOURCE_DIR "${PROJECT_SOURCE_DIR}/src") # Location of the google tests set(HELIB_TESTS_DIR "${PROJECT_SOURCE_DIR}/tests") +# Location of the dependencies +set(HELIB_DEPENDENCIES_DIR "${PROJECT_SOURCE_DIR}/dependencies") # Location of the directory containing the test binary (runTests). If # PACKAGE_BUILD=ON, this location will be changed to reflect the tests location. set(HELIB_TEST_BIN_DIR "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}") @@ -325,11 +334,14 @@ if (PACKAGE_BUILD) -DFETCH_GMP=${FETCH_GMP} -DENABLE_TEST=${ENABLE_TEST} -DHELIB_DEBUG=${HELIB_DEBUG} + -DHELIB_PROJECT_ROOT_DIR=${HELIB_PROJECT_ROOT_DIR} -DHELIB_CMAKE_EXTRA_DIR=${HELIB_CMAKE_EXTRA_DIR} -DHELIB_INCLUDE_DIR=${HELIB_INCLUDE_DIR} -DHELIB_HEADER_DIR=${HELIB_HEADER_DIR} -DHELIB_SOURCE_DIR=${HELIB_SOURCE_DIR} -DHELIB_TESTS_DIR=${HELIB_TESTS_DIR} + -DHELIB_DEPENDENCIES_DIR=${HELIB_DEPENDENCIES_DIR} + -DHELIB_VERSION=${HELIB_VERSION} BUILD_ALWAYS ON) if (ENABLE_TEST) diff --git a/INSTALL.md b/INSTALL.md index e8950cc6d..798f20f8e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -4,9 +4,9 @@ The HElib build, install, and regression tests suite have been built and tested on Ubuntu 18.04, Ubuntu 20.04, Fedora 32, Fedora 33, CentOS 7.8, CentOS 8.2, macOS Mojave >=10.14.6, and macOS Catalina >=10.15.7. -There are two different ways to build and install HElib. The first one will -automatically download and build the GMP and NTL dependencies and pack the -libraries in a relocatable folder. The second way, instead, requires the +There are two different ways to build and install HElib. The first one will +automatically download and build the GMP and NTL dependencies and pack the +libraries in a relocatable folder. The second way, instead, requires the dependencies to be installed by you and available in the system. **Please read these instructions in full to better choose the type of build that @@ -19,21 +19,24 @@ dependencies to be installed by you and available in the system. - git >= 1.8.3 (required to build and run the HElib test suite) **Linux environment:** + - g++ >= 7.3.1 - cmake >= 3.10.2 **macOS environment:** + - Apple clang >= 11.0.0 (available with the latest Xcode for the tested versions of macOS) - Xcode Command Line Tools (can be installed with the command `xcode-select --install` in a teminal) - cmake >= 3.17.3 (available from [CMake](https://cmake.org/) or [MacPorts Project](https://www.macports.org/) and [Homebrew](https://brew.sh/) as -packages) + packages) **For development:** + - clang-format >= 9.0.0 (available with your linux distribution and for macOS from [MacPorts Project](https://www.macports.org/) and -[Homebrew](https://brew.sh/) as packages) + [Homebrew](https://brew.sh/) as packages) ## Option 1: package build (recommended for most users) @@ -42,129 +45,136 @@ which can then be moved around freely on the system. NTL and GMP will be automatically fetched and compiled. It can be installed globally (i.e. under `/usr/local`), which is the default option if no `CMAKE_INSTALL_PREFIX` is specified, but this should only be done with caution as existing versions of -NTL, GMP, or HElib will be overwritten. These additional two prerequisites -are required in this case: +NTL, GMP, or HElib will be overwritten. These additional two prerequisites are +required in this case: - m4 >= 1.4.16 - patchelf >= 0.9 (if building on Linux) -Please note that if changing from library build to package build, it is safer -to use a clean build directory. +Please note that if changing from library build to package build, it is safer to +use a clean build directory. ### Instructions 1. Create a build directory, typically as a sibling of `src`: -``` + +```bash cd HElib mkdir build cd build ``` 2. Run the cmake configuration step, specifying that you want a package build -(via -DPACKAGE_BUILD=ON) and saying where you would like the installation to -be. To install in `/home/alice/helib_install`, for example: -``` + (via -DPACKAGE_BUILD=ON) and saying where you would like the installation to + be. To install in `/home/alice/helib_install`, for example: + +```bash cmake -DPACKAGE_BUILD=ON -DCMAKE_INSTALL_PREFIX=/home/alice/helib_install .. ``` -Extra options can be specified here, such as enabling HElib tests with -`-DENABLE_TEST=ON`. See later section entitled "HElib build -options" for details. +Extra options can be specified here, such as enabling HElib tests with +`-DENABLE_TEST=ON`. See later section entitled "HElib build options" for +details. 3. Compile, with an optional number of threads specified (16 in this example). -The output of this will be in the relocatable folder `helib_pack`: -``` + The output of this will be in the relocatable folder `helib_pack`: + +```bash make -j16 ``` -4. (optional) If step 2 was performed with `-DENABLE_TEST=ON`, HElib tests can -be run as follows: -``` +4. (optional) If step 2 was performed with `-DENABLE_TEST=ON`, HElib tests can + be run as follows: + +```bash ctest ``` -Detailed HElib-specific test logs can be found in + +Detailed HElib-specific test logs can be found in `Testing/Temporary/LastTest.log`. 5. (optional) Run the install step, to copy the folder `helib_pack` to -`${CMAKE_INSTALL_PREFIX}` (in this example `/home/alice/helib_install`): -``` + `${CMAKE_INSTALL_PREFIX}` (in this example `/home/alice/helib_install`): + +```bash make install ``` -of course, if the `CMAKE_INSTALL_PREFIX` was kept as the default `/usr/local` -or some other system-wide path, step 5 may require `sudo` privileges. - +of course, if the `CMAKE_INSTALL_PREFIX` was kept as the default `/usr/local` or +some other system-wide path, step 5 may require `sudo` privileges. ## Option 2: library build (advanced) This option involves building HElib on its own, linking against pre-existing -dependencies (NTL and GMP) on the system. In this way, the HElib library can -be moved around, but its dependencies (NTL and GMP) cannot, as they are -absolute paths. For this option, you must build GMP >=6.0.0 and NTL >=11.4.3 -yourself. For details on how to do this, please see the section on building -dependencies later. It is assumed throughout this installation option that the -environment variables `$GMPDIR` and `$NTLDIR` are set to point to the -installation directories of GMP and NTL respectively. +dependencies (NTL and GMP) on the system. In this way, the HElib library can be +moved around, but its dependencies (NTL and GMP) cannot, as they are absolute +paths. For this option, you must build GMP >=6.0.0 and NTL >=11.4.3 yourself. +For details on how to do this, please see the section on building dependencies +later. It is assumed throughout this installation option that the environment +variables `$GMPDIR` and `$NTLDIR` are set to point to the installation +directories of GMP and NTL respectively. -Please note that if changing from package build to library build, it is safer -to use a clean build directory. +Please note that if changing from package build to library build, it is safer to +use a clean build directory. 1. Create a build directory, typically as a sibling of `src`: - -``` +```bash cd HElib mkdir build cd build ``` 2. Run the cmake configuration step, specifying where to find NTL and GMP. If -not specified, system-wide locations such as `/usr/local/lib` will be searched. - To install in `/home/alice/helib_install`, for example: + not specified, system-wide locations such as `/usr/local/lib` will be + searched. To install in `/home/alice/helib_install`, for example: -``` +```bash cmake -DGMP_DIR="${GMPDIR}" -DNTL_DIR="${NTLDIR}" -DCMAKE_INSTALL_PREFIX=/home/alice/helib_install .. ``` -Extra options can be specified here, such as enabling HElib tests with +Extra options can be specified here, such as enabling HElib tests with `-DENABLE_TEST=ON`. See later section entitled "HElib build options" for details. 3. Compile, with an optional number of threads specified (16 in this example): -``` +```bash make -j16 ``` 4. (optional) If step 2 was performed with `-DENABLE_TEST=ON`, tests can be run -as follows: -``` + as follows: + +```bash ctest ``` -Detailed HElib test logs can be found in -`Testing/Temporary/LastTest.log`. -5. Run the install step, to copy the files to `${CMAKE_INSTALL_PREFIX}` (in -this example `/home/alice/helib_install`): -``` +Detailed HElib test logs can be found in `Testing/Temporary/LastTest.log`. + +5. Run the install step, to copy the files to `${CMAKE_INSTALL_PREFIX}` (in this + example `/home/alice/helib_install`): + +```bash make install ``` -of course, if the `CMAKE_INSTALL_PREFIX` was kept as the default `/usr/local` -or some other system-wide path, step 5 may require `sudo` privileges. +of course, if the `CMAKE_INSTALL_PREFIX` was kept as the default `/usr/local` or +some other system-wide path, step 5 may require `sudo` privileges. ## Building dependencies (for option 2) ### GMP -Many distributions come with GMP pre-installed. -If not, you can install GMP as follows. +Many distributions come with GMP pre-installed. If not, you can install GMP as +follows. -1. Download GMP from http://www.gmplib.org -- make sure that you get GMP >=6.0.0 - (current version is 6.2.0). +1. Download GMP from [http://www.gmplib.org](http://www.gmplib.org) -- make sure + that you get GMP >=6.0.0 (current version is 6.2.0). 2. Decompress and cd into the gmp directory (e.g., `gmp-6.2.0`). 3. GMP is compiled in the standard unix way: -``` + +```bash ./configure make sudo make install @@ -172,7 +182,6 @@ If not, you can install GMP as follows. This will install GMP into `/usr/local` by default. - **NOTE:** For further options when building GMP, run `./configure --help` in step 3. @@ -181,15 +190,17 @@ step 3. You can install NTL as follows: 1. Download NTL >=11.4.3 (current version is 11.4.3) from - http://www.shoup.net/ntl/download.html + [http://www.shoup.net/ntl/download.html](http://www.shoup.net/ntl/download.html) 2. Decompress and cd into the directory, e.g., `ntl-11.4.3/src` -3. NTL is configured, built and installed in the standard Unix way (but -remember to specify the following flags to `configure`): -``` +3. NTL is configured, built and installed in the standard Unix way (but remember + to specify the following flags to `configure`): + +```bash ./configure NTL_GMP_LIP=on SHARED=on NTL_THREADS=on NTL_THREAD_BOOST=on make sudo make install ``` + This should install NTL into `/usr/local`. **NOTE:** For further options when building NTL, run `./configure --help` in @@ -201,37 +212,40 @@ to the `./configure` step. ## HElib build options ### Generic options -- `BUILD_SHARED=ON/OFF` (default is `OFF`): Build as a shared library. - Note that building HElib (regardless of `BUILD_SHARED`) will fail if NTL - is not built as a shared library. The default for NTL is static library, - to build NTL as a shared library use `./configure SHARED=on` in step 1. -- `CMAKE_BUILD_TYPE`: (default is `RelWithDebInfo`): Choose the type of build, + +- `BUILD_SHARED=ON/OFF` (default is `OFF`): Build as a shared library. Note that + building HElib (regardless of `BUILD_SHARED`) will fail if NTL is not built as + a shared library. The default for NTL is static library, to build NTL as a + shared library use `./configure SHARED=on` in step 1. +- `CMAKE_BUILD_TYPE`: (default is `RelWithDebInfo`): Choose the type of build, options are: `Debug`, `RelWithDebInfo`, `Release`, `MinSizeRel`. - `CMAKE_INSTALL_PREFIX`: Desired installation directory for HElib. - `ENABLE_TEST=ON/OFF` (default is `OFF`): Enable building of tests. This will - include an automatic download step for the google test framework stable + include an automatic download step for the google test framework stable release (googletest v1.10.0) - `ENABLE_THREADS=ON/OFF` (default is `ON`): Enable threading support. This must be on if and only if NTL was built with `NTL_THREADS=ON`. -- `PEDANTIC_BUILD=ON/OFF` (default is `ON`): Use - `-Wall -Wpedantic -Wextra -Werror` during build. +- `PEDANTIC_BUILD=ON/OFF` (default is `ON`): Use `-Wall -Wpedantic -Wextra + -Werror` during build. - `HELIB_DEBUG=ON/OFF` (default is `OFF`): Activate the debug module when - building HElib (by defining the `HELIB_DEBUG` macro). When the debug module - is active, this generates extra information used for debugging purposes. - `HELIB_DEBUG` will propagate to programs using HElib, when using cmake. When + building HElib (by defining the `HELIB_DEBUG` macro). When the debug module is + active, this generates extra information used for debugging purposes. + `HELIB_DEBUG` will propagate to programs using HElib, when using cmake. When this is enabled, programs using HElib will generate a warning during configuration. This is to remind the user that use of the debug module can cause issues, such as `sigsegv`, if initialized incorrectly. ### Parameters specific to option 1 (package build) + - `PACKAGE_DIR`: Location that a package build will be installed to. Defaults -to `${CMAKE_INSTALL_PREFIX}/helib_pack`. -- `FETCH_GMP`: Whether or not to fetch and build GMP. Defaults to `ON`. If -set to `OFF`, there should either exist a system-installed GMP library, or -`GMP_DIR` should point to a valid GMP prefix. + to `${CMAKE_INSTALL_PREFIX}/helib_pack`. +- `FETCH_GMP`: Whether or not to fetch and build GMP. Defaults to `ON`. If set + to `OFF`, there should either exist a system-installed GMP library, or + `GMP_DIR` should point to a valid GMP prefix. - `GMP_DIR`: Prefix of the GMP library. Ignored if `FETCH_GMP=ON`. ### Parameters specific to option 2 (library build) + - `GMP_DIR`: Prefix of the GMP library. - `NTL_DIR`: Prefix of the NTL library. @@ -249,13 +263,15 @@ choice. Another, easier way is possible if you are using HElib in a cmake project. 1. Include the following line in your `CMakeLists.txt`: -``` + +```cmake find_package(helib) ``` + 2. Run your `cmake` step with `-Dhelib_DIR=/share/cmake/helib`. ## Example -Full working examples of cmake-based projects which uses HElib can be found -in the `examples` directory. +Full working examples of cmake-based projects which uses HElib can be found in +the `examples` directory. diff --git a/README.md b/README.md index d434c7167..47be27881 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,43 @@ HElib ===== + [![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 implementations of the [Brakerski-Gentry-Vaikuntanathan][1] (BGV) -scheme with [bootstrapping][8] and the Approximate Number scheme of -[Cheon-Kim-Kim-Song][9] (CKKS), along with many optimizations to make -homomorphic evaluation run faster, focusing mostly on effective use of -the [Smart-Vercauteren][2] ciphertext 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. - -Since mid-2018 HElib has been under extensive refactoring for *Reliability*, -*Robustness & Serviceability*, *Performance*, and most importantly *Usability* +HElib is an open-source ([Apache License v2.0][5]) software library that +implements [homomorphic encryption][6] (HE). Currently available schemes are the +implementations of the [Brakerski-Gentry-Vaikuntanathan][1] (BGV) scheme with +[bootstrapping][8] and the Approximate Number scheme of [Cheon-Kim-Kim-Song][9] +(CKKS), along with many optimizations to make homomorphic evaluation run faster, +focusing mostly on effective use of the [Smart-Vercauteren][2] ciphertext +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. + +Since mid-2018 HElib has been under extensive refactoring for *Reliability*, +*Robustness & Serviceability*, *Performance*, and most importantly *Usability* for researchers and developers working on HE and its uses. 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. +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. -Full installation instructions and a list of the required dependencies can be found -in [INSTALL.md](INSTALL.md). +Full installation instructions and a list of the required dependencies can be +found in [INSTALL.md](INSTALL.md). -If you are interested in contributing to HElib, please read our +For guidance in getting started programming with HElib, take a look at the +example programs and our CKKS tutorials located in the `examples` directory. See +[examples/README.md](examples/README.md). + +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 distributed under the terms of the [Apache License v2.0][5]. - [1]: http://eprint.iacr.org/2011/277 "BGV12" [2]: http://eprint.iacr.org/2011/133 "SV11" [3]: http://eprint.iacr.org/2012/099 "GHS12" diff --git a/VERSION b/VERSION new file mode 100644 index 000000000..227cea215 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +2.0.0 diff --git a/benchmarks/CMakeLists.txt b/benchmarks/CMakeLists.txt index 2026694ba..683d0692c 100644 --- a/benchmarks/CMakeLists.txt +++ b/benchmarks/CMakeLists.txt @@ -47,14 +47,21 @@ endif (NOT CMAKE_BUILD_TYPE) set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "RelWithDebInfo" "Release" "MinSizeRel") -find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) + find_package(benchmark REQUIRED) # Targets are simply associated with their source files. set(TRGTS bgv_basic bgv_thinboot bgv_fatboot - ckks_basic) + ckks_basic + IO) # Sources derived from their targets. set(SRCS "") diff --git a/benchmarks/IO.cpp b/benchmarks/IO.cpp new file mode 100644 index 000000000..d87bb340f --- /dev/null +++ b/benchmarks/IO.cpp @@ -0,0 +1,254 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include +#include + +#include +#include +#include "bgv_common.h" + +namespace { + +static void benchContextBinaryIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->context.writeTo(ss); + helib::Context newContext = helib::Context::readFrom(ss); + ::benchmark::DoNotOptimize(newContext); + } +} + +static void benchContextJSONIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->context.writeToJSON(ss); + helib::Context newContext = helib::Context::readFromJSON(ss); + ::benchmark::DoNotOptimize(newContext); + } +} + +static void benchPublicKeyBinaryIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->publicKey.writeTo(ss); + helib::PubKey newPublicKey = + helib::PubKey::readFrom(ss, meta.data->context); + ::benchmark::DoNotOptimize(newPublicKey); + } +} + +static void benchPublicKeyJSONIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->publicKey.writeToJSON(ss); + helib::PubKey newPublicKey = + helib::PubKey::readFromJSON(ss, meta.data->context); + ::benchmark::DoNotOptimize(newPublicKey); + } +} + +static void benchSecretKeyBinaryIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->secretKey.writeTo(ss); + helib::SecKey newSecretKey = + helib::SecKey::readFrom(ss, meta.data->context); + ::benchmark::DoNotOptimize(newSecretKey); + } +} + +static void benchSecretKeyJSONIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + + for (auto _ : state) { + meta.data->secretKey.writeToJSON(ss); + helib::SecKey newSecretKey = + helib::SecKey::readFromJSON(ss, meta.data->context); + ::benchmark::DoNotOptimize(newSecretKey); + } +} + +static void benchCiphertextBinaryIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + helib::Ctxt ctxt(meta.data->publicKey); + + for (auto _ : state) { + ctxt.writeTo(ss); + helib::Ctxt newCtxt = helib::Ctxt::readFrom(ss, meta.data->publicKey); + ::benchmark::DoNotOptimize(newCtxt); + } +} + +static void benchCiphertextJSONIO(benchmark::State& state, Meta& meta) +{ + std::stringstream ss; + helib::Ctxt ctxt(meta.data->publicKey); + + for (auto _ : state) { + ctxt.writeToJSON(ss); + helib::Ctxt newCtxt = helib::Ctxt::readFromJSON(ss, meta.data->publicKey); + ::benchmark::DoNotOptimize(newCtxt); + } +} + +Meta fn; +Params no_boot_params(/*m =*/45, + /*p =*/19, + /*r =*/1, + /*bits =*/30); +// Binary IO benchmarks +BENCHMARK_CAPTURE(benchContextBinaryIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchPublicKeyBinaryIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchSecretKeyBinaryIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchCiphertextBinaryIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +// JSON IO benchmarks +BENCHMARK_CAPTURE(benchContextJSONIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchPublicKeyJSONIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchSecretKeyJSONIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); +BENCHMARK_CAPTURE(benchCiphertextJSONIO, no_boot_params, fn(no_boot_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +Params tiny_params(/*m =*/31 * 41, + /*p =*/2, + /*r =*/1, + /*bits =*/580, + /*gens =*/std::vector{1026, 249}, + /*ords =*/std::vector{30, -2}, + /*mvec =*/std::vector{31, 41}); +// Binary IO benchmarks +BENCHMARK_CAPTURE(benchContextBinaryIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchPublicKeyBinaryIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchSecretKeyBinaryIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchCiphertextBinaryIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +// JSON IO benchmarks +BENCHMARK_CAPTURE(benchContextJSONIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchPublicKeyJSONIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchSecretKeyJSONIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(10); +BENCHMARK_CAPTURE(benchCiphertextJSONIO, tiny_params, fn(tiny_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +Params small_params(/*m =*/31775, + /*p =*/2, + /*r =*/1, + /*bits =*/580, + /*gens =*/std::vector{6976, 24806}, + /*ords =*/std::vector{40, 30}, + /*mvec =*/std::vector{41, 775}); +// Binary IO benchmarks +BENCHMARK_CAPTURE(benchContextBinaryIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchPublicKeyBinaryIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchSecretKeyBinaryIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchCiphertextBinaryIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +// JSON IO benchmarks +BENCHMARK_CAPTURE(benchContextJSONIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchPublicKeyJSONIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchSecretKeyJSONIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchCiphertextJSONIO, small_params, fn(small_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +Params big_params(/*m =*/35113, + /*p =*/2, + /*r =*/1, + /*bits =*/580, + /*gens =*/std::vector{16134, 8548}, + /*ords =*/std::vector{36, 24}, + /*mvec =*/std::vector{37, 949}); +// Binary IO benchmarks +BENCHMARK_CAPTURE(benchContextBinaryIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchPublicKeyBinaryIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchSecretKeyBinaryIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchCiphertextBinaryIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +// JSON IO benchmarks +BENCHMARK_CAPTURE(benchContextJSONIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchPublicKeyJSONIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchSecretKeyJSONIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(1); +BENCHMARK_CAPTURE(benchCiphertextJSONIO, big_params, fn(big_params)) + ->Unit(benchmark::kMillisecond) + ->Iterations(200); + +} // namespace diff --git a/benchmarks/bgv_common.h b/benchmarks/bgv_common.h index 91a81a6a7..0af2b78b7 100644 --- a/benchmarks/bgv_common.h +++ b/benchmarks/bgv_common.h @@ -19,22 +19,30 @@ struct Params const long m, p, r, L; const std::vector gens; const std::vector ords; + const std::vector mvec; Params(long _m, long _p, long _r, long _L, const std::vector& _gens = {}, - const std::vector& _ords = {}) : - m(_m), p(_p), r(_r), L(_L), gens(_gens), ords(_ords) + const std::vector& _ords = {}, + const std::vector& _mvec = {}) : + m(_m), p(_p), r(_r), L(_L), gens(_gens), ords(_ords), mvec(_mvec) {} Params(const Params& other) : - Params(other.m, other.p, other.r, other.L, other.gens, other.ords) + Params(other.m, + other.p, + other.r, + other.L, + other.gens, + other.ords, + other.mvec) {} bool operator!=(Params& other) const { return !(*this == other); } bool operator==(Params& other) const { return m == other.m && p == other.p && r == other.r && L == other.L && - gens == other.gens && ords == other.ords; + gens == other.gens && ords == other.ords && mvec == other.mvec; } }; @@ -49,12 +57,21 @@ struct ContextAndKeys ContextAndKeys(Params& _params) : params(_params), - context(params.m, params.p, params.r, params.gens, params.ords), - secretKey((helib::buildModChain(context, params.L, /*c=*/2), context)), + context(helib::ContextBuilder() + .m(params.m) + .p(params.p) + .r(params.r) + .bits(params.L) + .gens(params.gens) + .ords(params.ords) + .bootstrappable(!params.mvec.empty()) + .mvec(params.mvec) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), helib::addSome1DMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) { context.printout(); } diff --git a/benchmarks/bgv_fatboot.cpp b/benchmarks/bgv_fatboot.cpp index 721a49065..6f4fcf707 100644 --- a/benchmarks/bgv_fatboot.cpp +++ b/benchmarks/bgv_fatboot.cpp @@ -34,11 +34,10 @@ static void BM_fatboot(benchmark::State& state, long bits, long t, int c_m, - std::vector mvector, + std::vector mvec, std::vector gens, std::vector ords) { - NTL::Vec mvec = helib::convert>(mvector); // clang-format off std::cout << "m=" << m << ", p=" << p @@ -47,23 +46,28 @@ static void BM_fatboot(benchmark::State& state, << ", c=" << c << ", skHwt=" << t << ", c_m=" << c_m - << ", mvec=" << mvec + << ", mvec=" << helib::vecToStr(mvec) << ", gens=" << helib::vecToStr(gens) << ", ords=" << helib::vecToStr(ords) << std::endl; // clang-format on std::cout << "Initialising context object..." << std::endl; - helib::Context context(m, p, r, gens, ords); - context.zMStar.set_cM(c_m / 100.0); - - std::cout << "Building modulus chain..." << std::endl; - buildModChain(context, bits, c, /*willBeBootstrappable=*/true, /*skHwt*/ t); - - // Make bootstrappable - context.enableBootStrapping(mvec, /*build_cache=*/0, /*alsoThick=*/true); + helib::Context context = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(bits) + .c(c) + .bootstrappable(true) + .skHwt(t) + .mvec(mvec) + .thickboot() + .build(); // Print the context - context.zMStar.printout(); + context.printout(); std::cout << std::endl; std::cout << "Security: " << context.securityLevel() << std::endl; @@ -80,7 +84,7 @@ static void BM_fatboot(benchmark::State& state, // NOTE: For some reason the reCrypt method is not marked const so // I had to remove the const from the public key helib::PubKey& public_key = secret_key; - const helib::EncryptedArray& ea = *(context.ea); + const helib::EncryptedArray& ea = context.getEA(); long nslots = ea.size(); std::cout << "Number of slots: " << nslots << std::endl; diff --git a/benchmarks/bgv_thinboot.cpp b/benchmarks/bgv_thinboot.cpp index e65617a50..a8a9c02ce 100644 --- a/benchmarks/bgv_thinboot.cpp +++ b/benchmarks/bgv_thinboot.cpp @@ -34,11 +34,10 @@ static void BM_thinboot(benchmark::State& state, long bits, long t, int c_m, - std::vector mvector, + std::vector mvec, std::vector gens, std::vector ords) { - NTL::Vec mvec = helib::convert>(mvector); // clang-format off std::cout << "m=" << m << ", p=" << p @@ -47,23 +46,27 @@ static void BM_thinboot(benchmark::State& state, << ", c=" << c << ", skHwt=" << t << ", c_m=" << c_m - << ", mvec=" << mvec + << ", mvec=" << helib::vecToStr(mvec) << ", gens=" << helib::vecToStr(gens) << ", ords=" << helib::vecToStr(ords) << std::endl; // clang-format on std::cout << "Initialising context object..." << std::endl; - helib::Context context(m, p, r, gens, ords); - context.zMStar.set_cM(c_m / 100.0); - - std::cout << "Building modulus chain..." << std::endl; - buildModChain(context, bits, c, /*willBeBootstrappable=*/true, /*skHwt*/ t); - - // Make bootstrappable (saves time by disabling some fat boot precomputation) - context.enableBootStrapping(mvec, /*build_cache=*/0, /*alsoThick=*/false); + helib::Context context = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(bits) + .c(c) + .bootstrappable(true) + .skHwt(t) + .mvec(mvec) + .build(); // Print the context - context.zMStar.printout(); + context.printout(); std::cout << std::endl; std::cout << "Security: " << context.securityLevel() << std::endl; @@ -80,7 +83,7 @@ static void BM_thinboot(benchmark::State& state, // NOTE: For some reason the reCrypt method is not marked const so // I had to remove the const from the public key helib::PubKey& public_key = secret_key; - const helib::EncryptedArray& ea = *(context.ea); + const helib::EncryptedArray& ea = context.getEA(); long nslots = ea.size(); std::cout << "Number of slots: " << nslots << std::endl; diff --git a/benchmarks/ckks_common.h b/benchmarks/ckks_common.h index cc9954a20..49d15fded 100644 --- a/benchmarks/ckks_common.h +++ b/benchmarks/ckks_common.h @@ -33,24 +33,21 @@ struct ContextAndKeys helib::Context context; helib::SecKey secretKey; const helib::PubKey publicKey; - const helib::EncryptedArrayCx& ea; + const helib::EncryptedArray& ea; ContextAndKeys(Params& _params) : params(_params), - context(params.m, /*p=*/-1, params.r), - secretKey((context.scale = 50, - helib::buildModChain(context, - params.L, - /*c=*/3, - /*willBeBootstrappable=*/false, - /*hwt=*/0, - /*resolution=*/3, - /*bitsInSpecialPrime=*/0), - context)), + context(helib::ContextBuilder() + .m(params.m) + .precision(params.r) + .bits(params.L) + .scale(10) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), helib::addSome1DMatrices(secretKey), secretKey)), - ea(context.ea->getCx()) + ea(context.getEA()) { context.printout(); } diff --git a/dependencies/json/json.hpp b/dependencies/json/json.hpp new file mode 100644 index 000000000..a70aaf8cb --- /dev/null +++ b/dependencies/json/json.hpp @@ -0,0 +1,25447 @@ +/* + __ _____ _____ _____ + __| | __| | | | JSON for Modern C++ +| | |__ | | | | | | version 3.9.1 +|_____|_____|_____|_|___| https://github.com/nlohmann/json + +Licensed under the MIT License . +SPDX-License-Identifier: MIT +Copyright (c) 2013-2019 Niels Lohmann . + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +#ifndef INCLUDE_NLOHMANN_JSON_HPP_ +#define INCLUDE_NLOHMANN_JSON_HPP_ + +#define NLOHMANN_JSON_VERSION_MAJOR 3 +#define NLOHMANN_JSON_VERSION_MINOR 9 +#define NLOHMANN_JSON_VERSION_PATCH 1 + +#include // all_of, find, for_each +#include // nullptr_t, ptrdiff_t, size_t +#include // hash, less +#include // initializer_list +#include // istream, ostream +#include // random_access_iterator_tag +#include // unique_ptr +#include // accumulate +#include // string, stoi, to_string +#include // declval, forward, move, pair, swap +#include // vector + +// #include + + +#include + +// #include + + +#include // transform +#include // array +#include // forward_list +#include // inserter, front_inserter, end +#include // map +#include // string +#include // tuple, make_tuple +#include // is_arithmetic, is_same, is_enum, underlying_type, is_convertible +#include // unordered_map +#include // pair, declval +#include // valarray + +// #include + + +#include // exception +#include // runtime_error +#include // to_string + +// #include + + +#include // size_t + +namespace nlohmann +{ +namespace detail +{ +/// struct to capture the start position of the current token +struct position_t +{ + /// the total number of characters read + std::size_t chars_read_total = 0; + /// the number of characters read in the current line + std::size_t chars_read_current_line = 0; + /// the number of lines read + std::size_t lines_read = 0; + + /// conversion to size_t to preserve SAX interface + constexpr operator size_t() const + { + return chars_read_total; + } +}; + +} // namespace detail +} // namespace nlohmann + +// #include + + +#include // pair +// #include +/* Hedley - https://nemequ.github.io/hedley + * Created by Evan Nemerson + * + * To the extent possible under law, the author(s) have dedicated all + * copyright and related and neighboring rights to this software to + * the public domain worldwide. This software is distributed without + * any warranty. + * + * For details, see . + * SPDX-License-Identifier: CC0-1.0 + */ + +#if !defined(JSON_HEDLEY_VERSION) || (JSON_HEDLEY_VERSION < 13) +#if defined(JSON_HEDLEY_VERSION) + #undef JSON_HEDLEY_VERSION +#endif +#define JSON_HEDLEY_VERSION 13 + +#if defined(JSON_HEDLEY_STRINGIFY_EX) + #undef JSON_HEDLEY_STRINGIFY_EX +#endif +#define JSON_HEDLEY_STRINGIFY_EX(x) #x + +#if defined(JSON_HEDLEY_STRINGIFY) + #undef JSON_HEDLEY_STRINGIFY +#endif +#define JSON_HEDLEY_STRINGIFY(x) JSON_HEDLEY_STRINGIFY_EX(x) + +#if defined(JSON_HEDLEY_CONCAT_EX) + #undef JSON_HEDLEY_CONCAT_EX +#endif +#define JSON_HEDLEY_CONCAT_EX(a,b) a##b + +#if defined(JSON_HEDLEY_CONCAT) + #undef JSON_HEDLEY_CONCAT +#endif +#define JSON_HEDLEY_CONCAT(a,b) JSON_HEDLEY_CONCAT_EX(a,b) + +#if defined(JSON_HEDLEY_CONCAT3_EX) + #undef JSON_HEDLEY_CONCAT3_EX +#endif +#define JSON_HEDLEY_CONCAT3_EX(a,b,c) a##b##c + +#if defined(JSON_HEDLEY_CONCAT3) + #undef JSON_HEDLEY_CONCAT3 +#endif +#define JSON_HEDLEY_CONCAT3(a,b,c) JSON_HEDLEY_CONCAT3_EX(a,b,c) + +#if defined(JSON_HEDLEY_VERSION_ENCODE) + #undef JSON_HEDLEY_VERSION_ENCODE +#endif +#define JSON_HEDLEY_VERSION_ENCODE(major,minor,revision) (((major) * 1000000) + ((minor) * 1000) + (revision)) + +#if defined(JSON_HEDLEY_VERSION_DECODE_MAJOR) + #undef JSON_HEDLEY_VERSION_DECODE_MAJOR +#endif +#define JSON_HEDLEY_VERSION_DECODE_MAJOR(version) ((version) / 1000000) + +#if defined(JSON_HEDLEY_VERSION_DECODE_MINOR) + #undef JSON_HEDLEY_VERSION_DECODE_MINOR +#endif +#define JSON_HEDLEY_VERSION_DECODE_MINOR(version) (((version) % 1000000) / 1000) + +#if defined(JSON_HEDLEY_VERSION_DECODE_REVISION) + #undef JSON_HEDLEY_VERSION_DECODE_REVISION +#endif +#define JSON_HEDLEY_VERSION_DECODE_REVISION(version) ((version) % 1000) + +#if defined(JSON_HEDLEY_GNUC_VERSION) + #undef JSON_HEDLEY_GNUC_VERSION +#endif +#if defined(__GNUC__) && defined(__GNUC_PATCHLEVEL__) + #define JSON_HEDLEY_GNUC_VERSION JSON_HEDLEY_VERSION_ENCODE(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__) +#elif defined(__GNUC__) + #define JSON_HEDLEY_GNUC_VERSION JSON_HEDLEY_VERSION_ENCODE(__GNUC__, __GNUC_MINOR__, 0) +#endif + +#if defined(JSON_HEDLEY_GNUC_VERSION_CHECK) + #undef JSON_HEDLEY_GNUC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_GNUC_VERSION) + #define JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_GNUC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_MSVC_VERSION) + #undef JSON_HEDLEY_MSVC_VERSION +#endif +#if defined(_MSC_FULL_VER) && (_MSC_FULL_VER >= 140000000) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_FULL_VER / 10000000, (_MSC_FULL_VER % 10000000) / 100000, (_MSC_FULL_VER % 100000) / 100) +#elif defined(_MSC_FULL_VER) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_FULL_VER / 1000000, (_MSC_FULL_VER % 1000000) / 10000, (_MSC_FULL_VER % 10000) / 10) +#elif defined(_MSC_VER) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_VER / 100, _MSC_VER % 100, 0) +#endif + +#if defined(JSON_HEDLEY_MSVC_VERSION_CHECK) + #undef JSON_HEDLEY_MSVC_VERSION_CHECK +#endif +#if !defined(_MSC_VER) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (0) +#elif defined(_MSC_VER) && (_MSC_VER >= 1400) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_FULL_VER >= ((major * 10000000) + (minor * 100000) + (patch))) +#elif defined(_MSC_VER) && (_MSC_VER >= 1200) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_FULL_VER >= ((major * 1000000) + (minor * 10000) + (patch))) +#else + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_VER >= ((major * 100) + (minor))) +#endif + +#if defined(JSON_HEDLEY_INTEL_VERSION) + #undef JSON_HEDLEY_INTEL_VERSION +#endif +#if defined(__INTEL_COMPILER) && defined(__INTEL_COMPILER_UPDATE) + #define JSON_HEDLEY_INTEL_VERSION JSON_HEDLEY_VERSION_ENCODE(__INTEL_COMPILER / 100, __INTEL_COMPILER % 100, __INTEL_COMPILER_UPDATE) +#elif defined(__INTEL_COMPILER) + #define JSON_HEDLEY_INTEL_VERSION JSON_HEDLEY_VERSION_ENCODE(__INTEL_COMPILER / 100, __INTEL_COMPILER % 100, 0) +#endif + +#if defined(JSON_HEDLEY_INTEL_VERSION_CHECK) + #undef JSON_HEDLEY_INTEL_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_INTEL_VERSION) + #define JSON_HEDLEY_INTEL_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_INTEL_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_INTEL_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_PGI_VERSION) + #undef JSON_HEDLEY_PGI_VERSION +#endif +#if defined(__PGI) && defined(__PGIC__) && defined(__PGIC_MINOR__) && defined(__PGIC_PATCHLEVEL__) + #define JSON_HEDLEY_PGI_VERSION JSON_HEDLEY_VERSION_ENCODE(__PGIC__, __PGIC_MINOR__, __PGIC_PATCHLEVEL__) +#endif + +#if defined(JSON_HEDLEY_PGI_VERSION_CHECK) + #undef JSON_HEDLEY_PGI_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_PGI_VERSION) + #define JSON_HEDLEY_PGI_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_PGI_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_PGI_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_SUNPRO_VERSION) + #undef JSON_HEDLEY_SUNPRO_VERSION +#endif +#if defined(__SUNPRO_C) && (__SUNPRO_C > 0x1000) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((((__SUNPRO_C >> 16) & 0xf) * 10) + ((__SUNPRO_C >> 12) & 0xf), (((__SUNPRO_C >> 8) & 0xf) * 10) + ((__SUNPRO_C >> 4) & 0xf), (__SUNPRO_C & 0xf) * 10) +#elif defined(__SUNPRO_C) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((__SUNPRO_C >> 8) & 0xf, (__SUNPRO_C >> 4) & 0xf, (__SUNPRO_C) & 0xf) +#elif defined(__SUNPRO_CC) && (__SUNPRO_CC > 0x1000) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((((__SUNPRO_CC >> 16) & 0xf) * 10) + ((__SUNPRO_CC >> 12) & 0xf), (((__SUNPRO_CC >> 8) & 0xf) * 10) + ((__SUNPRO_CC >> 4) & 0xf), (__SUNPRO_CC & 0xf) * 10) +#elif defined(__SUNPRO_CC) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((__SUNPRO_CC >> 8) & 0xf, (__SUNPRO_CC >> 4) & 0xf, (__SUNPRO_CC) & 0xf) +#endif + +#if defined(JSON_HEDLEY_SUNPRO_VERSION_CHECK) + #undef JSON_HEDLEY_SUNPRO_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_SUNPRO_VERSION) + #define JSON_HEDLEY_SUNPRO_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_SUNPRO_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_SUNPRO_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION) + #undef JSON_HEDLEY_EMSCRIPTEN_VERSION +#endif +#if defined(__EMSCRIPTEN__) + #define JSON_HEDLEY_EMSCRIPTEN_VERSION JSON_HEDLEY_VERSION_ENCODE(__EMSCRIPTEN_major__, __EMSCRIPTEN_minor__, __EMSCRIPTEN_tiny__) +#endif + +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK) + #undef JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION) + #define JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_EMSCRIPTEN_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_ARM_VERSION) + #undef JSON_HEDLEY_ARM_VERSION +#endif +#if defined(__CC_ARM) && defined(__ARMCOMPILER_VERSION) + #define JSON_HEDLEY_ARM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ARMCOMPILER_VERSION / 1000000, (__ARMCOMPILER_VERSION % 1000000) / 10000, (__ARMCOMPILER_VERSION % 10000) / 100) +#elif defined(__CC_ARM) && defined(__ARMCC_VERSION) + #define JSON_HEDLEY_ARM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ARMCC_VERSION / 1000000, (__ARMCC_VERSION % 1000000) / 10000, (__ARMCC_VERSION % 10000) / 100) +#endif + +#if defined(JSON_HEDLEY_ARM_VERSION_CHECK) + #undef JSON_HEDLEY_ARM_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_ARM_VERSION) + #define JSON_HEDLEY_ARM_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_ARM_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_ARM_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_IBM_VERSION) + #undef JSON_HEDLEY_IBM_VERSION +#endif +#if defined(__ibmxl__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ibmxl_version__, __ibmxl_release__, __ibmxl_modification__) +#elif defined(__xlC__) && defined(__xlC_ver__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__xlC__ >> 8, __xlC__ & 0xff, (__xlC_ver__ >> 8) & 0xff) +#elif defined(__xlC__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__xlC__ >> 8, __xlC__ & 0xff, 0) +#endif + +#if defined(JSON_HEDLEY_IBM_VERSION_CHECK) + #undef JSON_HEDLEY_IBM_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_IBM_VERSION) + #define JSON_HEDLEY_IBM_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_IBM_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_IBM_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_VERSION) + #undef JSON_HEDLEY_TI_VERSION +#endif +#if \ + defined(__TI_COMPILER_VERSION__) && \ + ( \ + defined(__TMS470__) || defined(__TI_ARM__) || \ + defined(__MSP430__) || \ + defined(__TMS320C2000__) \ + ) +#if (__TI_COMPILER_VERSION__ >= 16000000) + #define JSON_HEDLEY_TI_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif +#endif + +#if defined(JSON_HEDLEY_TI_VERSION_CHECK) + #undef JSON_HEDLEY_TI_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_VERSION) + #define JSON_HEDLEY_TI_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL2000_VERSION) + #undef JSON_HEDLEY_TI_CL2000_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__TMS320C2000__) + #define JSON_HEDLEY_TI_CL2000_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL2000_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL2000_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL2000_VERSION) + #define JSON_HEDLEY_TI_CL2000_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL2000_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL2000_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL430_VERSION) + #undef JSON_HEDLEY_TI_CL430_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__MSP430__) + #define JSON_HEDLEY_TI_CL430_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL430_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL430_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL430_VERSION) + #define JSON_HEDLEY_TI_CL430_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL430_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL430_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION) + #undef JSON_HEDLEY_TI_ARMCL_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && (defined(__TMS470__) || defined(__TI_ARM__)) + #define JSON_HEDLEY_TI_ARMCL_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION_CHECK) + #undef JSON_HEDLEY_TI_ARMCL_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION) + #define JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_ARMCL_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL6X_VERSION) + #undef JSON_HEDLEY_TI_CL6X_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__TMS320C6X__) + #define JSON_HEDLEY_TI_CL6X_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL6X_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL6X_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL6X_VERSION) + #define JSON_HEDLEY_TI_CL6X_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL6X_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL6X_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL7X_VERSION) + #undef JSON_HEDLEY_TI_CL7X_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__C7000__) + #define JSON_HEDLEY_TI_CL7X_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL7X_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL7X_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL7X_VERSION) + #define JSON_HEDLEY_TI_CL7X_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL7X_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL7X_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION) + #undef JSON_HEDLEY_TI_CLPRU_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__PRU__) + #define JSON_HEDLEY_TI_CLPRU_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CLPRU_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION) + #define JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CLPRU_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_CRAY_VERSION) + #undef JSON_HEDLEY_CRAY_VERSION +#endif +#if defined(_CRAYC) + #if defined(_RELEASE_PATCHLEVEL) + #define JSON_HEDLEY_CRAY_VERSION JSON_HEDLEY_VERSION_ENCODE(_RELEASE_MAJOR, _RELEASE_MINOR, _RELEASE_PATCHLEVEL) + #else + #define JSON_HEDLEY_CRAY_VERSION JSON_HEDLEY_VERSION_ENCODE(_RELEASE_MAJOR, _RELEASE_MINOR, 0) + #endif +#endif + +#if defined(JSON_HEDLEY_CRAY_VERSION_CHECK) + #undef JSON_HEDLEY_CRAY_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_CRAY_VERSION) + #define JSON_HEDLEY_CRAY_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_CRAY_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_CRAY_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_IAR_VERSION) + #undef JSON_HEDLEY_IAR_VERSION +#endif +#if defined(__IAR_SYSTEMS_ICC__) + #if __VER__ > 1000 + #define JSON_HEDLEY_IAR_VERSION JSON_HEDLEY_VERSION_ENCODE((__VER__ / 1000000), ((__VER__ / 1000) % 1000), (__VER__ % 1000)) + #else + #define JSON_HEDLEY_IAR_VERSION JSON_HEDLEY_VERSION_ENCODE(VER / 100, __VER__ % 100, 0) + #endif +#endif + +#if defined(JSON_HEDLEY_IAR_VERSION_CHECK) + #undef JSON_HEDLEY_IAR_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_IAR_VERSION) + #define JSON_HEDLEY_IAR_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_IAR_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_IAR_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TINYC_VERSION) + #undef JSON_HEDLEY_TINYC_VERSION +#endif +#if defined(__TINYC__) + #define JSON_HEDLEY_TINYC_VERSION JSON_HEDLEY_VERSION_ENCODE(__TINYC__ / 1000, (__TINYC__ / 100) % 10, __TINYC__ % 100) +#endif + +#if defined(JSON_HEDLEY_TINYC_VERSION_CHECK) + #undef JSON_HEDLEY_TINYC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TINYC_VERSION) + #define JSON_HEDLEY_TINYC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TINYC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TINYC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_DMC_VERSION) + #undef JSON_HEDLEY_DMC_VERSION +#endif +#if defined(__DMC__) + #define JSON_HEDLEY_DMC_VERSION JSON_HEDLEY_VERSION_ENCODE(__DMC__ >> 8, (__DMC__ >> 4) & 0xf, __DMC__ & 0xf) +#endif + +#if defined(JSON_HEDLEY_DMC_VERSION_CHECK) + #undef JSON_HEDLEY_DMC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_DMC_VERSION) + #define JSON_HEDLEY_DMC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_DMC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_DMC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_COMPCERT_VERSION) + #undef JSON_HEDLEY_COMPCERT_VERSION +#endif +#if defined(__COMPCERT_VERSION__) + #define JSON_HEDLEY_COMPCERT_VERSION JSON_HEDLEY_VERSION_ENCODE(__COMPCERT_VERSION__ / 10000, (__COMPCERT_VERSION__ / 100) % 100, __COMPCERT_VERSION__ % 100) +#endif + +#if defined(JSON_HEDLEY_COMPCERT_VERSION_CHECK) + #undef JSON_HEDLEY_COMPCERT_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_COMPCERT_VERSION) + #define JSON_HEDLEY_COMPCERT_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_COMPCERT_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_COMPCERT_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_PELLES_VERSION) + #undef JSON_HEDLEY_PELLES_VERSION +#endif +#if defined(__POCC__) + #define JSON_HEDLEY_PELLES_VERSION JSON_HEDLEY_VERSION_ENCODE(__POCC__ / 100, __POCC__ % 100, 0) +#endif + +#if defined(JSON_HEDLEY_PELLES_VERSION_CHECK) + #undef JSON_HEDLEY_PELLES_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_PELLES_VERSION) + #define JSON_HEDLEY_PELLES_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_PELLES_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_PELLES_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_GCC_VERSION) + #undef JSON_HEDLEY_GCC_VERSION +#endif +#if \ + defined(JSON_HEDLEY_GNUC_VERSION) && \ + !defined(__clang__) && \ + !defined(JSON_HEDLEY_INTEL_VERSION) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_ARM_VERSION) && \ + !defined(JSON_HEDLEY_TI_VERSION) && \ + !defined(JSON_HEDLEY_TI_ARMCL_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL430_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL2000_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL6X_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL7X_VERSION) && \ + !defined(JSON_HEDLEY_TI_CLPRU_VERSION) && \ + !defined(__COMPCERT__) + #define JSON_HEDLEY_GCC_VERSION JSON_HEDLEY_GNUC_VERSION +#endif + +#if defined(JSON_HEDLEY_GCC_VERSION_CHECK) + #undef JSON_HEDLEY_GCC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_GCC_VERSION) + #define JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_GCC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_ATTRIBUTE +#endif +#if defined(__has_attribute) + #define JSON_HEDLEY_HAS_ATTRIBUTE(attribute) __has_attribute(attribute) +#else + #define JSON_HEDLEY_HAS_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_ATTRIBUTE +#endif +#if defined(__has_attribute) + #define JSON_HEDLEY_GNUC_HAS_ATTRIBUTE(attribute,major,minor,patch) __has_attribute(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_ATTRIBUTE +#endif +#if defined(__has_attribute) + #define JSON_HEDLEY_GCC_HAS_ATTRIBUTE(attribute,major,minor,patch) __has_attribute(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE +#endif +#if \ + defined(__has_cpp_attribute) && \ + defined(__cplusplus) && \ + (!defined(JSON_HEDLEY_SUNPRO_VERSION) || JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0)) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS) + #undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS +#endif +#if !defined(__cplusplus) || !defined(__has_cpp_attribute) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) (0) +#elif \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_IAR_VERSION) && \ + (!defined(JSON_HEDLEY_SUNPRO_VERSION) || JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0)) && \ + (!defined(JSON_HEDLEY_MSVC_VERSION) || JSON_HEDLEY_MSVC_VERSION_CHECK(19,20,0)) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) JSON_HEDLEY_HAS_CPP_ATTRIBUTE(ns::attribute) +#else + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE +#endif +#if defined(__has_cpp_attribute) && defined(__cplusplus) + #define JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE +#endif +#if defined(__has_cpp_attribute) && defined(__cplusplus) + #define JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_BUILTIN) + #undef JSON_HEDLEY_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_HAS_BUILTIN(builtin) __has_builtin(builtin) +#else + #define JSON_HEDLEY_HAS_BUILTIN(builtin) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_BUILTIN) + #undef JSON_HEDLEY_GNUC_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_GNUC_HAS_BUILTIN(builtin,major,minor,patch) __has_builtin(builtin) +#else + #define JSON_HEDLEY_GNUC_HAS_BUILTIN(builtin,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_BUILTIN) + #undef JSON_HEDLEY_GCC_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_GCC_HAS_BUILTIN(builtin,major,minor,patch) __has_builtin(builtin) +#else + #define JSON_HEDLEY_GCC_HAS_BUILTIN(builtin,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_FEATURE) + #undef JSON_HEDLEY_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_HAS_FEATURE(feature) __has_feature(feature) +#else + #define JSON_HEDLEY_HAS_FEATURE(feature) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_FEATURE) + #undef JSON_HEDLEY_GNUC_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_GNUC_HAS_FEATURE(feature,major,minor,patch) __has_feature(feature) +#else + #define JSON_HEDLEY_GNUC_HAS_FEATURE(feature,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_FEATURE) + #undef JSON_HEDLEY_GCC_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_GCC_HAS_FEATURE(feature,major,minor,patch) __has_feature(feature) +#else + #define JSON_HEDLEY_GCC_HAS_FEATURE(feature,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_EXTENSION) + #undef JSON_HEDLEY_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_HAS_EXTENSION(extension) __has_extension(extension) +#else + #define JSON_HEDLEY_HAS_EXTENSION(extension) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_EXTENSION) + #undef JSON_HEDLEY_GNUC_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_GNUC_HAS_EXTENSION(extension,major,minor,patch) __has_extension(extension) +#else + #define JSON_HEDLEY_GNUC_HAS_EXTENSION(extension,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_EXTENSION) + #undef JSON_HEDLEY_GCC_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_GCC_HAS_EXTENSION(extension,major,minor,patch) __has_extension(extension) +#else + #define JSON_HEDLEY_GCC_HAS_EXTENSION(extension,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_WARNING) + #undef JSON_HEDLEY_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_HAS_WARNING(warning) __has_warning(warning) +#else + #define JSON_HEDLEY_HAS_WARNING(warning) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_WARNING) + #undef JSON_HEDLEY_GNUC_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_GNUC_HAS_WARNING(warning,major,minor,patch) __has_warning(warning) +#else + #define JSON_HEDLEY_GNUC_HAS_WARNING(warning,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_WARNING) + #undef JSON_HEDLEY_GCC_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_GCC_HAS_WARNING(warning,major,minor,patch) __has_warning(warning) +#else + #define JSON_HEDLEY_GCC_HAS_WARNING(warning,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +/* JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_ is for + HEDLEY INTERNAL USE ONLY. API subject to change without notice. */ +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_ +#endif +#if defined(__cplusplus) +# if JSON_HEDLEY_HAS_WARNING("-Wc++98-compat") +# if JSON_HEDLEY_HAS_WARNING("-Wc++17-extensions") +# define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(xpr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wc++98-compat\"") \ + _Pragma("clang diagnostic ignored \"-Wc++17-extensions\"") \ + xpr \ + JSON_HEDLEY_DIAGNOSTIC_POP +# else +# define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(xpr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wc++98-compat\"") \ + xpr \ + JSON_HEDLEY_DIAGNOSTIC_POP +# endif +# endif +#endif +#if !defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(x) x +#endif + +#if defined(JSON_HEDLEY_CONST_CAST) + #undef JSON_HEDLEY_CONST_CAST +#endif +#if defined(__cplusplus) +# define JSON_HEDLEY_CONST_CAST(T, expr) (const_cast(expr)) +#elif \ + JSON_HEDLEY_HAS_WARNING("-Wcast-qual") || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_CONST_CAST(T, expr) (__extension__ ({ \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL \ + ((T) (expr)); \ + JSON_HEDLEY_DIAGNOSTIC_POP \ + })) +#else +# define JSON_HEDLEY_CONST_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_REINTERPRET_CAST) + #undef JSON_HEDLEY_REINTERPRET_CAST +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_REINTERPRET_CAST(T, expr) (reinterpret_cast(expr)) +#else + #define JSON_HEDLEY_REINTERPRET_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_STATIC_CAST) + #undef JSON_HEDLEY_STATIC_CAST +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_STATIC_CAST(T, expr) (static_cast(expr)) +#else + #define JSON_HEDLEY_STATIC_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_CPP_CAST) + #undef JSON_HEDLEY_CPP_CAST +#endif +#if defined(__cplusplus) +# if JSON_HEDLEY_HAS_WARNING("-Wold-style-cast") +# define JSON_HEDLEY_CPP_CAST(T, expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wold-style-cast\"") \ + ((T) (expr)) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# elif JSON_HEDLEY_IAR_VERSION_CHECK(8,3,0) +# define JSON_HEDLEY_CPP_CAST(T, expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("diag_suppress=Pe137") \ + JSON_HEDLEY_DIAGNOSTIC_POP \ +# else +# define JSON_HEDLEY_CPP_CAST(T, expr) ((T) (expr)) +# endif +#else +# define JSON_HEDLEY_CPP_CAST(T, expr) (expr) +#endif + +#if \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \ + defined(__clang__) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,4,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,7,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(2,0,1) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(5,0,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,17) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(8,0,0) || \ + (JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) && defined(__C99_PRAGMA_OPERATOR)) + #define JSON_HEDLEY_PRAGMA(value) _Pragma(#value) +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_PRAGMA(value) __pragma(value) +#else + #define JSON_HEDLEY_PRAGMA(value) +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_PUSH) + #undef JSON_HEDLEY_DIAGNOSTIC_PUSH +#endif +#if defined(JSON_HEDLEY_DIAGNOSTIC_POP) + #undef JSON_HEDLEY_DIAGNOSTIC_POP +#endif +#if defined(__clang__) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("clang diagnostic push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("clang diagnostic pop") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("warning(push)") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("warning(pop)") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("GCC diagnostic pop") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH __pragma(warning(push)) + #define JSON_HEDLEY_DIAGNOSTIC_POP __pragma(warning(pop)) +#elif JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("pop") +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,4,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("diag_push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("diag_pop") +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,90,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("warning(push)") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("warning(pop)") +#else + #define JSON_HEDLEY_DIAGNOSTIC_PUSH + #define JSON_HEDLEY_DIAGNOSTIC_POP +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wdeprecated-declarations") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("warning(disable:1478 1786)") +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1215,1444") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED __pragma(warning(disable:4996)) +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1291,1718") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) && !defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("error_messages(off,E_DEPRECATED_ATT,E_DEPRECATED_ATT_MESS)") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) && defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("error_messages(off,symdeprecated,symdeprecated2)") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress=Pe1444,Pe1215") +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,90,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("warn(disable:2241)") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("clang diagnostic ignored \"-Wunknown-pragmas\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("warning(disable:161)") +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 1675") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("GCC diagnostic ignored \"-Wunknown-pragmas\"") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS __pragma(warning(disable:4068)) +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(16,9,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 163") +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 163") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress=Pe161") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-attributes") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("clang diagnostic ignored \"-Wunknown-attributes\"") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(17,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("warning(disable:1292)") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(19,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES __pragma(warning(disable:5030)) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1097") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,14,0) && defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("error_messages(off,attrskipunsup)") +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,3,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1173") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress=Pe1097") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wcast-qual") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("clang diagnostic ignored \"-Wcast-qual\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("warning(disable:2203 2331)") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("GCC diagnostic ignored \"-Wcast-qual\"") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL +#endif + +#if defined(JSON_HEDLEY_DEPRECATED) + #undef JSON_HEDLEY_DEPRECATED +#endif +#if defined(JSON_HEDLEY_DEPRECATED_FOR) + #undef JSON_HEDLEY_DEPRECATED_FOR +#endif +#if JSON_HEDLEY_MSVC_VERSION_CHECK(14,0,0) + #define JSON_HEDLEY_DEPRECATED(since) __declspec(deprecated("Since " # since)) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated("Since " #since "; use " #replacement)) +#elif defined(__cplusplus) && (__cplusplus >= 201402L) + #define JSON_HEDLEY_DEPRECATED(since) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[deprecated("Since " #since)]]) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[deprecated("Since " #since "; use " #replacement)]]) +#elif \ + JSON_HEDLEY_HAS_EXTENSION(attribute_deprecated_with_message) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,5,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,3,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,3,0) + #define JSON_HEDLEY_DEPRECATED(since) __attribute__((__deprecated__("Since " #since))) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__("Since " #since "; use " #replacement))) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(deprecated) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_DEPRECATED(since) __attribute__((__deprecated__)) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__)) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_PELLES_VERSION_CHECK(6,50,0) + #define JSON_HEDLEY_DEPRECATED(since) __declspec(deprecated) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated) +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DEPRECATED(since) _Pragma("deprecated") + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) _Pragma("deprecated") +#else + #define JSON_HEDLEY_DEPRECATED(since) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) +#endif + +#if defined(JSON_HEDLEY_UNAVAILABLE) + #undef JSON_HEDLEY_UNAVAILABLE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(warning) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_UNAVAILABLE(available_since) __attribute__((__warning__("Not available until " #available_since))) +#else + #define JSON_HEDLEY_UNAVAILABLE(available_since) +#endif + +#if defined(JSON_HEDLEY_WARN_UNUSED_RESULT) + #undef JSON_HEDLEY_WARN_UNUSED_RESULT +#endif +#if defined(JSON_HEDLEY_WARN_UNUSED_RESULT_MSG) + #undef JSON_HEDLEY_WARN_UNUSED_RESULT_MSG +#endif +#if (JSON_HEDLEY_HAS_CPP_ATTRIBUTE(nodiscard) >= 201907L) + #define JSON_HEDLEY_WARN_UNUSED_RESULT JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard(msg)]]) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE(nodiscard) + #define JSON_HEDLEY_WARN_UNUSED_RESULT JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(warn_unused_result) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__)) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) __attribute__((__warn_unused_result__)) +#elif defined(_Check_return_) /* SAL */ + #define JSON_HEDLEY_WARN_UNUSED_RESULT _Check_return_ + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) _Check_return_ +#else + #define JSON_HEDLEY_WARN_UNUSED_RESULT + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) +#endif + +#if defined(JSON_HEDLEY_SENTINEL) + #undef JSON_HEDLEY_SENTINEL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(sentinel) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,4,0) + #define JSON_HEDLEY_SENTINEL(position) __attribute__((__sentinel__(position))) +#else + #define JSON_HEDLEY_SENTINEL(position) +#endif + +#if defined(JSON_HEDLEY_NO_RETURN) + #undef JSON_HEDLEY_NO_RETURN +#endif +#if JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_NO_RETURN __noreturn +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_NO_RETURN __attribute__((__noreturn__)) +#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L + #define JSON_HEDLEY_NO_RETURN _Noreturn +#elif defined(__cplusplus) && (__cplusplus >= 201103L) + #define JSON_HEDLEY_NO_RETURN JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[noreturn]]) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(noreturn) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,2,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_NO_RETURN __attribute__((__noreturn__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_NO_RETURN _Pragma("does_not_return") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) + #define JSON_HEDLEY_NO_RETURN __declspec(noreturn) +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,0,0) && defined(__cplusplus) + #define JSON_HEDLEY_NO_RETURN _Pragma("FUNC_NEVER_RETURNS;") +#elif JSON_HEDLEY_COMPCERT_VERSION_CHECK(3,2,0) + #define JSON_HEDLEY_NO_RETURN __attribute((noreturn)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(9,0,0) + #define JSON_HEDLEY_NO_RETURN __declspec(noreturn) +#else + #define JSON_HEDLEY_NO_RETURN +#endif + +#if defined(JSON_HEDLEY_NO_ESCAPE) + #undef JSON_HEDLEY_NO_ESCAPE +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(noescape) + #define JSON_HEDLEY_NO_ESCAPE __attribute__((__noescape__)) +#else + #define JSON_HEDLEY_NO_ESCAPE +#endif + +#if defined(JSON_HEDLEY_UNREACHABLE) + #undef JSON_HEDLEY_UNREACHABLE +#endif +#if defined(JSON_HEDLEY_UNREACHABLE_RETURN) + #undef JSON_HEDLEY_UNREACHABLE_RETURN +#endif +#if defined(JSON_HEDLEY_ASSUME) + #undef JSON_HEDLEY_ASSUME +#endif +#if \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_ASSUME(expr) __assume(expr) +#elif JSON_HEDLEY_HAS_BUILTIN(__builtin_assume) + #define JSON_HEDLEY_ASSUME(expr) __builtin_assume(expr) +#elif \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) + #if defined(__cplusplus) + #define JSON_HEDLEY_ASSUME(expr) std::_nassert(expr) + #else + #define JSON_HEDLEY_ASSUME(expr) _nassert(expr) + #endif +#endif +#if \ + (JSON_HEDLEY_HAS_BUILTIN(__builtin_unreachable) && (!defined(JSON_HEDLEY_ARM_VERSION))) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,5,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,10,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,5) + #define JSON_HEDLEY_UNREACHABLE() __builtin_unreachable() +#elif defined(JSON_HEDLEY_ASSUME) + #define JSON_HEDLEY_UNREACHABLE() JSON_HEDLEY_ASSUME(0) +#endif +#if !defined(JSON_HEDLEY_ASSUME) + #if defined(JSON_HEDLEY_UNREACHABLE) + #define JSON_HEDLEY_ASSUME(expr) JSON_HEDLEY_STATIC_CAST(void, ((expr) ? 1 : (JSON_HEDLEY_UNREACHABLE(), 1))) + #else + #define JSON_HEDLEY_ASSUME(expr) JSON_HEDLEY_STATIC_CAST(void, expr) + #endif +#endif +#if defined(JSON_HEDLEY_UNREACHABLE) + #if \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) return (JSON_HEDLEY_STATIC_CAST(void, JSON_HEDLEY_ASSUME(0)), (value)) + #else + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) JSON_HEDLEY_UNREACHABLE() + #endif +#else + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) return (value) +#endif +#if !defined(JSON_HEDLEY_UNREACHABLE) + #define JSON_HEDLEY_UNREACHABLE() JSON_HEDLEY_ASSUME(0) +#endif + +JSON_HEDLEY_DIAGNOSTIC_PUSH +#if JSON_HEDLEY_HAS_WARNING("-Wpedantic") + #pragma clang diagnostic ignored "-Wpedantic" +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wc++98-compat-pedantic") && defined(__cplusplus) + #pragma clang diagnostic ignored "-Wc++98-compat-pedantic" +#endif +#if JSON_HEDLEY_GCC_HAS_WARNING("-Wvariadic-macros",4,0,0) + #if defined(__clang__) + #pragma clang diagnostic ignored "-Wvariadic-macros" + #elif defined(JSON_HEDLEY_GCC_VERSION) + #pragma GCC diagnostic ignored "-Wvariadic-macros" + #endif +#endif +#if defined(JSON_HEDLEY_NON_NULL) + #undef JSON_HEDLEY_NON_NULL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(nonnull) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) + #define JSON_HEDLEY_NON_NULL(...) __attribute__((__nonnull__(__VA_ARGS__))) +#else + #define JSON_HEDLEY_NON_NULL(...) +#endif +JSON_HEDLEY_DIAGNOSTIC_POP + +#if defined(JSON_HEDLEY_PRINTF_FORMAT) + #undef JSON_HEDLEY_PRINTF_FORMAT +#endif +#if defined(__MINGW32__) && JSON_HEDLEY_GCC_HAS_ATTRIBUTE(format,4,4,0) && !defined(__USE_MINGW_ANSI_STDIO) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(ms_printf, string_idx, first_to_check))) +#elif defined(__MINGW32__) && JSON_HEDLEY_GCC_HAS_ATTRIBUTE(format,4,4,0) && defined(__USE_MINGW_ANSI_STDIO) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(gnu_printf, string_idx, first_to_check))) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(format) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(__printf__, string_idx, first_to_check))) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(6,0,0) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __declspec(vaformat(printf,string_idx,first_to_check)) +#else + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) +#endif + +#if defined(JSON_HEDLEY_CONSTEXPR) + #undef JSON_HEDLEY_CONSTEXPR +#endif +#if defined(__cplusplus) + #if __cplusplus >= 201103L + #define JSON_HEDLEY_CONSTEXPR JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(constexpr) + #endif +#endif +#if !defined(JSON_HEDLEY_CONSTEXPR) + #define JSON_HEDLEY_CONSTEXPR +#endif + +#if defined(JSON_HEDLEY_PREDICT) + #undef JSON_HEDLEY_PREDICT +#endif +#if defined(JSON_HEDLEY_LIKELY) + #undef JSON_HEDLEY_LIKELY +#endif +#if defined(JSON_HEDLEY_UNLIKELY) + #undef JSON_HEDLEY_UNLIKELY +#endif +#if defined(JSON_HEDLEY_UNPREDICTABLE) + #undef JSON_HEDLEY_UNPREDICTABLE +#endif +#if JSON_HEDLEY_HAS_BUILTIN(__builtin_unpredictable) + #define JSON_HEDLEY_UNPREDICTABLE(expr) __builtin_unpredictable((expr)) +#endif +#if \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_expect_with_probability) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(9,0,0) +# define JSON_HEDLEY_PREDICT(expr, value, probability) __builtin_expect_with_probability( (expr), (value), (probability)) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) __builtin_expect_with_probability(!!(expr), 1 , (probability)) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) __builtin_expect_with_probability(!!(expr), 0 , (probability)) +# define JSON_HEDLEY_LIKELY(expr) __builtin_expect (!!(expr), 1 ) +# define JSON_HEDLEY_UNLIKELY(expr) __builtin_expect (!!(expr), 0 ) +#elif \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_expect) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,7,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,27) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) +# define JSON_HEDLEY_PREDICT(expr, expected, probability) \ + (((probability) >= 0.9) ? __builtin_expect((expr), (expected)) : (JSON_HEDLEY_STATIC_CAST(void, expected), (expr))) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) \ + (__extension__ ({ \ + double hedley_probability_ = (probability); \ + ((hedley_probability_ >= 0.9) ? __builtin_expect(!!(expr), 1) : ((hedley_probability_ <= 0.1) ? __builtin_expect(!!(expr), 0) : !!(expr))); \ + })) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) \ + (__extension__ ({ \ + double hedley_probability_ = (probability); \ + ((hedley_probability_ >= 0.9) ? __builtin_expect(!!(expr), 0) : ((hedley_probability_ <= 0.1) ? __builtin_expect(!!(expr), 1) : !!(expr))); \ + })) +# define JSON_HEDLEY_LIKELY(expr) __builtin_expect(!!(expr), 1) +# define JSON_HEDLEY_UNLIKELY(expr) __builtin_expect(!!(expr), 0) +#else +# define JSON_HEDLEY_PREDICT(expr, expected, probability) (JSON_HEDLEY_STATIC_CAST(void, expected), (expr)) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) (!!(expr)) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) (!!(expr)) +# define JSON_HEDLEY_LIKELY(expr) (!!(expr)) +# define JSON_HEDLEY_UNLIKELY(expr) (!!(expr)) +#endif +#if !defined(JSON_HEDLEY_UNPREDICTABLE) + #define JSON_HEDLEY_UNPREDICTABLE(expr) JSON_HEDLEY_PREDICT(expr, 1, 0.5) +#endif + +#if defined(JSON_HEDLEY_MALLOC) + #undef JSON_HEDLEY_MALLOC +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(malloc) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(12,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_MALLOC __attribute__((__malloc__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_MALLOC _Pragma("returns_new_memory") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(14, 0, 0) + #define JSON_HEDLEY_MALLOC __declspec(restrict) +#else + #define JSON_HEDLEY_MALLOC +#endif + +#if defined(JSON_HEDLEY_PURE) + #undef JSON_HEDLEY_PURE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(pure) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(2,96,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) +# define JSON_HEDLEY_PURE __attribute__((__pure__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) +# define JSON_HEDLEY_PURE _Pragma("does_not_write_global_data") +#elif defined(__cplusplus) && \ + ( \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(2,0,1) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) \ + ) +# define JSON_HEDLEY_PURE _Pragma("FUNC_IS_PURE;") +#else +# define JSON_HEDLEY_PURE +#endif + +#if defined(JSON_HEDLEY_CONST) + #undef JSON_HEDLEY_CONST +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(const) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(2,5,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_CONST __attribute__((__const__)) +#elif \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_CONST _Pragma("no_side_effect") +#else + #define JSON_HEDLEY_CONST JSON_HEDLEY_PURE +#endif + +#if defined(JSON_HEDLEY_RESTRICT) + #undef JSON_HEDLEY_RESTRICT +#endif +#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && !defined(__cplusplus) + #define JSON_HEDLEY_RESTRICT restrict +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_MSVC_VERSION_CHECK(14,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,4) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,14,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) || \ + defined(__clang__) + #define JSON_HEDLEY_RESTRICT __restrict +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,3,0) && !defined(__cplusplus) + #define JSON_HEDLEY_RESTRICT _Restrict +#else + #define JSON_HEDLEY_RESTRICT +#endif + +#if defined(JSON_HEDLEY_INLINE) + #undef JSON_HEDLEY_INLINE +#endif +#if \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \ + (defined(__cplusplus) && (__cplusplus >= 199711L)) + #define JSON_HEDLEY_INLINE inline +#elif \ + defined(JSON_HEDLEY_GCC_VERSION) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(6,2,0) + #define JSON_HEDLEY_INLINE __inline__ +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(12,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,1,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_INLINE __inline +#else + #define JSON_HEDLEY_INLINE +#endif + +#if defined(JSON_HEDLEY_ALWAYS_INLINE) + #undef JSON_HEDLEY_ALWAYS_INLINE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(always_inline) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) +# define JSON_HEDLEY_ALWAYS_INLINE __attribute__((__always_inline__)) JSON_HEDLEY_INLINE +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(12,0,0) +# define JSON_HEDLEY_ALWAYS_INLINE __forceinline +#elif defined(__cplusplus) && \ + ( \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) \ + ) +# define JSON_HEDLEY_ALWAYS_INLINE _Pragma("FUNC_ALWAYS_INLINE;") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) +# define JSON_HEDLEY_ALWAYS_INLINE _Pragma("inline=forced") +#else +# define JSON_HEDLEY_ALWAYS_INLINE JSON_HEDLEY_INLINE +#endif + +#if defined(JSON_HEDLEY_NEVER_INLINE) + #undef JSON_HEDLEY_NEVER_INLINE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(noinline) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_NEVER_INLINE __attribute__((__noinline__)) +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) + #define JSON_HEDLEY_NEVER_INLINE __declspec(noinline) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(10,2,0) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("noinline") +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,0,0) && defined(__cplusplus) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("FUNC_CANNOT_INLINE;") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("inline=never") +#elif JSON_HEDLEY_COMPCERT_VERSION_CHECK(3,2,0) + #define JSON_HEDLEY_NEVER_INLINE __attribute((noinline)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(9,0,0) + #define JSON_HEDLEY_NEVER_INLINE __declspec(noinline) +#else + #define JSON_HEDLEY_NEVER_INLINE +#endif + +#if defined(JSON_HEDLEY_PRIVATE) + #undef JSON_HEDLEY_PRIVATE +#endif +#if defined(JSON_HEDLEY_PUBLIC) + #undef JSON_HEDLEY_PUBLIC +#endif +#if defined(JSON_HEDLEY_IMPORT) + #undef JSON_HEDLEY_IMPORT +#endif +#if defined(_WIN32) || defined(__CYGWIN__) +# define JSON_HEDLEY_PRIVATE +# define JSON_HEDLEY_PUBLIC __declspec(dllexport) +# define JSON_HEDLEY_IMPORT __declspec(dllimport) +#else +# if \ + JSON_HEDLEY_HAS_ATTRIBUTE(visibility) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + ( \ + defined(__TI_EABI__) && \ + ( \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) \ + ) \ + ) +# define JSON_HEDLEY_PRIVATE __attribute__((__visibility__("hidden"))) +# define JSON_HEDLEY_PUBLIC __attribute__((__visibility__("default"))) +# else +# define JSON_HEDLEY_PRIVATE +# define JSON_HEDLEY_PUBLIC +# endif +# define JSON_HEDLEY_IMPORT extern +#endif + +#if defined(JSON_HEDLEY_NO_THROW) + #undef JSON_HEDLEY_NO_THROW +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(nothrow) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_NO_THROW __attribute__((__nothrow__)) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) + #define JSON_HEDLEY_NO_THROW __declspec(nothrow) +#else + #define JSON_HEDLEY_NO_THROW +#endif + +#if defined(JSON_HEDLEY_FALL_THROUGH) + #undef JSON_HEDLEY_FALL_THROUGH +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(fallthrough) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(7,0,0) + #define JSON_HEDLEY_FALL_THROUGH __attribute__((__fallthrough__)) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(clang,fallthrough) + #define JSON_HEDLEY_FALL_THROUGH JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[clang::fallthrough]]) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE(fallthrough) + #define JSON_HEDLEY_FALL_THROUGH JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[fallthrough]]) +#elif defined(__fallthrough) /* SAL */ + #define JSON_HEDLEY_FALL_THROUGH __fallthrough +#else + #define JSON_HEDLEY_FALL_THROUGH +#endif + +#if defined(JSON_HEDLEY_RETURNS_NON_NULL) + #undef JSON_HEDLEY_RETURNS_NON_NULL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(returns_nonnull) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,9,0) + #define JSON_HEDLEY_RETURNS_NON_NULL __attribute__((__returns_nonnull__)) +#elif defined(_Ret_notnull_) /* SAL */ + #define JSON_HEDLEY_RETURNS_NON_NULL _Ret_notnull_ +#else + #define JSON_HEDLEY_RETURNS_NON_NULL +#endif + +#if defined(JSON_HEDLEY_ARRAY_PARAM) + #undef JSON_HEDLEY_ARRAY_PARAM +#endif +#if \ + defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \ + !defined(__STDC_NO_VLA__) && \ + !defined(__cplusplus) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_TINYC_VERSION) + #define JSON_HEDLEY_ARRAY_PARAM(name) (name) +#else + #define JSON_HEDLEY_ARRAY_PARAM(name) +#endif + +#if defined(JSON_HEDLEY_IS_CONSTANT) + #undef JSON_HEDLEY_IS_CONSTANT +#endif +#if defined(JSON_HEDLEY_REQUIRE_CONSTEXPR) + #undef JSON_HEDLEY_REQUIRE_CONSTEXPR +#endif +/* JSON_HEDLEY_IS_CONSTEXPR_ is for + HEDLEY INTERNAL USE ONLY. API subject to change without notice. */ +#if defined(JSON_HEDLEY_IS_CONSTEXPR_) + #undef JSON_HEDLEY_IS_CONSTEXPR_ +#endif +#if \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_constant_p) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,19) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) && !defined(__cplusplus)) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) + #define JSON_HEDLEY_IS_CONSTANT(expr) __builtin_constant_p(expr) +#endif +#if !defined(__cplusplus) +# if \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_types_compatible_p) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,4,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,24) +#if defined(__INTPTR_TYPE__) + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) __builtin_types_compatible_p(__typeof__((1 ? (void*) ((__INTPTR_TYPE__) ((expr) * 0)) : (int*) 0)), int*) +#else + #include + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) __builtin_types_compatible_p(__typeof__((1 ? (void*) ((intptr_t) ((expr) * 0)) : (int*) 0)), int*) +#endif +# elif \ + ( \ + defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && \ + !defined(JSON_HEDLEY_SUNPRO_VERSION) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_IAR_VERSION)) || \ + JSON_HEDLEY_HAS_EXTENSION(c_generic_selections) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,9,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(17,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(12,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,3,0) +#if defined(__INTPTR_TYPE__) + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) _Generic((1 ? (void*) ((__INTPTR_TYPE__) ((expr) * 0)) : (int*) 0), int*: 1, void*: 0) +#else + #include + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) _Generic((1 ? (void*) ((intptr_t) * 0) : (int*) 0), int*: 1, void*: 0) +#endif +# elif \ + defined(JSON_HEDLEY_GCC_VERSION) || \ + defined(JSON_HEDLEY_INTEL_VERSION) || \ + defined(JSON_HEDLEY_TINYC_VERSION) || \ + defined(JSON_HEDLEY_TI_ARMCL_VERSION) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(18,12,0) || \ + defined(JSON_HEDLEY_TI_CL2000_VERSION) || \ + defined(JSON_HEDLEY_TI_CL6X_VERSION) || \ + defined(JSON_HEDLEY_TI_CL7X_VERSION) || \ + defined(JSON_HEDLEY_TI_CLPRU_VERSION) || \ + defined(__clang__) +# define JSON_HEDLEY_IS_CONSTEXPR_(expr) ( \ + sizeof(void) != \ + sizeof(*( \ + 1 ? \ + ((void*) ((expr) * 0L) ) : \ +((struct { char v[sizeof(void) * 2]; } *) 1) \ + ) \ + ) \ + ) +# endif +#endif +#if defined(JSON_HEDLEY_IS_CONSTEXPR_) + #if !defined(JSON_HEDLEY_IS_CONSTANT) + #define JSON_HEDLEY_IS_CONSTANT(expr) JSON_HEDLEY_IS_CONSTEXPR_(expr) + #endif + #define JSON_HEDLEY_REQUIRE_CONSTEXPR(expr) (JSON_HEDLEY_IS_CONSTEXPR_(expr) ? (expr) : (-1)) +#else + #if !defined(JSON_HEDLEY_IS_CONSTANT) + #define JSON_HEDLEY_IS_CONSTANT(expr) (0) + #endif + #define JSON_HEDLEY_REQUIRE_CONSTEXPR(expr) (expr) +#endif + +#if defined(JSON_HEDLEY_BEGIN_C_DECLS) + #undef JSON_HEDLEY_BEGIN_C_DECLS +#endif +#if defined(JSON_HEDLEY_END_C_DECLS) + #undef JSON_HEDLEY_END_C_DECLS +#endif +#if defined(JSON_HEDLEY_C_DECL) + #undef JSON_HEDLEY_C_DECL +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_BEGIN_C_DECLS extern "C" { + #define JSON_HEDLEY_END_C_DECLS } + #define JSON_HEDLEY_C_DECL extern "C" +#else + #define JSON_HEDLEY_BEGIN_C_DECLS + #define JSON_HEDLEY_END_C_DECLS + #define JSON_HEDLEY_C_DECL +#endif + +#if defined(JSON_HEDLEY_STATIC_ASSERT) + #undef JSON_HEDLEY_STATIC_ASSERT +#endif +#if \ + !defined(__cplusplus) && ( \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)) || \ + JSON_HEDLEY_HAS_FEATURE(c_static_assert) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(6,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + defined(_Static_assert) \ + ) +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) _Static_assert(expr, message) +#elif \ + (defined(__cplusplus) && (__cplusplus >= 201103L)) || \ + JSON_HEDLEY_MSVC_VERSION_CHECK(16,0,0) +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(static_assert(expr, message)) +#else +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) +#endif + +#if defined(JSON_HEDLEY_NULL) + #undef JSON_HEDLEY_NULL +#endif +#if defined(__cplusplus) + #if __cplusplus >= 201103L + #define JSON_HEDLEY_NULL JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(nullptr) + #elif defined(NULL) + #define JSON_HEDLEY_NULL NULL + #else + #define JSON_HEDLEY_NULL JSON_HEDLEY_STATIC_CAST(void*, 0) + #endif +#elif defined(NULL) + #define JSON_HEDLEY_NULL NULL +#else + #define JSON_HEDLEY_NULL ((void*) 0) +#endif + +#if defined(JSON_HEDLEY_MESSAGE) + #undef JSON_HEDLEY_MESSAGE +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") +# define JSON_HEDLEY_MESSAGE(msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS \ + JSON_HEDLEY_PRAGMA(message msg) \ + JSON_HEDLEY_DIAGNOSTIC_POP +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message msg) +#elif JSON_HEDLEY_CRAY_VERSION_CHECK(5,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(_CRI message msg) +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#else +# define JSON_HEDLEY_MESSAGE(msg) +#endif + +#if defined(JSON_HEDLEY_WARNING) + #undef JSON_HEDLEY_WARNING +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") +# define JSON_HEDLEY_WARNING(msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS \ + JSON_HEDLEY_PRAGMA(clang warning msg) \ + JSON_HEDLEY_DIAGNOSTIC_POP +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,8,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_PRAGMA(GCC warning msg) +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#else +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_MESSAGE(msg) +#endif + +#if defined(JSON_HEDLEY_REQUIRE) + #undef JSON_HEDLEY_REQUIRE +#endif +#if defined(JSON_HEDLEY_REQUIRE_MSG) + #undef JSON_HEDLEY_REQUIRE_MSG +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(diagnose_if) +# if JSON_HEDLEY_HAS_WARNING("-Wgcc-compat") +# define JSON_HEDLEY_REQUIRE(expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \ + __attribute__((diagnose_if(!(expr), #expr, "error"))) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \ + __attribute__((diagnose_if(!(expr), msg, "error"))) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# else +# define JSON_HEDLEY_REQUIRE(expr) __attribute__((diagnose_if(!(expr), #expr, "error"))) +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) __attribute__((diagnose_if(!(expr), msg, "error"))) +# endif +#else +# define JSON_HEDLEY_REQUIRE(expr) +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) +#endif + +#if defined(JSON_HEDLEY_FLAGS) + #undef JSON_HEDLEY_FLAGS +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(flag_enum) + #define JSON_HEDLEY_FLAGS __attribute__((__flag_enum__)) +#endif + +#if defined(JSON_HEDLEY_FLAGS_CAST) + #undef JSON_HEDLEY_FLAGS_CAST +#endif +#if JSON_HEDLEY_INTEL_VERSION_CHECK(19,0,0) +# define JSON_HEDLEY_FLAGS_CAST(T, expr) (__extension__ ({ \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("warning(disable:188)") \ + ((T) (expr)); \ + JSON_HEDLEY_DIAGNOSTIC_POP \ + })) +#else +# define JSON_HEDLEY_FLAGS_CAST(T, expr) JSON_HEDLEY_STATIC_CAST(T, expr) +#endif + +#if defined(JSON_HEDLEY_EMPTY_BASES) + #undef JSON_HEDLEY_EMPTY_BASES +#endif +#if JSON_HEDLEY_MSVC_VERSION_CHECK(19,0,23918) && !JSON_HEDLEY_MSVC_VERSION_CHECK(20,0,0) + #define JSON_HEDLEY_EMPTY_BASES __declspec(empty_bases) +#else + #define JSON_HEDLEY_EMPTY_BASES +#endif + +/* Remaining macros are deprecated. */ + +#if defined(JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK) + #undef JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK +#endif +#if defined(__clang__) + #define JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK(major,minor,patch) (0) +#else + #define JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK(major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_CLANG_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_BUILTIN) + #undef JSON_HEDLEY_CLANG_HAS_BUILTIN +#endif +#define JSON_HEDLEY_CLANG_HAS_BUILTIN(builtin) JSON_HEDLEY_HAS_BUILTIN(builtin) + +#if defined(JSON_HEDLEY_CLANG_HAS_FEATURE) + #undef JSON_HEDLEY_CLANG_HAS_FEATURE +#endif +#define JSON_HEDLEY_CLANG_HAS_FEATURE(feature) JSON_HEDLEY_HAS_FEATURE(feature) + +#if defined(JSON_HEDLEY_CLANG_HAS_EXTENSION) + #undef JSON_HEDLEY_CLANG_HAS_EXTENSION +#endif +#define JSON_HEDLEY_CLANG_HAS_EXTENSION(extension) JSON_HEDLEY_HAS_EXTENSION(extension) + +#if defined(JSON_HEDLEY_CLANG_HAS_DECLSPEC_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_DECLSPEC_DECLSPEC_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_DECLSPEC_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_WARNING) + #undef JSON_HEDLEY_CLANG_HAS_WARNING +#endif +#define JSON_HEDLEY_CLANG_HAS_WARNING(warning) JSON_HEDLEY_HAS_WARNING(warning) + +#endif /* !defined(JSON_HEDLEY_VERSION) || (JSON_HEDLEY_VERSION < X) */ + + +// This file contains all internal macro definitions +// You MUST include macro_unscope.hpp at the end of json.hpp to undef all of them + +// exclude unsupported compilers +#if !defined(JSON_SKIP_UNSUPPORTED_COMPILER_CHECK) + #if defined(__clang__) + #if (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) < 30400 + #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #elif defined(__GNUC__) && !(defined(__ICC) || defined(__INTEL_COMPILER)) + #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) < 40800 + #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #endif +#endif + +// C++ language standard detection +#if (defined(__cplusplus) && __cplusplus >= 202002L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L) + #define JSON_HAS_CPP_20 + #define JSON_HAS_CPP_17 + #define JSON_HAS_CPP_14 +#elif (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464 + #define JSON_HAS_CPP_17 + #define JSON_HAS_CPP_14 +#elif (defined(__cplusplus) && __cplusplus >= 201402L) || (defined(_HAS_CXX14) && _HAS_CXX14 == 1) + #define JSON_HAS_CPP_14 +#endif + +// disable float-equal warnings on GCC/clang +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wfloat-equal" +#endif + +// disable documentation warnings on clang +#if defined(__clang__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wdocumentation" +#endif + +// allow to disable exceptions +#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && !defined(JSON_NOEXCEPTION) + #define JSON_THROW(exception) throw exception + #define JSON_TRY try + #define JSON_CATCH(exception) catch(exception) + #define JSON_INTERNAL_CATCH(exception) catch(exception) +#else + #include + #define JSON_THROW(exception) std::abort() + #define JSON_TRY if(true) + #define JSON_CATCH(exception) if(false) + #define JSON_INTERNAL_CATCH(exception) if(false) +#endif + +// override exception macros +#if defined(JSON_THROW_USER) + #undef JSON_THROW + #define JSON_THROW JSON_THROW_USER +#endif +#if defined(JSON_TRY_USER) + #undef JSON_TRY + #define JSON_TRY JSON_TRY_USER +#endif +#if defined(JSON_CATCH_USER) + #undef JSON_CATCH + #define JSON_CATCH JSON_CATCH_USER + #undef JSON_INTERNAL_CATCH + #define JSON_INTERNAL_CATCH JSON_CATCH_USER +#endif +#if defined(JSON_INTERNAL_CATCH_USER) + #undef JSON_INTERNAL_CATCH + #define JSON_INTERNAL_CATCH JSON_INTERNAL_CATCH_USER +#endif + +// allow to override assert +#if !defined(JSON_ASSERT) + #include // assert + #define JSON_ASSERT(x) assert(x) +#endif + +/*! +@brief macro to briefly define a mapping between an enum and JSON +@def NLOHMANN_JSON_SERIALIZE_ENUM +@since version 3.4.0 +*/ +#define NLOHMANN_JSON_SERIALIZE_ENUM(ENUM_TYPE, ...) \ + template \ + inline void to_json(BasicJsonType& j, const ENUM_TYPE& e) \ + { \ + static_assert(std::is_enum::value, #ENUM_TYPE " must be an enum!"); \ + static const std::pair m[] = __VA_ARGS__; \ + auto it = std::find_if(std::begin(m), std::end(m), \ + [e](const std::pair& ej_pair) -> bool \ + { \ + return ej_pair.first == e; \ + }); \ + j = ((it != std::end(m)) ? it : std::begin(m))->second; \ + } \ + template \ + inline void from_json(const BasicJsonType& j, ENUM_TYPE& e) \ + { \ + static_assert(std::is_enum::value, #ENUM_TYPE " must be an enum!"); \ + static const std::pair m[] = __VA_ARGS__; \ + auto it = std::find_if(std::begin(m), std::end(m), \ + [&j](const std::pair& ej_pair) -> bool \ + { \ + return ej_pair.second == j; \ + }); \ + e = ((it != std::end(m)) ? it : std::begin(m))->first; \ + } + +// Ugly macros to avoid uglier copy-paste when specializing basic_json. They +// may be removed in the future once the class is split. + +#define NLOHMANN_BASIC_JSON_TPL_DECLARATION \ + template class ObjectType, \ + template class ArrayType, \ + class StringType, class BooleanType, class NumberIntegerType, \ + class NumberUnsignedType, class NumberFloatType, \ + template class AllocatorType, \ + template class JSONSerializer, \ + class BinaryType> + +#define NLOHMANN_BASIC_JSON_TPL \ + basic_json + +// Macros to simplify conversion from/to types + +#define NLOHMANN_JSON_EXPAND( x ) x +#define NLOHMANN_JSON_GET_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, _41, _42, _43, _44, _45, _46, _47, _48, _49, _50, _51, _52, _53, _54, _55, _56, _57, _58, _59, _60, _61, _62, _63, _64, NAME,...) NAME +#define NLOHMANN_JSON_PASTE(...) NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_GET_MACRO(__VA_ARGS__, \ + NLOHMANN_JSON_PASTE64, \ + NLOHMANN_JSON_PASTE63, \ + NLOHMANN_JSON_PASTE62, \ + NLOHMANN_JSON_PASTE61, \ + NLOHMANN_JSON_PASTE60, \ + NLOHMANN_JSON_PASTE59, \ + NLOHMANN_JSON_PASTE58, \ + NLOHMANN_JSON_PASTE57, \ + NLOHMANN_JSON_PASTE56, \ + NLOHMANN_JSON_PASTE55, \ + NLOHMANN_JSON_PASTE54, \ + NLOHMANN_JSON_PASTE53, \ + NLOHMANN_JSON_PASTE52, \ + NLOHMANN_JSON_PASTE51, \ + NLOHMANN_JSON_PASTE50, \ + NLOHMANN_JSON_PASTE49, \ + NLOHMANN_JSON_PASTE48, \ + NLOHMANN_JSON_PASTE47, \ + NLOHMANN_JSON_PASTE46, \ + NLOHMANN_JSON_PASTE45, \ + NLOHMANN_JSON_PASTE44, \ + NLOHMANN_JSON_PASTE43, \ + NLOHMANN_JSON_PASTE42, \ + NLOHMANN_JSON_PASTE41, \ + NLOHMANN_JSON_PASTE40, \ + NLOHMANN_JSON_PASTE39, \ + NLOHMANN_JSON_PASTE38, \ + NLOHMANN_JSON_PASTE37, \ + NLOHMANN_JSON_PASTE36, \ + NLOHMANN_JSON_PASTE35, \ + NLOHMANN_JSON_PASTE34, \ + NLOHMANN_JSON_PASTE33, \ + NLOHMANN_JSON_PASTE32, \ + NLOHMANN_JSON_PASTE31, \ + NLOHMANN_JSON_PASTE30, \ + NLOHMANN_JSON_PASTE29, \ + NLOHMANN_JSON_PASTE28, \ + NLOHMANN_JSON_PASTE27, \ + NLOHMANN_JSON_PASTE26, \ + NLOHMANN_JSON_PASTE25, \ + NLOHMANN_JSON_PASTE24, \ + NLOHMANN_JSON_PASTE23, \ + NLOHMANN_JSON_PASTE22, \ + NLOHMANN_JSON_PASTE21, \ + NLOHMANN_JSON_PASTE20, \ + NLOHMANN_JSON_PASTE19, \ + NLOHMANN_JSON_PASTE18, \ + NLOHMANN_JSON_PASTE17, \ + NLOHMANN_JSON_PASTE16, \ + NLOHMANN_JSON_PASTE15, \ + NLOHMANN_JSON_PASTE14, \ + NLOHMANN_JSON_PASTE13, \ + NLOHMANN_JSON_PASTE12, \ + NLOHMANN_JSON_PASTE11, \ + NLOHMANN_JSON_PASTE10, \ + NLOHMANN_JSON_PASTE9, \ + NLOHMANN_JSON_PASTE8, \ + NLOHMANN_JSON_PASTE7, \ + NLOHMANN_JSON_PASTE6, \ + NLOHMANN_JSON_PASTE5, \ + NLOHMANN_JSON_PASTE4, \ + NLOHMANN_JSON_PASTE3, \ + NLOHMANN_JSON_PASTE2, \ + NLOHMANN_JSON_PASTE1)(__VA_ARGS__)) +#define NLOHMANN_JSON_PASTE2(func, v1) func(v1) +#define NLOHMANN_JSON_PASTE3(func, v1, v2) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE2(func, v2) +#define NLOHMANN_JSON_PASTE4(func, v1, v2, v3) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE3(func, v2, v3) +#define NLOHMANN_JSON_PASTE5(func, v1, v2, v3, v4) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE4(func, v2, v3, v4) +#define NLOHMANN_JSON_PASTE6(func, v1, v2, v3, v4, v5) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE5(func, v2, v3, v4, v5) +#define NLOHMANN_JSON_PASTE7(func, v1, v2, v3, v4, v5, v6) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE6(func, v2, v3, v4, v5, v6) +#define NLOHMANN_JSON_PASTE8(func, v1, v2, v3, v4, v5, v6, v7) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE7(func, v2, v3, v4, v5, v6, v7) +#define NLOHMANN_JSON_PASTE9(func, v1, v2, v3, v4, v5, v6, v7, v8) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE8(func, v2, v3, v4, v5, v6, v7, v8) +#define NLOHMANN_JSON_PASTE10(func, v1, v2, v3, v4, v5, v6, v7, v8, v9) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE9(func, v2, v3, v4, v5, v6, v7, v8, v9) +#define NLOHMANN_JSON_PASTE11(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE10(func, v2, v3, v4, v5, v6, v7, v8, v9, v10) +#define NLOHMANN_JSON_PASTE12(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE11(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11) +#define NLOHMANN_JSON_PASTE13(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE12(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12) +#define NLOHMANN_JSON_PASTE14(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE13(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13) +#define NLOHMANN_JSON_PASTE15(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE14(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) +#define NLOHMANN_JSON_PASTE16(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE15(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) +#define NLOHMANN_JSON_PASTE17(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE16(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16) +#define NLOHMANN_JSON_PASTE18(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE17(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) +#define NLOHMANN_JSON_PASTE19(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE18(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) +#define NLOHMANN_JSON_PASTE20(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE19(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) +#define NLOHMANN_JSON_PASTE21(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE20(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) +#define NLOHMANN_JSON_PASTE22(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE21(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) +#define NLOHMANN_JSON_PASTE23(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE22(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) +#define NLOHMANN_JSON_PASTE24(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE23(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23) +#define NLOHMANN_JSON_PASTE25(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE24(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24) +#define NLOHMANN_JSON_PASTE26(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE25(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25) +#define NLOHMANN_JSON_PASTE27(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE26(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26) +#define NLOHMANN_JSON_PASTE28(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE27(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27) +#define NLOHMANN_JSON_PASTE29(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE28(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28) +#define NLOHMANN_JSON_PASTE30(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE29(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29) +#define NLOHMANN_JSON_PASTE31(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE30(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30) +#define NLOHMANN_JSON_PASTE32(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE31(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31) +#define NLOHMANN_JSON_PASTE33(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE32(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32) +#define NLOHMANN_JSON_PASTE34(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE33(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33) +#define NLOHMANN_JSON_PASTE35(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE34(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34) +#define NLOHMANN_JSON_PASTE36(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE35(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35) +#define NLOHMANN_JSON_PASTE37(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE36(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36) +#define NLOHMANN_JSON_PASTE38(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE37(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37) +#define NLOHMANN_JSON_PASTE39(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE38(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38) +#define NLOHMANN_JSON_PASTE40(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE39(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39) +#define NLOHMANN_JSON_PASTE41(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE40(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40) +#define NLOHMANN_JSON_PASTE42(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE41(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41) +#define NLOHMANN_JSON_PASTE43(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE42(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42) +#define NLOHMANN_JSON_PASTE44(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE43(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43) +#define NLOHMANN_JSON_PASTE45(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE44(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44) +#define NLOHMANN_JSON_PASTE46(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE45(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45) +#define NLOHMANN_JSON_PASTE47(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE46(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46) +#define NLOHMANN_JSON_PASTE48(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE47(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47) +#define NLOHMANN_JSON_PASTE49(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE48(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48) +#define NLOHMANN_JSON_PASTE50(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE49(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49) +#define NLOHMANN_JSON_PASTE51(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE50(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50) +#define NLOHMANN_JSON_PASTE52(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE51(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51) +#define NLOHMANN_JSON_PASTE53(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE52(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52) +#define NLOHMANN_JSON_PASTE54(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE53(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53) +#define NLOHMANN_JSON_PASTE55(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE54(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54) +#define NLOHMANN_JSON_PASTE56(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE55(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55) +#define NLOHMANN_JSON_PASTE57(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE56(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56) +#define NLOHMANN_JSON_PASTE58(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE57(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57) +#define NLOHMANN_JSON_PASTE59(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE58(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58) +#define NLOHMANN_JSON_PASTE60(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE59(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59) +#define NLOHMANN_JSON_PASTE61(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE60(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60) +#define NLOHMANN_JSON_PASTE62(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE61(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61) +#define NLOHMANN_JSON_PASTE63(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE62(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62) +#define NLOHMANN_JSON_PASTE64(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62, v63) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE63(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62, v63) + +#define NLOHMANN_JSON_TO(v1) nlohmann_json_j[#v1] = nlohmann_json_t.v1; +#define NLOHMANN_JSON_FROM(v1) nlohmann_json_j.at(#v1).get_to(nlohmann_json_t.v1); + +/*! +@brief macro +@def NLOHMANN_DEFINE_TYPE_INTRUSIVE +@since version 3.9.0 +*/ +#define NLOHMANN_DEFINE_TYPE_INTRUSIVE(Type, ...) \ + friend void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + friend void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM, __VA_ARGS__)) } + +/*! +@brief macro +@def NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE +@since version 3.9.0 +*/ +#define NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(Type, ...) \ + inline void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + inline void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM, __VA_ARGS__)) } + +#ifndef JSON_USE_IMPLICIT_CONVERSIONS + #define JSON_USE_IMPLICIT_CONVERSIONS 1 +#endif + +#if JSON_USE_IMPLICIT_CONVERSIONS + #define JSON_EXPLICIT +#else + #define JSON_EXPLICIT explicit +#endif + + +namespace nlohmann +{ +namespace detail +{ +//////////////// +// exceptions // +//////////////// + +/*! +@brief general exception of the @ref basic_json class + +This class is an extension of `std::exception` objects with a member @a id for +exception ids. It is used as the base class for all exceptions thrown by the +@ref basic_json class. This class can hence be used as "wildcard" to catch +exceptions. + +Subclasses: +- @ref parse_error for exceptions indicating a parse error +- @ref invalid_iterator for exceptions indicating errors with iterators +- @ref type_error for exceptions indicating executing a member function with + a wrong type +- @ref out_of_range for exceptions indicating access out of the defined range +- @ref other_error for exceptions indicating other library errors + +@internal +@note To have nothrow-copy-constructible exceptions, we internally use + `std::runtime_error` which can cope with arbitrary-length error messages. + Intermediate strings are built with static functions and then passed to + the actual constructor. +@endinternal + +@liveexample{The following code shows how arbitrary library exceptions can be +caught.,exception} + +@since version 3.0.0 +*/ +class exception : public std::exception +{ + public: + /// returns the explanatory string + JSON_HEDLEY_RETURNS_NON_NULL + const char* what() const noexcept override + { + return m.what(); + } + + /// the id of the exception + const int id; + + protected: + JSON_HEDLEY_NON_NULL(3) + exception(int id_, const char* what_arg) : id(id_), m(what_arg) {} + + static std::string name(const std::string& ename, int id_) + { + return "[json.exception." + ename + "." + std::to_string(id_) + "] "; + } + + private: + /// an exception object as storage for error messages + std::runtime_error m; +}; + +/*! +@brief exception indicating a parse error + +This exception is thrown by the library when a parse error occurs. Parse errors +can occur during the deserialization of JSON text, CBOR, MessagePack, as well +as when using JSON Patch. + +Member @a byte holds the byte index of the last read character in the input +file. + +Exceptions have ids 1xx. + +name / id | example message | description +------------------------------ | --------------- | ------------------------- +json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position. +json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point. +json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid. +json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects. +json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors. +json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number without a leading `0`. +json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character. +json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences. +json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number. +json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read. +json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xF8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read. +json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read. +json.exception.parse_error.114 | parse error: Unsupported BSON record type 0x0F | The parsing of the corresponding BSON record type is not implemented (yet). +json.exception.parse_error.115 | parse error at byte 5: syntax error while parsing UBJSON high-precision number: invalid number text: 1A | A UBJSON high-precision number could not be parsed. + +@note For an input with n bytes, 1 is the index of the first character and n+1 + is the index of the terminating null byte or the end of file. This also + holds true when reading a byte vector (CBOR or MessagePack). + +@liveexample{The following code shows how a `parse_error` exception can be +caught.,parse_error} + +@sa - @ref exception for the base class of the library exceptions +@sa - @ref invalid_iterator for exceptions indicating errors with iterators +@sa - @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa - @ref out_of_range for exceptions indicating access out of the defined range +@sa - @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class parse_error : public exception +{ + public: + /*! + @brief create a parse error exception + @param[in] id_ the id of the exception + @param[in] pos the position where the error occurred (or with + chars_read_total=0 if the position cannot be + determined) + @param[in] what_arg the explanatory string + @return parse_error object + */ + static parse_error create(int id_, const position_t& pos, const std::string& what_arg) + { + std::string w = exception::name("parse_error", id_) + "parse error" + + position_string(pos) + ": " + what_arg; + return parse_error(id_, pos.chars_read_total, w.c_str()); + } + + static parse_error create(int id_, std::size_t byte_, const std::string& what_arg) + { + std::string w = exception::name("parse_error", id_) + "parse error" + + (byte_ != 0 ? (" at byte " + std::to_string(byte_)) : "") + + ": " + what_arg; + return parse_error(id_, byte_, w.c_str()); + } + + /*! + @brief byte index of the parse error + + The byte index of the last read character in the input file. + + @note For an input with n bytes, 1 is the index of the first character and + n+1 is the index of the terminating null byte or the end of file. + This also holds true when reading a byte vector (CBOR or MessagePack). + */ + const std::size_t byte; + + private: + parse_error(int id_, std::size_t byte_, const char* what_arg) + : exception(id_, what_arg), byte(byte_) {} + + static std::string position_string(const position_t& pos) + { + return " at line " + std::to_string(pos.lines_read + 1) + + ", column " + std::to_string(pos.chars_read_current_line); + } +}; + +/*! +@brief exception indicating errors with iterators + +This exception is thrown if iterators passed to a library function do not match +the expected semantics. + +Exceptions have ids 2xx. + +name / id | example message | description +----------------------------------- | --------------- | ------------------------- +json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. +json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion. +json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from. +json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid. +json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid. +json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range. +json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key. +json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. +json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. +json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. +json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to. +json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container. +json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compared, because JSON objects are unordered. +json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin(). + +@liveexample{The following code shows how an `invalid_iterator` exception can be +caught.,invalid_iterator} + +@sa - @ref exception for the base class of the library exceptions +@sa - @ref parse_error for exceptions indicating a parse error +@sa - @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa - @ref out_of_range for exceptions indicating access out of the defined range +@sa - @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class invalid_iterator : public exception +{ + public: + static invalid_iterator create(int id_, const std::string& what_arg) + { + std::string w = exception::name("invalid_iterator", id_) + what_arg; + return invalid_iterator(id_, w.c_str()); + } + + private: + JSON_HEDLEY_NON_NULL(3) + invalid_iterator(int id_, const char* what_arg) + : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating executing a member function with a wrong type + +This exception is thrown in case of a type error; that is, a library function is +executed on a JSON value whose type does not match the expected semantics. + +Exceptions have ids 3xx. + +name / id | example message | description +----------------------------- | --------------- | ------------------------- +json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead. +json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types. +json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t &. +json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types. +json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types. +json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types. +json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types. +json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types. +json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types. +json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types. +json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types. +json.exception.type_error.312 | cannot use update() with string | The @ref update() member functions can only be executed for certain JSON types. +json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined. +json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers. +json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive. +json.exception.type_error.316 | invalid UTF-8 byte at index 10: 0x7E | The @ref dump function only works with UTF-8 encoded strings; that is, if you assign a `std::string` to a JSON value, make sure it is UTF-8 encoded. | +json.exception.type_error.317 | JSON value cannot be serialized to requested format | The dynamic type of the object cannot be represented in the requested serialization format (e.g. a raw `true` or `null` JSON object cannot be serialized to BSON) | + +@liveexample{The following code shows how a `type_error` exception can be +caught.,type_error} + +@sa - @ref exception for the base class of the library exceptions +@sa - @ref parse_error for exceptions indicating a parse error +@sa - @ref invalid_iterator for exceptions indicating errors with iterators +@sa - @ref out_of_range for exceptions indicating access out of the defined range +@sa - @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class type_error : public exception +{ + public: + static type_error create(int id_, const std::string& what_arg) + { + std::string w = exception::name("type_error", id_) + what_arg; + return type_error(id_, w.c_str()); + } + + private: + JSON_HEDLEY_NON_NULL(3) + type_error(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating access out of the defined range + +This exception is thrown in case a library function is called on an input +parameter that exceeds the expected range, for instance in case of array +indices or nonexisting object keys. + +Exceptions have ids 4xx. + +name / id | example message | description +------------------------------- | --------------- | ------------------------- +json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1. +json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it. +json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object. +json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved. +json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value. +json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF. +json.exception.out_of_range.407 | number overflow serializing '9223372036854775808' | UBJSON and BSON only support integer numbers up to 9223372036854775807. (until version 3.8.0) | +json.exception.out_of_range.408 | excessive array size: 8658170730974374167 | The size (following `#`) of an UBJSON array or object exceeds the maximal capacity. | +json.exception.out_of_range.409 | BSON key cannot contain code point U+0000 (at byte 2) | Key identifiers to be serialized to BSON cannot contain code point U+0000, since the key is stored as zero-terminated c-string | + +@liveexample{The following code shows how an `out_of_range` exception can be +caught.,out_of_range} + +@sa - @ref exception for the base class of the library exceptions +@sa - @ref parse_error for exceptions indicating a parse error +@sa - @ref invalid_iterator for exceptions indicating errors with iterators +@sa - @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa - @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class out_of_range : public exception +{ + public: + static out_of_range create(int id_, const std::string& what_arg) + { + std::string w = exception::name("out_of_range", id_) + what_arg; + return out_of_range(id_, w.c_str()); + } + + private: + JSON_HEDLEY_NON_NULL(3) + out_of_range(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating other library errors + +This exception is thrown in case of errors that cannot be classified with the +other exception types. + +Exceptions have ids 5xx. + +name / id | example message | description +------------------------------ | --------------- | ------------------------- +json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed. + +@sa - @ref exception for the base class of the library exceptions +@sa - @ref parse_error for exceptions indicating a parse error +@sa - @ref invalid_iterator for exceptions indicating errors with iterators +@sa - @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa - @ref out_of_range for exceptions indicating access out of the defined range + +@liveexample{The following code shows how an `other_error` exception can be +caught.,other_error} + +@since version 3.0.0 +*/ +class other_error : public exception +{ + public: + static other_error create(int id_, const std::string& what_arg) + { + std::string w = exception::name("other_error", id_) + what_arg; + return other_error(id_, w.c_str()); + } + + private: + JSON_HEDLEY_NON_NULL(3) + other_error(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + + +#include // size_t +#include // conditional, enable_if, false_type, integral_constant, is_constructible, is_integral, is_same, remove_cv, remove_reference, true_type + +namespace nlohmann +{ +namespace detail +{ +// alias templates to reduce boilerplate +template +using enable_if_t = typename std::enable_if::type; + +template +using uncvref_t = typename std::remove_cv::type>::type; + +// implementation of C++14 index_sequence and affiliates +// source: https://stackoverflow.com/a/32223343 +template +struct index_sequence +{ + using type = index_sequence; + using value_type = std::size_t; + static constexpr std::size_t size() noexcept + { + return sizeof...(Ints); + } +}; + +template +struct merge_and_renumber; + +template +struct merge_and_renumber, index_sequence> + : index_sequence < I1..., (sizeof...(I1) + I2)... > {}; + +template +struct make_index_sequence + : merge_and_renumber < typename make_index_sequence < N / 2 >::type, + typename make_index_sequence < N - N / 2 >::type > {}; + +template<> struct make_index_sequence<0> : index_sequence<> {}; +template<> struct make_index_sequence<1> : index_sequence<0> {}; + +template +using index_sequence_for = make_index_sequence; + +// dispatch utility (taken from ranges-v3) +template struct priority_tag : priority_tag < N - 1 > {}; +template<> struct priority_tag<0> {}; + +// taken from ranges-v3 +template +struct static_const +{ + static constexpr T value{}; +}; + +template +constexpr T static_const::value; +} // namespace detail +} // namespace nlohmann + +// #include + + +#include // numeric_limits +#include // false_type, is_constructible, is_integral, is_same, true_type +#include // declval + +// #include + + +#include // random_access_iterator_tag + +// #include + + +namespace nlohmann +{ +namespace detail +{ +template struct make_void +{ + using type = void; +}; +template using void_t = typename make_void::type; +} // namespace detail +} // namespace nlohmann + +// #include + + +namespace nlohmann +{ +namespace detail +{ +template +struct iterator_types {}; + +template +struct iterator_types < + It, + void_t> +{ + using difference_type = typename It::difference_type; + using value_type = typename It::value_type; + using pointer = typename It::pointer; + using reference = typename It::reference; + using iterator_category = typename It::iterator_category; +}; + +// This is required as some compilers implement std::iterator_traits in a way that +// doesn't work with SFINAE. See https://github.com/nlohmann/json/issues/1341. +template +struct iterator_traits +{ +}; + +template +struct iterator_traits < T, enable_if_t < !std::is_pointer::value >> + : iterator_types +{ +}; + +template +struct iterator_traits::value>> +{ + using iterator_category = std::random_access_iterator_tag; + using value_type = T; + using difference_type = ptrdiff_t; + using pointer = T*; + using reference = T&; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + +// #include + + +#include + +// #include + + +// https://en.cppreference.com/w/cpp/experimental/is_detected +namespace nlohmann +{ +namespace detail +{ +struct nonesuch +{ + nonesuch() = delete; + ~nonesuch() = delete; + nonesuch(nonesuch const&) = delete; + nonesuch(nonesuch const&&) = delete; + void operator=(nonesuch const&) = delete; + void operator=(nonesuch&&) = delete; +}; + +template class Op, + class... Args> +struct detector +{ + using value_t = std::false_type; + using type = Default; +}; + +template class Op, class... Args> +struct detector>, Op, Args...> +{ + using value_t = std::true_type; + using type = Op; +}; + +template class Op, class... Args> +using is_detected = typename detector::value_t; + +template class Op, class... Args> +using detected_t = typename detector::type; + +template class Op, class... Args> +using detected_or = detector; + +template class Op, class... Args> +using detected_or_t = typename detected_or::type; + +template class Op, class... Args> +using is_detected_exact = std::is_same>; + +template class Op, class... Args> +using is_detected_convertible = + std::is_convertible, To>; +} // namespace detail +} // namespace nlohmann + +// #include +#ifndef INCLUDE_NLOHMANN_JSON_FWD_HPP_ +#define INCLUDE_NLOHMANN_JSON_FWD_HPP_ + +#include // int64_t, uint64_t +#include // map +#include // allocator +#include // string +#include // vector + +/*! +@brief namespace for Niels Lohmann +@see https://github.com/nlohmann +@since version 1.0.0 +*/ +namespace nlohmann +{ +/*! +@brief default JSONSerializer template argument + +This serializer ignores the template arguments and uses ADL +([argument-dependent lookup](https://en.cppreference.com/w/cpp/language/adl)) +for serialization. +*/ +template +struct adl_serializer; + +template class ObjectType = + std::map, + template class ArrayType = std::vector, + class StringType = std::string, class BooleanType = bool, + class NumberIntegerType = std::int64_t, + class NumberUnsignedType = std::uint64_t, + class NumberFloatType = double, + template class AllocatorType = std::allocator, + template class JSONSerializer = + adl_serializer, + class BinaryType = std::vector> +class basic_json; + +/*! +@brief JSON Pointer + +A JSON pointer defines a string syntax for identifying a specific value +within a JSON document. It can be used with functions `at` and +`operator[]`. Furthermore, JSON pointers are the base for JSON patches. + +@sa [RFC 6901](https://tools.ietf.org/html/rfc6901) + +@since version 2.0.0 +*/ +template +class json_pointer; + +/*! +@brief default JSON class + +This type is the default specialization of the @ref basic_json class which +uses the standard template types. + +@since version 1.0.0 +*/ +using json = basic_json<>; + +template +struct ordered_map; + +/*! +@brief ordered JSON class + +This type preserves the insertion order of object keys. + +@since version 3.9.0 +*/ +using ordered_json = basic_json; + +} // namespace nlohmann + +#endif // INCLUDE_NLOHMANN_JSON_FWD_HPP_ + + +namespace nlohmann +{ +/*! +@brief detail namespace with internal helper functions + +This namespace collects functions that should not be exposed, +implementations of some @ref basic_json methods, and meta-programming helpers. + +@since version 2.1.0 +*/ +namespace detail +{ +///////////// +// helpers // +///////////// + +// Note to maintainers: +// +// Every trait in this file expects a non CV-qualified type. +// The only exceptions are in the 'aliases for detected' section +// (i.e. those of the form: decltype(T::member_function(std::declval()))) +// +// In this case, T has to be properly CV-qualified to constraint the function arguments +// (e.g. to_json(BasicJsonType&, const T&)) + +template struct is_basic_json : std::false_type {}; + +NLOHMANN_BASIC_JSON_TPL_DECLARATION +struct is_basic_json : std::true_type {}; + +////////////////////// +// json_ref helpers // +////////////////////// + +template +class json_ref; + +template +struct is_json_ref : std::false_type {}; + +template +struct is_json_ref> : std::true_type {}; + +////////////////////////// +// aliases for detected // +////////////////////////// + +template +using mapped_type_t = typename T::mapped_type; + +template +using key_type_t = typename T::key_type; + +template +using value_type_t = typename T::value_type; + +template +using difference_type_t = typename T::difference_type; + +template +using pointer_t = typename T::pointer; + +template +using reference_t = typename T::reference; + +template +using iterator_category_t = typename T::iterator_category; + +template +using iterator_t = typename T::iterator; + +template +using to_json_function = decltype(T::to_json(std::declval()...)); + +template +using from_json_function = decltype(T::from_json(std::declval()...)); + +template +using get_template_function = decltype(std::declval().template get()); + +// trait checking if JSONSerializer::from_json(json const&, udt&) exists +template +struct has_from_json : std::false_type {}; + +// trait checking if j.get is valid +// use this trait instead of std::is_constructible or std::is_convertible, +// both rely on, or make use of implicit conversions, and thus fail when T +// has several constructors/operator= (see https://github.com/nlohmann/json/issues/958) +template +struct is_getable +{ + static constexpr bool value = is_detected::value; +}; + +template +struct has_from_json < BasicJsonType, T, + enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + +// This trait checks if JSONSerializer::from_json(json const&) exists +// this overload is used for non-default-constructible user-defined-types +template +struct has_non_default_from_json : std::false_type {}; + +template +struct has_non_default_from_json < BasicJsonType, T, enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + +// This trait checks if BasicJsonType::json_serializer::to_json exists +// Do not evaluate the trait when T is a basic_json type, to avoid template instantiation infinite recursion. +template +struct has_to_json : std::false_type {}; + +template +struct has_to_json < BasicJsonType, T, enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + + +/////////////////// +// is_ functions // +/////////////////// + +template +struct is_iterator_traits : std::false_type {}; + +template +struct is_iterator_traits> +{ + private: + using traits = iterator_traits; + + public: + static constexpr auto value = + is_detected::value && + is_detected::value && + is_detected::value && + is_detected::value && + is_detected::value; +}; + +// source: https://stackoverflow.com/a/37193089/4116453 + +template +struct is_complete_type : std::false_type {}; + +template +struct is_complete_type : std::true_type {}; + +template +struct is_compatible_object_type_impl : std::false_type {}; + +template +struct is_compatible_object_type_impl < + BasicJsonType, CompatibleObjectType, + enable_if_t < is_detected::value&& + is_detected::value >> +{ + + using object_t = typename BasicJsonType::object_t; + + // macOS's is_constructible does not play well with nonesuch... + static constexpr bool value = + std::is_constructible::value && + std::is_constructible::value; +}; + +template +struct is_compatible_object_type + : is_compatible_object_type_impl {}; + +template +struct is_constructible_object_type_impl : std::false_type {}; + +template +struct is_constructible_object_type_impl < + BasicJsonType, ConstructibleObjectType, + enable_if_t < is_detected::value&& + is_detected::value >> +{ + using object_t = typename BasicJsonType::object_t; + + static constexpr bool value = + (std::is_default_constructible::value && + (std::is_move_assignable::value || + std::is_copy_assignable::value) && + (std::is_constructible::value && + std::is_same < + typename object_t::mapped_type, + typename ConstructibleObjectType::mapped_type >::value)) || + (has_from_json::value || + has_non_default_from_json < + BasicJsonType, + typename ConstructibleObjectType::mapped_type >::value); +}; + +template +struct is_constructible_object_type + : is_constructible_object_type_impl {}; + +template +struct is_compatible_string_type_impl : std::false_type {}; + +template +struct is_compatible_string_type_impl < + BasicJsonType, CompatibleStringType, + enable_if_t::value >> +{ + static constexpr auto value = + std::is_constructible::value; +}; + +template +struct is_compatible_string_type + : is_compatible_string_type_impl {}; + +template +struct is_constructible_string_type_impl : std::false_type {}; + +template +struct is_constructible_string_type_impl < + BasicJsonType, ConstructibleStringType, + enable_if_t::value >> +{ + static constexpr auto value = + std::is_constructible::value; +}; + +template +struct is_constructible_string_type + : is_constructible_string_type_impl {}; + +template +struct is_compatible_array_type_impl : std::false_type {}; + +template +struct is_compatible_array_type_impl < + BasicJsonType, CompatibleArrayType, + enable_if_t < is_detected::value&& + is_detected::value&& +// This is needed because json_reverse_iterator has a ::iterator type... +// Therefore it is detected as a CompatibleArrayType. +// The real fix would be to have an Iterable concept. + !is_iterator_traits < + iterator_traits>::value >> +{ + static constexpr bool value = + std::is_constructible::value; +}; + +template +struct is_compatible_array_type + : is_compatible_array_type_impl {}; + +template +struct is_constructible_array_type_impl : std::false_type {}; + +template +struct is_constructible_array_type_impl < + BasicJsonType, ConstructibleArrayType, + enable_if_t::value >> + : std::true_type {}; + +template +struct is_constructible_array_type_impl < + BasicJsonType, ConstructibleArrayType, + enable_if_t < !std::is_same::value&& + std::is_default_constructible::value&& +(std::is_move_assignable::value || + std::is_copy_assignable::value)&& +is_detected::value&& +is_detected::value&& +is_complete_type < +detected_t>::value >> +{ + static constexpr bool value = + // This is needed because json_reverse_iterator has a ::iterator type, + // furthermore, std::back_insert_iterator (and other iterators) have a + // base class `iterator`... Therefore it is detected as a + // ConstructibleArrayType. The real fix would be to have an Iterable + // concept. + !is_iterator_traits>::value && + + (std::is_same::value || + has_from_json::value || + has_non_default_from_json < + BasicJsonType, typename ConstructibleArrayType::value_type >::value); +}; + +template +struct is_constructible_array_type + : is_constructible_array_type_impl {}; + +template +struct is_compatible_integer_type_impl : std::false_type {}; + +template +struct is_compatible_integer_type_impl < + RealIntegerType, CompatibleNumberIntegerType, + enable_if_t < std::is_integral::value&& + std::is_integral::value&& + !std::is_same::value >> +{ + // is there an assert somewhere on overflows? + using RealLimits = std::numeric_limits; + using CompatibleLimits = std::numeric_limits; + + static constexpr auto value = + std::is_constructible::value && + CompatibleLimits::is_integer && + RealLimits::is_signed == CompatibleLimits::is_signed; +}; + +template +struct is_compatible_integer_type + : is_compatible_integer_type_impl {}; + +template +struct is_compatible_type_impl: std::false_type {}; + +template +struct is_compatible_type_impl < + BasicJsonType, CompatibleType, + enable_if_t::value >> +{ + static constexpr bool value = + has_to_json::value; +}; + +template +struct is_compatible_type + : is_compatible_type_impl {}; + +// https://en.cppreference.com/w/cpp/types/conjunction +template struct conjunction : std::true_type { }; +template struct conjunction : B1 { }; +template +struct conjunction +: std::conditional, B1>::type {}; + +template +struct is_constructible_tuple : std::false_type {}; + +template +struct is_constructible_tuple> : conjunction...> {}; +} // namespace detail +} // namespace nlohmann + +// #include + + +#include // array +#include // size_t +#include // uint8_t +#include // string + +namespace nlohmann +{ +namespace detail +{ +/////////////////////////// +// JSON type enumeration // +/////////////////////////// + +/*! +@brief the JSON type enumeration + +This enumeration collects the different JSON types. It is internally used to +distinguish the stored values, and the functions @ref basic_json::is_null(), +@ref basic_json::is_object(), @ref basic_json::is_array(), +@ref basic_json::is_string(), @ref basic_json::is_boolean(), +@ref basic_json::is_number() (with @ref basic_json::is_number_integer(), +@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()), +@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and +@ref basic_json::is_structured() rely on it. + +@note There are three enumeration entries (number_integer, number_unsigned, and +number_float), because the library distinguishes these three types for numbers: +@ref basic_json::number_unsigned_t is used for unsigned integers, +@ref basic_json::number_integer_t is used for signed integers, and +@ref basic_json::number_float_t is used for floating-point numbers or to +approximate integers which do not fit in the limits of their respective type. + +@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON +value with the default value for a given type + +@since version 1.0.0 +*/ +enum class value_t : std::uint8_t +{ + null, ///< null value + object, ///< object (unordered set of name/value pairs) + array, ///< array (ordered collection of values) + string, ///< string value + boolean, ///< boolean value + number_integer, ///< number value (signed integer) + number_unsigned, ///< number value (unsigned integer) + number_float, ///< number value (floating-point) + binary, ///< binary array (ordered collection of bytes) + discarded ///< discarded by the parser callback function +}; + +/*! +@brief comparison operator for JSON types + +Returns an ordering that is similar to Python: +- order: null < boolean < number < object < array < string < binary +- furthermore, each type is not smaller than itself +- discarded values are not comparable +- binary is represented as a b"" string in python and directly comparable to a + string; however, making a binary array directly comparable with a string would + be surprising behavior in a JSON file. + +@since version 1.0.0 +*/ +inline bool operator<(const value_t lhs, const value_t rhs) noexcept +{ + static constexpr std::array order = {{ + 0 /* null */, 3 /* object */, 4 /* array */, 5 /* string */, + 1 /* boolean */, 2 /* integer */, 2 /* unsigned */, 2 /* float */, + 6 /* binary */ + } + }; + + const auto l_index = static_cast(lhs); + const auto r_index = static_cast(rhs); + return l_index < order.size() && r_index < order.size() && order[l_index] < order[r_index]; +} +} // namespace detail +} // namespace nlohmann + + +namespace nlohmann +{ +namespace detail +{ +template +void from_json(const BasicJsonType& j, typename std::nullptr_t& n) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_null())) + { + JSON_THROW(type_error::create(302, "type must be null, but is " + std::string(j.type_name()))); + } + n = nullptr; +} + +// overloads for basic_json template parameters +template < typename BasicJsonType, typename ArithmeticType, + enable_if_t < std::is_arithmetic::value&& + !std::is_same::value, + int > = 0 > +void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val) +{ + switch (static_cast(j)) + { + case value_t::number_unsigned: + { + val = static_cast(*j.template get_ptr()); + break; + } + case value_t::number_integer: + { + val = static_cast(*j.template get_ptr()); + break; + } + case value_t::number_float: + { + val = static_cast(*j.template get_ptr()); + break; + } + + default: + JSON_THROW(type_error::create(302, "type must be number, but is " + std::string(j.type_name()))); + } +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_boolean())) + { + JSON_THROW(type_error::create(302, "type must be boolean, but is " + std::string(j.type_name()))); + } + b = *j.template get_ptr(); +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_string())) + { + JSON_THROW(type_error::create(302, "type must be string, but is " + std::string(j.type_name()))); + } + s = *j.template get_ptr(); +} + +template < + typename BasicJsonType, typename ConstructibleStringType, + enable_if_t < + is_constructible_string_type::value&& + !std::is_same::value, + int > = 0 > +void from_json(const BasicJsonType& j, ConstructibleStringType& s) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_string())) + { + JSON_THROW(type_error::create(302, "type must be string, but is " + std::string(j.type_name()))); + } + + s = *j.template get_ptr(); +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val) +{ + get_arithmetic_value(j, val); +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val) +{ + get_arithmetic_value(j, val); +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val) +{ + get_arithmetic_value(j, val); +} + +template::value, int> = 0> +void from_json(const BasicJsonType& j, EnumType& e) +{ + typename std::underlying_type::type val; + get_arithmetic_value(j, val); + e = static_cast(val); +} + +// forward_list doesn't have an insert method +template::value, int> = 0> +void from_json(const BasicJsonType& j, std::forward_list& l) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + l.clear(); + std::transform(j.rbegin(), j.rend(), + std::front_inserter(l), [](const BasicJsonType & i) + { + return i.template get(); + }); +} + +// valarray doesn't have an insert method +template::value, int> = 0> +void from_json(const BasicJsonType& j, std::valarray& l) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + l.resize(j.size()); + std::transform(j.begin(), j.end(), std::begin(l), + [](const BasicJsonType & elem) + { + return elem.template get(); + }); +} + +template +auto from_json(const BasicJsonType& j, T (&arr)[N]) +-> decltype(j.template get(), void()) +{ + for (std::size_t i = 0; i < N; ++i) + { + arr[i] = j.at(i).template get(); + } +} + +template +void from_json_array_impl(const BasicJsonType& j, typename BasicJsonType::array_t& arr, priority_tag<3> /*unused*/) +{ + arr = *j.template get_ptr(); +} + +template +auto from_json_array_impl(const BasicJsonType& j, std::array& arr, + priority_tag<2> /*unused*/) +-> decltype(j.template get(), void()) +{ + for (std::size_t i = 0; i < N; ++i) + { + arr[i] = j.at(i).template get(); + } +} + +template +auto from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr, priority_tag<1> /*unused*/) +-> decltype( + arr.reserve(std::declval()), + j.template get(), + void()) +{ + using std::end; + + ConstructibleArrayType ret; + ret.reserve(j.size()); + std::transform(j.begin(), j.end(), + std::inserter(ret, end(ret)), [](const BasicJsonType & i) + { + // get() returns *this, this won't call a from_json + // method when value_type is BasicJsonType + return i.template get(); + }); + arr = std::move(ret); +} + +template +void from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr, + priority_tag<0> /*unused*/) +{ + using std::end; + + ConstructibleArrayType ret; + std::transform( + j.begin(), j.end(), std::inserter(ret, end(ret)), + [](const BasicJsonType & i) + { + // get() returns *this, this won't call a from_json + // method when value_type is BasicJsonType + return i.template get(); + }); + arr = std::move(ret); +} + +template < typename BasicJsonType, typename ConstructibleArrayType, + enable_if_t < + is_constructible_array_type::value&& + !is_constructible_object_type::value&& + !is_constructible_string_type::value&& + !std::is_same::value&& + !is_basic_json::value, + int > = 0 > +auto from_json(const BasicJsonType& j, ConstructibleArrayType& arr) +-> decltype(from_json_array_impl(j, arr, priority_tag<3> {}), +j.template get(), +void()) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + + std::string(j.type_name()))); + } + + from_json_array_impl(j, arr, priority_tag<3> {}); +} + +template +void from_json(const BasicJsonType& j, typename BasicJsonType::binary_t& bin) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_binary())) + { + JSON_THROW(type_error::create(302, "type must be binary, but is " + std::string(j.type_name()))); + } + + bin = *j.template get_ptr(); +} + +template::value, int> = 0> +void from_json(const BasicJsonType& j, ConstructibleObjectType& obj) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_object())) + { + JSON_THROW(type_error::create(302, "type must be object, but is " + std::string(j.type_name()))); + } + + ConstructibleObjectType ret; + auto inner_object = j.template get_ptr(); + using value_type = typename ConstructibleObjectType::value_type; + std::transform( + inner_object->begin(), inner_object->end(), + std::inserter(ret, ret.begin()), + [](typename BasicJsonType::object_t::value_type const & p) + { + return value_type(p.first, p.second.template get()); + }); + obj = std::move(ret); +} + +// overload for arithmetic types, not chosen for basic_json template arguments +// (BooleanType, etc..); note: Is it really necessary to provide explicit +// overloads for boolean_t etc. in case of a custom BooleanType which is not +// an arithmetic type? +template < typename BasicJsonType, typename ArithmeticType, + enable_if_t < + std::is_arithmetic::value&& + !std::is_same::value&& + !std::is_same::value&& + !std::is_same::value&& + !std::is_same::value, + int > = 0 > +void from_json(const BasicJsonType& j, ArithmeticType& val) +{ + switch (static_cast(j)) + { + case value_t::number_unsigned: + { + val = static_cast(*j.template get_ptr()); + break; + } + case value_t::number_integer: + { + val = static_cast(*j.template get_ptr()); + break; + } + case value_t::number_float: + { + val = static_cast(*j.template get_ptr()); + break; + } + case value_t::boolean: + { + val = static_cast(*j.template get_ptr()); + break; + } + + default: + JSON_THROW(type_error::create(302, "type must be number, but is " + std::string(j.type_name()))); + } +} + +template +void from_json(const BasicJsonType& j, std::pair& p) +{ + p = {j.at(0).template get(), j.at(1).template get()}; +} + +template +void from_json_tuple_impl(const BasicJsonType& j, Tuple& t, index_sequence /*unused*/) +{ + t = std::make_tuple(j.at(Idx).template get::type>()...); +} + +template +void from_json(const BasicJsonType& j, std::tuple& t) +{ + from_json_tuple_impl(j, t, index_sequence_for {}); +} + +template < typename BasicJsonType, typename Key, typename Value, typename Compare, typename Allocator, + typename = enable_if_t < !std::is_constructible < + typename BasicJsonType::string_t, Key >::value >> +void from_json(const BasicJsonType& j, std::map& m) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + m.clear(); + for (const auto& p : j) + { + if (JSON_HEDLEY_UNLIKELY(!p.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(p.type_name()))); + } + m.emplace(p.at(0).template get(), p.at(1).template get()); + } +} + +template < typename BasicJsonType, typename Key, typename Value, typename Hash, typename KeyEqual, typename Allocator, + typename = enable_if_t < !std::is_constructible < + typename BasicJsonType::string_t, Key >::value >> +void from_json(const BasicJsonType& j, std::unordered_map& m) +{ + if (JSON_HEDLEY_UNLIKELY(!j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + m.clear(); + for (const auto& p : j) + { + if (JSON_HEDLEY_UNLIKELY(!p.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(p.type_name()))); + } + m.emplace(p.at(0).template get(), p.at(1).template get()); + } +} + +struct from_json_fn +{ + template + auto operator()(const BasicJsonType& j, T& val) const + noexcept(noexcept(from_json(j, val))) + -> decltype(from_json(j, val), void()) + { + return from_json(j, val); + } +}; +} // namespace detail + +/// namespace to hold default `from_json` function +/// to see why this is required: +/// http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4381.html +namespace +{ +constexpr const auto& from_json = detail::static_const::value; +} // namespace +} // namespace nlohmann + +// #include + + +#include // copy +#include // begin, end +#include // string +#include // tuple, get +#include // is_same, is_constructible, is_floating_point, is_enum, underlying_type +#include // move, forward, declval, pair +#include // valarray +#include // vector + +// #include + + +#include // size_t +#include // input_iterator_tag +#include // string, to_string +#include // tuple_size, get, tuple_element + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +template +void int_to_string( string_type& target, std::size_t value ) +{ + // For ADL + using std::to_string; + target = to_string(value); +} +template class iteration_proxy_value +{ + public: + using difference_type = std::ptrdiff_t; + using value_type = iteration_proxy_value; + using pointer = value_type * ; + using reference = value_type & ; + using iterator_category = std::input_iterator_tag; + using string_type = typename std::remove_cv< typename std::remove_reference().key() ) >::type >::type; + + private: + /// the iterator + IteratorType anchor; + /// an index for arrays (used to create key names) + std::size_t array_index = 0; + /// last stringified array index + mutable std::size_t array_index_last = 0; + /// a string representation of the array index + mutable string_type array_index_str = "0"; + /// an empty string (to return a reference for primitive values) + const string_type empty_str = ""; + + public: + explicit iteration_proxy_value(IteratorType it) noexcept : anchor(it) {} + + /// dereference operator (needed for range-based for) + iteration_proxy_value& operator*() + { + return *this; + } + + /// increment operator (needed for range-based for) + iteration_proxy_value& operator++() + { + ++anchor; + ++array_index; + + return *this; + } + + /// equality operator (needed for InputIterator) + bool operator==(const iteration_proxy_value& o) const + { + return anchor == o.anchor; + } + + /// inequality operator (needed for range-based for) + bool operator!=(const iteration_proxy_value& o) const + { + return anchor != o.anchor; + } + + /// return key of the iterator + const string_type& key() const + { + JSON_ASSERT(anchor.m_object != nullptr); + + switch (anchor.m_object->type()) + { + // use integer array index as key + case value_t::array: + { + if (array_index != array_index_last) + { + int_to_string( array_index_str, array_index ); + array_index_last = array_index; + } + return array_index_str; + } + + // use key from the object + case value_t::object: + return anchor.key(); + + // use an empty key for all primitive types + default: + return empty_str; + } + } + + /// return value of the iterator + typename IteratorType::reference value() const + { + return anchor.value(); + } +}; + +/// proxy class for the items() function +template class iteration_proxy +{ + private: + /// the container to iterate + typename IteratorType::reference container; + + public: + /// construct iteration proxy from a container + explicit iteration_proxy(typename IteratorType::reference cont) noexcept + : container(cont) {} + + /// return iterator begin (needed for range-based for) + iteration_proxy_value begin() noexcept + { + return iteration_proxy_value(container.begin()); + } + + /// return iterator end (needed for range-based for) + iteration_proxy_value end() noexcept + { + return iteration_proxy_value(container.end()); + } +}; +// Structured Bindings Support +// For further reference see https://blog.tartanllama.xyz/structured-bindings/ +// And see https://github.com/nlohmann/json/pull/1391 +template = 0> +auto get(const nlohmann::detail::iteration_proxy_value& i) -> decltype(i.key()) +{ + return i.key(); +} +// Structured Bindings Support +// For further reference see https://blog.tartanllama.xyz/structured-bindings/ +// And see https://github.com/nlohmann/json/pull/1391 +template = 0> +auto get(const nlohmann::detail::iteration_proxy_value& i) -> decltype(i.value()) +{ + return i.value(); +} +} // namespace detail +} // namespace nlohmann + +// The Addition to the STD Namespace is required to add +// Structured Bindings Support to the iteration_proxy_value class +// For further reference see https://blog.tartanllama.xyz/structured-bindings/ +// And see https://github.com/nlohmann/json/pull/1391 +namespace std +{ +#if defined(__clang__) + // Fix: https://github.com/nlohmann/json/issues/1401 + #pragma clang diagnostic push + #pragma clang diagnostic ignored "-Wmismatched-tags" +#endif +template +class tuple_size<::nlohmann::detail::iteration_proxy_value> + : public std::integral_constant {}; + +template +class tuple_element> +{ + public: + using type = decltype( + get(std::declval < + ::nlohmann::detail::iteration_proxy_value> ())); +}; +#if defined(__clang__) + #pragma clang diagnostic pop +#endif +} // namespace std + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +////////////////// +// constructors // +////////////////// + +template struct external_constructor; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept + { + j.m_type = value_t::boolean; + j.m_value = b; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s) + { + j.m_type = value_t::string; + j.m_value = s; + j.assert_invariant(); + } + + template + static void construct(BasicJsonType& j, typename BasicJsonType::string_t&& s) + { + j.m_type = value_t::string; + j.m_value = std::move(s); + j.assert_invariant(); + } + + template < typename BasicJsonType, typename CompatibleStringType, + enable_if_t < !std::is_same::value, + int > = 0 > + static void construct(BasicJsonType& j, const CompatibleStringType& str) + { + j.m_type = value_t::string; + j.m_value.string = j.template create(str); + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, const typename BasicJsonType::binary_t& b) + { + j.m_type = value_t::binary; + typename BasicJsonType::binary_t value{b}; + j.m_value = value; + j.assert_invariant(); + } + + template + static void construct(BasicJsonType& j, typename BasicJsonType::binary_t&& b) + { + j.m_type = value_t::binary; + typename BasicJsonType::binary_t value{std::move(b)}; + j.m_value = value; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept + { + j.m_type = value_t::number_float; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept + { + j.m_type = value_t::number_unsigned; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept + { + j.m_type = value_t::number_integer; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr) + { + j.m_type = value_t::array; + j.m_value = arr; + j.assert_invariant(); + } + + template + static void construct(BasicJsonType& j, typename BasicJsonType::array_t&& arr) + { + j.m_type = value_t::array; + j.m_value = std::move(arr); + j.assert_invariant(); + } + + template < typename BasicJsonType, typename CompatibleArrayType, + enable_if_t < !std::is_same::value, + int > = 0 > + static void construct(BasicJsonType& j, const CompatibleArrayType& arr) + { + using std::begin; + using std::end; + j.m_type = value_t::array; + j.m_value.array = j.template create(begin(arr), end(arr)); + j.assert_invariant(); + } + + template + static void construct(BasicJsonType& j, const std::vector& arr) + { + j.m_type = value_t::array; + j.m_value = value_t::array; + j.m_value.array->reserve(arr.size()); + for (const bool x : arr) + { + j.m_value.array->push_back(x); + } + j.assert_invariant(); + } + + template::value, int> = 0> + static void construct(BasicJsonType& j, const std::valarray& arr) + { + j.m_type = value_t::array; + j.m_value = value_t::array; + j.m_value.array->resize(arr.size()); + if (arr.size() > 0) + { + std::copy(std::begin(arr), std::end(arr), j.m_value.array->begin()); + } + j.assert_invariant(); + } +}; + +template<> +struct external_constructor +{ + template + static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj) + { + j.m_type = value_t::object; + j.m_value = obj; + j.assert_invariant(); + } + + template + static void construct(BasicJsonType& j, typename BasicJsonType::object_t&& obj) + { + j.m_type = value_t::object; + j.m_value = std::move(obj); + j.assert_invariant(); + } + + template < typename BasicJsonType, typename CompatibleObjectType, + enable_if_t < !std::is_same::value, int > = 0 > + static void construct(BasicJsonType& j, const CompatibleObjectType& obj) + { + using std::begin; + using std::end; + + j.m_type = value_t::object; + j.m_value.object = j.template create(begin(obj), end(obj)); + j.assert_invariant(); + } +}; + +///////////// +// to_json // +///////////// + +template::value, int> = 0> +void to_json(BasicJsonType& j, T b) noexcept +{ + external_constructor::construct(j, b); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, const CompatibleString& s) +{ + external_constructor::construct(j, s); +} + +template +void to_json(BasicJsonType& j, typename BasicJsonType::string_t&& s) +{ + external_constructor::construct(j, std::move(s)); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, FloatType val) noexcept +{ + external_constructor::construct(j, static_cast(val)); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept +{ + external_constructor::construct(j, static_cast(val)); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept +{ + external_constructor::construct(j, static_cast(val)); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, EnumType e) noexcept +{ + using underlying_type = typename std::underlying_type::type; + external_constructor::construct(j, static_cast(e)); +} + +template +void to_json(BasicJsonType& j, const std::vector& e) +{ + external_constructor::construct(j, e); +} + +template < typename BasicJsonType, typename CompatibleArrayType, + enable_if_t < is_compatible_array_type::value&& + !is_compatible_object_type::value&& + !is_compatible_string_type::value&& + !std::is_same::value&& + !is_basic_json::value, + int > = 0 > +void to_json(BasicJsonType& j, const CompatibleArrayType& arr) +{ + external_constructor::construct(j, arr); +} + +template +void to_json(BasicJsonType& j, const typename BasicJsonType::binary_t& bin) +{ + external_constructor::construct(j, bin); +} + +template::value, int> = 0> +void to_json(BasicJsonType& j, const std::valarray& arr) +{ + external_constructor::construct(j, std::move(arr)); +} + +template +void to_json(BasicJsonType& j, typename BasicJsonType::array_t&& arr) +{ + external_constructor::construct(j, std::move(arr)); +} + +template < typename BasicJsonType, typename CompatibleObjectType, + enable_if_t < is_compatible_object_type::value&& !is_basic_json::value, int > = 0 > +void to_json(BasicJsonType& j, const CompatibleObjectType& obj) +{ + external_constructor::construct(j, obj); +} + +template +void to_json(BasicJsonType& j, typename BasicJsonType::object_t&& obj) +{ + external_constructor::construct(j, std::move(obj)); +} + +template < + typename BasicJsonType, typename T, std::size_t N, + enable_if_t < !std::is_constructible::value, + int > = 0 > +void to_json(BasicJsonType& j, const T(&arr)[N]) +{ + external_constructor::construct(j, arr); +} + +template < typename BasicJsonType, typename T1, typename T2, enable_if_t < std::is_constructible::value&& std::is_constructible::value, int > = 0 > +void to_json(BasicJsonType& j, const std::pair& p) +{ + j = { p.first, p.second }; +} + +// for https://github.com/nlohmann/json/pull/1134 +template>::value, int> = 0> +void to_json(BasicJsonType& j, const T& b) +{ + j = { {b.key(), b.value()} }; +} + +template +void to_json_tuple_impl(BasicJsonType& j, const Tuple& t, index_sequence /*unused*/) +{ + j = { std::get(t)... }; +} + +template::value, int > = 0> +void to_json(BasicJsonType& j, const T& t) +{ + to_json_tuple_impl(j, t, make_index_sequence::value> {}); +} + +struct to_json_fn +{ + template + auto operator()(BasicJsonType& j, T&& val) const noexcept(noexcept(to_json(j, std::forward(val)))) + -> decltype(to_json(j, std::forward(val)), void()) + { + return to_json(j, std::forward(val)); + } +}; +} // namespace detail + +/// namespace to hold default `to_json` function +namespace +{ +constexpr const auto& to_json = detail::static_const::value; +} // namespace +} // namespace nlohmann + + +namespace nlohmann +{ + +template +struct adl_serializer +{ + /*! + @brief convert a JSON value to any value type + + This function is usually called by the `get()` function of the + @ref basic_json class (either explicit or via conversion operators). + + @param[in] j JSON value to read from + @param[in,out] val value to write to + */ + template + static auto from_json(BasicJsonType&& j, ValueType& val) noexcept( + noexcept(::nlohmann::from_json(std::forward(j), val))) + -> decltype(::nlohmann::from_json(std::forward(j), val), void()) + { + ::nlohmann::from_json(std::forward(j), val); + } + + /*! + @brief convert any value type to a JSON value + + This function is usually called by the constructors of the @ref basic_json + class. + + @param[in,out] j JSON value to write to + @param[in] val value to read from + */ + template + static auto to_json(BasicJsonType& j, ValueType&& val) noexcept( + noexcept(::nlohmann::to_json(j, std::forward(val)))) + -> decltype(::nlohmann::to_json(j, std::forward(val)), void()) + { + ::nlohmann::to_json(j, std::forward(val)); + } +}; + +} // namespace nlohmann + +// #include + + +#include // uint8_t +#include // tie +#include // move + +namespace nlohmann +{ + +/*! +@brief an internal type for a backed binary type + +This type extends the template parameter @a BinaryType provided to `basic_json` +with a subtype used by BSON and MessagePack. This type exists so that the user +does not have to specify a type themselves with a specific naming scheme in +order to override the binary type. + +@tparam BinaryType container to store bytes (`std::vector` by + default) + +@since version 3.8.0 +*/ +template +class byte_container_with_subtype : public BinaryType +{ + public: + /// the type of the underlying container + using container_type = BinaryType; + + byte_container_with_subtype() noexcept(noexcept(container_type())) + : container_type() + {} + + byte_container_with_subtype(const container_type& b) noexcept(noexcept(container_type(b))) + : container_type(b) + {} + + byte_container_with_subtype(container_type&& b) noexcept(noexcept(container_type(std::move(b)))) + : container_type(std::move(b)) + {} + + byte_container_with_subtype(const container_type& b, std::uint8_t subtype) noexcept(noexcept(container_type(b))) + : container_type(b) + , m_subtype(subtype) + , m_has_subtype(true) + {} + + byte_container_with_subtype(container_type&& b, std::uint8_t subtype) noexcept(noexcept(container_type(std::move(b)))) + : container_type(std::move(b)) + , m_subtype(subtype) + , m_has_subtype(true) + {} + + bool operator==(const byte_container_with_subtype& rhs) const + { + return std::tie(static_cast(*this), m_subtype, m_has_subtype) == + std::tie(static_cast(rhs), rhs.m_subtype, rhs.m_has_subtype); + } + + bool operator!=(const byte_container_with_subtype& rhs) const + { + return !(rhs == *this); + } + + /*! + @brief sets the binary subtype + + Sets the binary subtype of the value, also flags a binary JSON value as + having a subtype, which has implications for serialization. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @sa @ref subtype() -- return the binary subtype + @sa @ref clear_subtype() -- clears the binary subtype + @sa @ref has_subtype() -- returns whether or not the binary value has a + subtype + + @since version 3.8.0 + */ + void set_subtype(std::uint8_t subtype) noexcept + { + m_subtype = subtype; + m_has_subtype = true; + } + + /*! + @brief return the binary subtype + + Returns the numerical subtype of the value if it has a subtype. If it does + not have a subtype, this function will return size_t(-1) as a sentinel + value. + + @return the numerical subtype of the binary value + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @sa @ref set_subtype() -- sets the binary subtype + @sa @ref clear_subtype() -- clears the binary subtype + @sa @ref has_subtype() -- returns whether or not the binary value has a + subtype + + @since version 3.8.0 + */ + constexpr std::uint8_t subtype() const noexcept + { + return m_subtype; + } + + /*! + @brief return whether the value has a subtype + + @return whether the value has a subtype + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @sa @ref subtype() -- return the binary subtype + @sa @ref set_subtype() -- sets the binary subtype + @sa @ref clear_subtype() -- clears the binary subtype + + @since version 3.8.0 + */ + constexpr bool has_subtype() const noexcept + { + return m_has_subtype; + } + + /*! + @brief clears the binary subtype + + Clears the binary subtype and flags the value as not having a subtype, which + has implications for serialization; for instance MessagePack will prefer the + bin family over the ext family. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @sa @ref subtype() -- return the binary subtype + @sa @ref set_subtype() -- sets the binary subtype + @sa @ref has_subtype() -- returns whether or not the binary value has a + subtype + + @since version 3.8.0 + */ + void clear_subtype() noexcept + { + m_subtype = 0; + m_has_subtype = false; + } + + private: + std::uint8_t m_subtype = 0; + bool m_has_subtype = false; +}; + +} // namespace nlohmann + +// #include + +// #include + +// #include + +// #include + + +#include // size_t, uint8_t +#include // hash + +namespace nlohmann +{ +namespace detail +{ + +// boost::hash_combine +inline std::size_t combine(std::size_t seed, std::size_t h) noexcept +{ + seed ^= h + 0x9e3779b9 + (seed << 6U) + (seed >> 2U); + return seed; +} + +/*! +@brief hash a JSON value + +The hash function tries to rely on std::hash where possible. Furthermore, the +type of the JSON value is taken into account to have different hash values for +null, 0, 0U, and false, etc. + +@tparam BasicJsonType basic_json specialization +@param j JSON value to hash +@return hash value of j +*/ +template +std::size_t hash(const BasicJsonType& j) +{ + using string_t = typename BasicJsonType::string_t; + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + + const auto type = static_cast(j.type()); + switch (j.type()) + { + case BasicJsonType::value_t::null: + case BasicJsonType::value_t::discarded: + { + return combine(type, 0); + } + + case BasicJsonType::value_t::object: + { + auto seed = combine(type, j.size()); + for (const auto& element : j.items()) + { + const auto h = std::hash {}(element.key()); + seed = combine(seed, h); + seed = combine(seed, hash(element.value())); + } + return seed; + } + + case BasicJsonType::value_t::array: + { + auto seed = combine(type, j.size()); + for (const auto& element : j) + { + seed = combine(seed, hash(element)); + } + return seed; + } + + case BasicJsonType::value_t::string: + { + const auto h = std::hash {}(j.template get_ref()); + return combine(type, h); + } + + case BasicJsonType::value_t::boolean: + { + const auto h = std::hash {}(j.template get()); + return combine(type, h); + } + + case BasicJsonType::value_t::number_integer: + { + const auto h = std::hash {}(j.template get()); + return combine(type, h); + } + + case nlohmann::detail::value_t::number_unsigned: + { + const auto h = std::hash {}(j.template get()); + return combine(type, h); + } + + case nlohmann::detail::value_t::number_float: + { + const auto h = std::hash {}(j.template get()); + return combine(type, h); + } + + case nlohmann::detail::value_t::binary: + { + auto seed = combine(type, j.get_binary().size()); + const auto h = std::hash {}(j.get_binary().has_subtype()); + seed = combine(seed, h); + seed = combine(seed, j.get_binary().subtype()); + for (const auto byte : j.get_binary()) + { + seed = combine(seed, std::hash {}(byte)); + } + return seed; + } + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } +} + +} // namespace detail +} // namespace nlohmann + +// #include + + +#include // generate_n +#include // array +#include // ldexp +#include // size_t +#include // uint8_t, uint16_t, uint32_t, uint64_t +#include // snprintf +#include // memcpy +#include // back_inserter +#include // numeric_limits +#include // char_traits, string +#include // make_pair, move + +// #include + +// #include + + +#include // array +#include // size_t +#include //FILE * +#include // strlen +#include // istream +#include // begin, end, iterator_traits, random_access_iterator_tag, distance, next +#include // shared_ptr, make_shared, addressof +#include // accumulate +#include // string, char_traits +#include // enable_if, is_base_of, is_pointer, is_integral, remove_pointer +#include // pair, declval + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +/// the supported input formats +enum class input_format_t { json, cbor, msgpack, ubjson, bson }; + +//////////////////// +// input adapters // +//////////////////// + +/*! +Input adapter for stdio file access. This adapter read only 1 byte and do not use any + buffer. This adapter is a very low level adapter. +*/ +class file_input_adapter +{ + public: + using char_type = char; + + JSON_HEDLEY_NON_NULL(2) + explicit file_input_adapter(std::FILE* f) noexcept + : m_file(f) + {} + + // make class move-only + file_input_adapter(const file_input_adapter&) = delete; + file_input_adapter(file_input_adapter&&) = default; + file_input_adapter& operator=(const file_input_adapter&) = delete; + file_input_adapter& operator=(file_input_adapter&&) = delete; + + std::char_traits::int_type get_character() noexcept + { + return std::fgetc(m_file); + } + + private: + /// the file pointer to read from + std::FILE* m_file; +}; + + +/*! +Input adapter for a (caching) istream. Ignores a UFT Byte Order Mark at +beginning of input. Does not support changing the underlying std::streambuf +in mid-input. Maintains underlying std::istream and std::streambuf to support +subsequent use of standard std::istream operations to process any input +characters following those used in parsing the JSON input. Clears the +std::istream flags; any input errors (e.g., EOF) will be detected by the first +subsequent call for input from the std::istream. +*/ +class input_stream_adapter +{ + public: + using char_type = char; + + ~input_stream_adapter() + { + // clear stream flags; we use underlying streambuf I/O, do not + // maintain ifstream flags, except eof + if (is != nullptr) + { + is->clear(is->rdstate() & std::ios::eofbit); + } + } + + explicit input_stream_adapter(std::istream& i) + : is(&i), sb(i.rdbuf()) + {} + + // delete because of pointer members + input_stream_adapter(const input_stream_adapter&) = delete; + input_stream_adapter& operator=(input_stream_adapter&) = delete; + input_stream_adapter& operator=(input_stream_adapter&& rhs) = delete; + + input_stream_adapter(input_stream_adapter&& rhs) noexcept : is(rhs.is), sb(rhs.sb) + { + rhs.is = nullptr; + rhs.sb = nullptr; + } + + // std::istream/std::streambuf use std::char_traits::to_int_type, to + // ensure that std::char_traits::eof() and the character 0xFF do not + // end up as the same value, eg. 0xFFFFFFFF. + std::char_traits::int_type get_character() + { + auto res = sb->sbumpc(); + // set eof manually, as we don't use the istream interface. + if (JSON_HEDLEY_UNLIKELY(res == EOF)) + { + is->clear(is->rdstate() | std::ios::eofbit); + } + return res; + } + + private: + /// the associated input stream + std::istream* is = nullptr; + std::streambuf* sb = nullptr; +}; + +// General-purpose iterator-based adapter. It might not be as fast as +// theoretically possible for some containers, but it is extremely versatile. +template +class iterator_input_adapter +{ + public: + using char_type = typename std::iterator_traits::value_type; + + iterator_input_adapter(IteratorType first, IteratorType last) + : current(std::move(first)), end(std::move(last)) {} + + typename std::char_traits::int_type get_character() + { + if (JSON_HEDLEY_LIKELY(current != end)) + { + auto result = std::char_traits::to_int_type(*current); + std::advance(current, 1); + return result; + } + else + { + return std::char_traits::eof(); + } + } + + private: + IteratorType current; + IteratorType end; + + template + friend struct wide_string_input_helper; + + bool empty() const + { + return current == end; + } + +}; + + +template +struct wide_string_input_helper; + +template +struct wide_string_input_helper +{ + // UTF-32 + static void fill_buffer(BaseInputAdapter& input, + std::array::int_type, 4>& utf8_bytes, + size_t& utf8_bytes_index, + size_t& utf8_bytes_filled) + { + utf8_bytes_index = 0; + + if (JSON_HEDLEY_UNLIKELY(input.empty())) + { + utf8_bytes[0] = std::char_traits::eof(); + utf8_bytes_filled = 1; + } + else + { + // get the current character + const auto wc = input.get_character(); + + // UTF-32 to UTF-8 encoding + if (wc < 0x80) + { + utf8_bytes[0] = static_cast::int_type>(wc); + utf8_bytes_filled = 1; + } + else if (wc <= 0x7FF) + { + utf8_bytes[0] = static_cast::int_type>(0xC0u | ((static_cast(wc) >> 6u) & 0x1Fu)); + utf8_bytes[1] = static_cast::int_type>(0x80u | (static_cast(wc) & 0x3Fu)); + utf8_bytes_filled = 2; + } + else if (wc <= 0xFFFF) + { + utf8_bytes[0] = static_cast::int_type>(0xE0u | ((static_cast(wc) >> 12u) & 0x0Fu)); + utf8_bytes[1] = static_cast::int_type>(0x80u | ((static_cast(wc) >> 6u) & 0x3Fu)); + utf8_bytes[2] = static_cast::int_type>(0x80u | (static_cast(wc) & 0x3Fu)); + utf8_bytes_filled = 3; + } + else if (wc <= 0x10FFFF) + { + utf8_bytes[0] = static_cast::int_type>(0xF0u | ((static_cast(wc) >> 18u) & 0x07u)); + utf8_bytes[1] = static_cast::int_type>(0x80u | ((static_cast(wc) >> 12u) & 0x3Fu)); + utf8_bytes[2] = static_cast::int_type>(0x80u | ((static_cast(wc) >> 6u) & 0x3Fu)); + utf8_bytes[3] = static_cast::int_type>(0x80u | (static_cast(wc) & 0x3Fu)); + utf8_bytes_filled = 4; + } + else + { + // unknown character + utf8_bytes[0] = static_cast::int_type>(wc); + utf8_bytes_filled = 1; + } + } + } +}; + +template +struct wide_string_input_helper +{ + // UTF-16 + static void fill_buffer(BaseInputAdapter& input, + std::array::int_type, 4>& utf8_bytes, + size_t& utf8_bytes_index, + size_t& utf8_bytes_filled) + { + utf8_bytes_index = 0; + + if (JSON_HEDLEY_UNLIKELY(input.empty())) + { + utf8_bytes[0] = std::char_traits::eof(); + utf8_bytes_filled = 1; + } + else + { + // get the current character + const auto wc = input.get_character(); + + // UTF-16 to UTF-8 encoding + if (wc < 0x80) + { + utf8_bytes[0] = static_cast::int_type>(wc); + utf8_bytes_filled = 1; + } + else if (wc <= 0x7FF) + { + utf8_bytes[0] = static_cast::int_type>(0xC0u | ((static_cast(wc) >> 6u))); + utf8_bytes[1] = static_cast::int_type>(0x80u | (static_cast(wc) & 0x3Fu)); + utf8_bytes_filled = 2; + } + else if (0xD800 > wc || wc >= 0xE000) + { + utf8_bytes[0] = static_cast::int_type>(0xE0u | ((static_cast(wc) >> 12u))); + utf8_bytes[1] = static_cast::int_type>(0x80u | ((static_cast(wc) >> 6u) & 0x3Fu)); + utf8_bytes[2] = static_cast::int_type>(0x80u | (static_cast(wc) & 0x3Fu)); + utf8_bytes_filled = 3; + } + else + { + if (JSON_HEDLEY_UNLIKELY(!input.empty())) + { + const auto wc2 = static_cast(input.get_character()); + const auto charcode = 0x10000u + (((static_cast(wc) & 0x3FFu) << 10u) | (wc2 & 0x3FFu)); + utf8_bytes[0] = static_cast::int_type>(0xF0u | (charcode >> 18u)); + utf8_bytes[1] = static_cast::int_type>(0x80u | ((charcode >> 12u) & 0x3Fu)); + utf8_bytes[2] = static_cast::int_type>(0x80u | ((charcode >> 6u) & 0x3Fu)); + utf8_bytes[3] = static_cast::int_type>(0x80u | (charcode & 0x3Fu)); + utf8_bytes_filled = 4; + } + else + { + utf8_bytes[0] = static_cast::int_type>(wc); + utf8_bytes_filled = 1; + } + } + } + } +}; + +// Wraps another input apdater to convert wide character types into individual bytes. +template +class wide_string_input_adapter +{ + public: + using char_type = char; + + wide_string_input_adapter(BaseInputAdapter base) + : base_adapter(base) {} + + typename std::char_traits::int_type get_character() noexcept + { + // check if buffer needs to be filled + if (utf8_bytes_index == utf8_bytes_filled) + { + fill_buffer(); + + JSON_ASSERT(utf8_bytes_filled > 0); + JSON_ASSERT(utf8_bytes_index == 0); + } + + // use buffer + JSON_ASSERT(utf8_bytes_filled > 0); + JSON_ASSERT(utf8_bytes_index < utf8_bytes_filled); + return utf8_bytes[utf8_bytes_index++]; + } + + private: + BaseInputAdapter base_adapter; + + template + void fill_buffer() + { + wide_string_input_helper::fill_buffer(base_adapter, utf8_bytes, utf8_bytes_index, utf8_bytes_filled); + } + + /// a buffer for UTF-8 bytes + std::array::int_type, 4> utf8_bytes = {{0, 0, 0, 0}}; + + /// index to the utf8_codes array for the next valid byte + std::size_t utf8_bytes_index = 0; + /// number of valid bytes in the utf8_codes array + std::size_t utf8_bytes_filled = 0; +}; + + +template +struct iterator_input_adapter_factory +{ + using iterator_type = IteratorType; + using char_type = typename std::iterator_traits::value_type; + using adapter_type = iterator_input_adapter; + + static adapter_type create(IteratorType first, IteratorType last) + { + return adapter_type(std::move(first), std::move(last)); + } +}; + +template +struct is_iterator_of_multibyte +{ + using value_type = typename std::iterator_traits::value_type; + enum + { + value = sizeof(value_type) > 1 + }; +}; + +template +struct iterator_input_adapter_factory::value>> +{ + using iterator_type = IteratorType; + using char_type = typename std::iterator_traits::value_type; + using base_adapter_type = iterator_input_adapter; + using adapter_type = wide_string_input_adapter; + + static adapter_type create(IteratorType first, IteratorType last) + { + return adapter_type(base_adapter_type(std::move(first), std::move(last))); + } +}; + +// General purpose iterator-based input +template +typename iterator_input_adapter_factory::adapter_type input_adapter(IteratorType first, IteratorType last) +{ + using factory_type = iterator_input_adapter_factory; + return factory_type::create(first, last); +} + +// Convenience shorthand from container to iterator +template +auto input_adapter(const ContainerType& container) -> decltype(input_adapter(begin(container), end(container))) +{ + // Enable ADL + using std::begin; + using std::end; + + return input_adapter(begin(container), end(container)); +} + +// Special cases with fast paths +inline file_input_adapter input_adapter(std::FILE* file) +{ + return file_input_adapter(file); +} + +inline input_stream_adapter input_adapter(std::istream& stream) +{ + return input_stream_adapter(stream); +} + +inline input_stream_adapter input_adapter(std::istream&& stream) +{ + return input_stream_adapter(stream); +} + +using contiguous_bytes_input_adapter = decltype(input_adapter(std::declval(), std::declval())); + +// Null-delimited strings, and the like. +template < typename CharT, + typename std::enable_if < + std::is_pointer::value&& + !std::is_array::value&& + std::is_integral::type>::value&& + sizeof(typename std::remove_pointer::type) == 1, + int >::type = 0 > +contiguous_bytes_input_adapter input_adapter(CharT b) +{ + auto length = std::strlen(reinterpret_cast(b)); + const auto* ptr = reinterpret_cast(b); + return input_adapter(ptr, ptr + length); +} + +template +auto input_adapter(T (&array)[N]) -> decltype(input_adapter(array, array + N)) +{ + return input_adapter(array, array + N); +} + +// This class only handles inputs of input_buffer_adapter type. +// It's required so that expressions like {ptr, len} can be implicitely casted +// to the correct adapter. +class span_input_adapter +{ + public: + template < typename CharT, + typename std::enable_if < + std::is_pointer::value&& + std::is_integral::type>::value&& + sizeof(typename std::remove_pointer::type) == 1, + int >::type = 0 > + span_input_adapter(CharT b, std::size_t l) + : ia(reinterpret_cast(b), reinterpret_cast(b) + l) {} + + template::iterator_category, std::random_access_iterator_tag>::value, + int>::type = 0> + span_input_adapter(IteratorType first, IteratorType last) + : ia(input_adapter(first, last)) {} + + contiguous_bytes_input_adapter&& get() + { + return std::move(ia); + } + + private: + contiguous_bytes_input_adapter ia; +}; +} // namespace detail +} // namespace nlohmann + +// #include + + +#include +#include // string +#include // move +#include // vector + +// #include + +// #include + + +namespace nlohmann +{ + +/*! +@brief SAX interface + +This class describes the SAX interface used by @ref nlohmann::json::sax_parse. +Each function is called in different situations while the input is parsed. The +boolean return value informs the parser whether to continue processing the +input. +*/ +template +struct json_sax +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + + /*! + @brief a null value was read + @return whether parsing should proceed + */ + virtual bool null() = 0; + + /*! + @brief a boolean value was read + @param[in] val boolean value + @return whether parsing should proceed + */ + virtual bool boolean(bool val) = 0; + + /*! + @brief an integer number was read + @param[in] val integer value + @return whether parsing should proceed + */ + virtual bool number_integer(number_integer_t val) = 0; + + /*! + @brief an unsigned integer number was read + @param[in] val unsigned integer value + @return whether parsing should proceed + */ + virtual bool number_unsigned(number_unsigned_t val) = 0; + + /*! + @brief an floating-point number was read + @param[in] val floating-point value + @param[in] s raw token value + @return whether parsing should proceed + */ + virtual bool number_float(number_float_t val, const string_t& s) = 0; + + /*! + @brief a string was read + @param[in] val string value + @return whether parsing should proceed + @note It is safe to move the passed string. + */ + virtual bool string(string_t& val) = 0; + + /*! + @brief a binary string was read + @param[in] val binary value + @return whether parsing should proceed + @note It is safe to move the passed binary. + */ + virtual bool binary(binary_t& val) = 0; + + /*! + @brief the beginning of an object was read + @param[in] elements number of object elements or -1 if unknown + @return whether parsing should proceed + @note binary formats may report the number of elements + */ + virtual bool start_object(std::size_t elements) = 0; + + /*! + @brief an object key was read + @param[in] val object key + @return whether parsing should proceed + @note It is safe to move the passed string. + */ + virtual bool key(string_t& val) = 0; + + /*! + @brief the end of an object was read + @return whether parsing should proceed + */ + virtual bool end_object() = 0; + + /*! + @brief the beginning of an array was read + @param[in] elements number of array elements or -1 if unknown + @return whether parsing should proceed + @note binary formats may report the number of elements + */ + virtual bool start_array(std::size_t elements) = 0; + + /*! + @brief the end of an array was read + @return whether parsing should proceed + */ + virtual bool end_array() = 0; + + /*! + @brief a parse error occurred + @param[in] position the position in the input where the error occurs + @param[in] last_token the last read token + @param[in] ex an exception object describing the error + @return whether parsing should proceed (must return false) + */ + virtual bool parse_error(std::size_t position, + const std::string& last_token, + const detail::exception& ex) = 0; + + virtual ~json_sax() = default; +}; + + +namespace detail +{ +/*! +@brief SAX implementation to create a JSON value from SAX events + +This class implements the @ref json_sax interface and processes the SAX events +to create a JSON value which makes it basically a DOM parser. The structure or +hierarchy of the JSON value is managed by the stack `ref_stack` which contains +a pointer to the respective array or object for each recursion depth. + +After successful parsing, the value that is passed by reference to the +constructor contains the parsed value. + +@tparam BasicJsonType the JSON type +*/ +template +class json_sax_dom_parser +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + + /*! + @param[in, out] r reference to a JSON value that is manipulated while + parsing + @param[in] allow_exceptions_ whether parse errors yield exceptions + */ + explicit json_sax_dom_parser(BasicJsonType& r, const bool allow_exceptions_ = true) + : root(r), allow_exceptions(allow_exceptions_) + {} + + // make class move-only + json_sax_dom_parser(const json_sax_dom_parser&) = delete; + json_sax_dom_parser(json_sax_dom_parser&&) = default; + json_sax_dom_parser& operator=(const json_sax_dom_parser&) = delete; + json_sax_dom_parser& operator=(json_sax_dom_parser&&) = default; + ~json_sax_dom_parser() = default; + + bool null() + { + handle_value(nullptr); + return true; + } + + bool boolean(bool val) + { + handle_value(val); + return true; + } + + bool number_integer(number_integer_t val) + { + handle_value(val); + return true; + } + + bool number_unsigned(number_unsigned_t val) + { + handle_value(val); + return true; + } + + bool number_float(number_float_t val, const string_t& /*unused*/) + { + handle_value(val); + return true; + } + + bool string(string_t& val) + { + handle_value(val); + return true; + } + + bool binary(binary_t& val) + { + handle_value(std::move(val)); + return true; + } + + bool start_object(std::size_t len) + { + ref_stack.push_back(handle_value(BasicJsonType::value_t::object)); + + if (JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive object size: " + std::to_string(len))); + } + + return true; + } + + bool key(string_t& val) + { + // add null at given key and store the reference for later + object_element = &(ref_stack.back()->m_value.object->operator[](val)); + return true; + } + + bool end_object() + { + ref_stack.pop_back(); + return true; + } + + bool start_array(std::size_t len) + { + ref_stack.push_back(handle_value(BasicJsonType::value_t::array)); + + if (JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive array size: " + std::to_string(len))); + } + + return true; + } + + bool end_array() + { + ref_stack.pop_back(); + return true; + } + + template + bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/, + const Exception& ex) + { + errored = true; + static_cast(ex); + if (allow_exceptions) + { + JSON_THROW(ex); + } + return false; + } + + constexpr bool is_errored() const + { + return errored; + } + + private: + /*! + @invariant If the ref stack is empty, then the passed value will be the new + root. + @invariant If the ref stack contains a value, then it is an array or an + object to which we can add elements + */ + template + JSON_HEDLEY_RETURNS_NON_NULL + BasicJsonType* handle_value(Value&& v) + { + if (ref_stack.empty()) + { + root = BasicJsonType(std::forward(v)); + return &root; + } + + JSON_ASSERT(ref_stack.back()->is_array() || ref_stack.back()->is_object()); + + if (ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->emplace_back(std::forward(v)); + return &(ref_stack.back()->m_value.array->back()); + } + + JSON_ASSERT(ref_stack.back()->is_object()); + JSON_ASSERT(object_element); + *object_element = BasicJsonType(std::forward(v)); + return object_element; + } + + /// the parsed JSON value + BasicJsonType& root; + /// stack to model hierarchy of values + std::vector ref_stack {}; + /// helper to hold the reference for the next object element + BasicJsonType* object_element = nullptr; + /// whether a syntax error occurred + bool errored = false; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; +}; + +template +class json_sax_dom_callback_parser +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + using parser_callback_t = typename BasicJsonType::parser_callback_t; + using parse_event_t = typename BasicJsonType::parse_event_t; + + json_sax_dom_callback_parser(BasicJsonType& r, + const parser_callback_t cb, + const bool allow_exceptions_ = true) + : root(r), callback(cb), allow_exceptions(allow_exceptions_) + { + keep_stack.push_back(true); + } + + // make class move-only + json_sax_dom_callback_parser(const json_sax_dom_callback_parser&) = delete; + json_sax_dom_callback_parser(json_sax_dom_callback_parser&&) = default; + json_sax_dom_callback_parser& operator=(const json_sax_dom_callback_parser&) = delete; + json_sax_dom_callback_parser& operator=(json_sax_dom_callback_parser&&) = default; + ~json_sax_dom_callback_parser() = default; + + bool null() + { + handle_value(nullptr); + return true; + } + + bool boolean(bool val) + { + handle_value(val); + return true; + } + + bool number_integer(number_integer_t val) + { + handle_value(val); + return true; + } + + bool number_unsigned(number_unsigned_t val) + { + handle_value(val); + return true; + } + + bool number_float(number_float_t val, const string_t& /*unused*/) + { + handle_value(val); + return true; + } + + bool string(string_t& val) + { + handle_value(val); + return true; + } + + bool binary(binary_t& val) + { + handle_value(std::move(val)); + return true; + } + + bool start_object(std::size_t len) + { + // check callback for object start + const bool keep = callback(static_cast(ref_stack.size()), parse_event_t::object_start, discarded); + keep_stack.push_back(keep); + + auto val = handle_value(BasicJsonType::value_t::object, true); + ref_stack.push_back(val.second); + + // check object limit + if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, "excessive object size: " + std::to_string(len))); + } + + return true; + } + + bool key(string_t& val) + { + BasicJsonType k = BasicJsonType(val); + + // check callback for key + const bool keep = callback(static_cast(ref_stack.size()), parse_event_t::key, k); + key_keep_stack.push_back(keep); + + // add discarded value at given key and store the reference for later + if (keep && ref_stack.back()) + { + object_element = &(ref_stack.back()->m_value.object->operator[](val) = discarded); + } + + return true; + } + + bool end_object() + { + if (ref_stack.back() && !callback(static_cast(ref_stack.size()) - 1, parse_event_t::object_end, *ref_stack.back())) + { + // discard object + *ref_stack.back() = discarded; + } + + JSON_ASSERT(!ref_stack.empty()); + JSON_ASSERT(!keep_stack.empty()); + ref_stack.pop_back(); + keep_stack.pop_back(); + + if (!ref_stack.empty() && ref_stack.back() && ref_stack.back()->is_structured()) + { + // remove discarded value + for (auto it = ref_stack.back()->begin(); it != ref_stack.back()->end(); ++it) + { + if (it->is_discarded()) + { + ref_stack.back()->erase(it); + break; + } + } + } + + return true; + } + + bool start_array(std::size_t len) + { + const bool keep = callback(static_cast(ref_stack.size()), parse_event_t::array_start, discarded); + keep_stack.push_back(keep); + + auto val = handle_value(BasicJsonType::value_t::array, true); + ref_stack.push_back(val.second); + + // check array limit + if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, "excessive array size: " + std::to_string(len))); + } + + return true; + } + + bool end_array() + { + bool keep = true; + + if (ref_stack.back()) + { + keep = callback(static_cast(ref_stack.size()) - 1, parse_event_t::array_end, *ref_stack.back()); + if (!keep) + { + // discard array + *ref_stack.back() = discarded; + } + } + + JSON_ASSERT(!ref_stack.empty()); + JSON_ASSERT(!keep_stack.empty()); + ref_stack.pop_back(); + keep_stack.pop_back(); + + // remove discarded value + if (!keep && !ref_stack.empty() && ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->pop_back(); + } + + return true; + } + + template + bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/, + const Exception& ex) + { + errored = true; + static_cast(ex); + if (allow_exceptions) + { + JSON_THROW(ex); + } + return false; + } + + constexpr bool is_errored() const + { + return errored; + } + + private: + /*! + @param[in] v value to add to the JSON value we build during parsing + @param[in] skip_callback whether we should skip calling the callback + function; this is required after start_array() and + start_object() SAX events, because otherwise we would call the + callback function with an empty array or object, respectively. + + @invariant If the ref stack is empty, then the passed value will be the new + root. + @invariant If the ref stack contains a value, then it is an array or an + object to which we can add elements + + @return pair of boolean (whether value should be kept) and pointer (to the + passed value in the ref_stack hierarchy; nullptr if not kept) + */ + template + std::pair handle_value(Value&& v, const bool skip_callback = false) + { + JSON_ASSERT(!keep_stack.empty()); + + // do not handle this value if we know it would be added to a discarded + // container + if (!keep_stack.back()) + { + return {false, nullptr}; + } + + // create value + auto value = BasicJsonType(std::forward(v)); + + // check callback + const bool keep = skip_callback || callback(static_cast(ref_stack.size()), parse_event_t::value, value); + + // do not handle this value if we just learnt it shall be discarded + if (!keep) + { + return {false, nullptr}; + } + + if (ref_stack.empty()) + { + root = std::move(value); + return {true, &root}; + } + + // skip this value if we already decided to skip the parent + // (https://github.com/nlohmann/json/issues/971#issuecomment-413678360) + if (!ref_stack.back()) + { + return {false, nullptr}; + } + + // we now only expect arrays and objects + JSON_ASSERT(ref_stack.back()->is_array() || ref_stack.back()->is_object()); + + // array + if (ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->push_back(std::move(value)); + return {true, &(ref_stack.back()->m_value.array->back())}; + } + + // object + JSON_ASSERT(ref_stack.back()->is_object()); + // check if we should store an element for the current key + JSON_ASSERT(!key_keep_stack.empty()); + const bool store_element = key_keep_stack.back(); + key_keep_stack.pop_back(); + + if (!store_element) + { + return {false, nullptr}; + } + + JSON_ASSERT(object_element); + *object_element = std::move(value); + return {true, object_element}; + } + + /// the parsed JSON value + BasicJsonType& root; + /// stack to model hierarchy of values + std::vector ref_stack {}; + /// stack to manage which values to keep + std::vector keep_stack {}; + /// stack to manage which object keys to keep + std::vector key_keep_stack {}; + /// helper to hold the reference for the next object element + BasicJsonType* object_element = nullptr; + /// whether a syntax error occurred + bool errored = false; + /// callback function + const parser_callback_t callback = nullptr; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; + /// a discarded value for the callback + BasicJsonType discarded = BasicJsonType::value_t::discarded; +}; + +template +class json_sax_acceptor +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + + bool null() + { + return true; + } + + bool boolean(bool /*unused*/) + { + return true; + } + + bool number_integer(number_integer_t /*unused*/) + { + return true; + } + + bool number_unsigned(number_unsigned_t /*unused*/) + { + return true; + } + + bool number_float(number_float_t /*unused*/, const string_t& /*unused*/) + { + return true; + } + + bool string(string_t& /*unused*/) + { + return true; + } + + bool binary(binary_t& /*unused*/) + { + return true; + } + + bool start_object(std::size_t /*unused*/ = std::size_t(-1)) + { + return true; + } + + bool key(string_t& /*unused*/) + { + return true; + } + + bool end_object() + { + return true; + } + + bool start_array(std::size_t /*unused*/ = std::size_t(-1)) + { + return true; + } + + bool end_array() + { + return true; + } + + bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/, const detail::exception& /*unused*/) + { + return false; + } +}; +} // namespace detail + +} // namespace nlohmann + +// #include + + +#include // array +#include // localeconv +#include // size_t +#include // snprintf +#include // strtof, strtod, strtold, strtoll, strtoull +#include // initializer_list +#include // char_traits, string +#include // move +#include // vector + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +/////////// +// lexer // +/////////// + +template +class lexer_base +{ + public: + /// token types for the parser + enum class token_type + { + uninitialized, ///< indicating the scanner is uninitialized + literal_true, ///< the `true` literal + literal_false, ///< the `false` literal + literal_null, ///< the `null` literal + value_string, ///< a string -- use get_string() for actual value + value_unsigned, ///< an unsigned integer -- use get_number_unsigned() for actual value + value_integer, ///< a signed integer -- use get_number_integer() for actual value + value_float, ///< an floating point number -- use get_number_float() for actual value + begin_array, ///< the character for array begin `[` + begin_object, ///< the character for object begin `{` + end_array, ///< the character for array end `]` + end_object, ///< the character for object end `}` + name_separator, ///< the name separator `:` + value_separator, ///< the value separator `,` + parse_error, ///< indicating a parse error + end_of_input, ///< indicating the end of the input buffer + literal_or_value ///< a literal or the begin of a value (only for diagnostics) + }; + + /// return name of values of type token_type (only used for errors) + JSON_HEDLEY_RETURNS_NON_NULL + JSON_HEDLEY_CONST + static const char* token_type_name(const token_type t) noexcept + { + switch (t) + { + case token_type::uninitialized: + return ""; + case token_type::literal_true: + return "true literal"; + case token_type::literal_false: + return "false literal"; + case token_type::literal_null: + return "null literal"; + case token_type::value_string: + return "string literal"; + case token_type::value_unsigned: + case token_type::value_integer: + case token_type::value_float: + return "number literal"; + case token_type::begin_array: + return "'['"; + case token_type::begin_object: + return "'{'"; + case token_type::end_array: + return "']'"; + case token_type::end_object: + return "'}'"; + case token_type::name_separator: + return "':'"; + case token_type::value_separator: + return "','"; + case token_type::parse_error: + return ""; + case token_type::end_of_input: + return "end of input"; + case token_type::literal_or_value: + return "'[', '{', or a literal"; + // LCOV_EXCL_START + default: // catch non-enum values + return "unknown token"; + // LCOV_EXCL_STOP + } + } +}; +/*! +@brief lexical analysis + +This class organizes the lexical analysis during JSON deserialization. +*/ +template +class lexer : public lexer_base +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using char_type = typename InputAdapterType::char_type; + using char_int_type = typename std::char_traits::int_type; + + public: + using token_type = typename lexer_base::token_type; + + explicit lexer(InputAdapterType&& adapter, bool ignore_comments_ = false) + : ia(std::move(adapter)) + , ignore_comments(ignore_comments_) + , decimal_point_char(static_cast(get_decimal_point())) + {} + + // delete because of pointer members + lexer(const lexer&) = delete; + lexer(lexer&&) = default; + lexer& operator=(lexer&) = delete; + lexer& operator=(lexer&&) = default; + ~lexer() = default; + + private: + ///////////////////// + // locales + ///////////////////// + + /// return the locale-dependent decimal point + JSON_HEDLEY_PURE + static char get_decimal_point() noexcept + { + const auto* loc = localeconv(); + JSON_ASSERT(loc != nullptr); + return (loc->decimal_point == nullptr) ? '.' : *(loc->decimal_point); + } + + ///////////////////// + // scan functions + ///////////////////// + + /*! + @brief get codepoint from 4 hex characters following `\u` + + For input "\u c1 c2 c3 c4" the codepoint is: + (c1 * 0x1000) + (c2 * 0x0100) + (c3 * 0x0010) + c4 + = (c1 << 12) + (c2 << 8) + (c3 << 4) + (c4 << 0) + + Furthermore, the possible characters '0'..'9', 'A'..'F', and 'a'..'f' + must be converted to the integers 0x0..0x9, 0xA..0xF, 0xA..0xF, resp. The + conversion is done by subtracting the offset (0x30, 0x37, and 0x57) + between the ASCII value of the character and the desired integer value. + + @return codepoint (0x0000..0xFFFF) or -1 in case of an error (e.g. EOF or + non-hex character) + */ + int get_codepoint() + { + // this function only makes sense after reading `\u` + JSON_ASSERT(current == 'u'); + int codepoint = 0; + + const auto factors = { 12u, 8u, 4u, 0u }; + for (const auto factor : factors) + { + get(); + + if (current >= '0' && current <= '9') + { + codepoint += static_cast((static_cast(current) - 0x30u) << factor); + } + else if (current >= 'A' && current <= 'F') + { + codepoint += static_cast((static_cast(current) - 0x37u) << factor); + } + else if (current >= 'a' && current <= 'f') + { + codepoint += static_cast((static_cast(current) - 0x57u) << factor); + } + else + { + return -1; + } + } + + JSON_ASSERT(0x0000 <= codepoint && codepoint <= 0xFFFF); + return codepoint; + } + + /*! + @brief check if the next byte(s) are inside a given range + + Adds the current byte and, for each passed range, reads a new byte and + checks if it is inside the range. If a violation was detected, set up an + error message and return false. Otherwise, return true. + + @param[in] ranges list of integers; interpreted as list of pairs of + inclusive lower and upper bound, respectively + + @pre The passed list @a ranges must have 2, 4, or 6 elements; that is, + 1, 2, or 3 pairs. This precondition is enforced by an assertion. + + @return true if and only if no range violation was detected + */ + bool next_byte_in_range(std::initializer_list ranges) + { + JSON_ASSERT(ranges.size() == 2 || ranges.size() == 4 || ranges.size() == 6); + add(current); + + for (auto range = ranges.begin(); range != ranges.end(); ++range) + { + get(); + if (JSON_HEDLEY_LIKELY(*range <= current && current <= *(++range))) + { + add(current); + } + else + { + error_message = "invalid string: ill-formed UTF-8 byte"; + return false; + } + } + + return true; + } + + /*! + @brief scan a string literal + + This function scans a string according to Sect. 7 of RFC 7159. While + scanning, bytes are escaped and copied into buffer token_buffer. Then the + function returns successfully, token_buffer is *not* null-terminated (as it + may contain \0 bytes), and token_buffer.size() is the number of bytes in the + string. + + @return token_type::value_string if string could be successfully scanned, + token_type::parse_error otherwise + + @note In case of errors, variable error_message contains a textual + description. + */ + token_type scan_string() + { + // reset token_buffer (ignore opening quote) + reset(); + + // we entered the function by reading an open quote + JSON_ASSERT(current == '\"'); + + while (true) + { + // get next character + switch (get()) + { + // end of file while parsing string + case std::char_traits::eof(): + { + error_message = "invalid string: missing closing quote"; + return token_type::parse_error; + } + + // closing quote + case '\"': + { + return token_type::value_string; + } + + // escapes + case '\\': + { + switch (get()) + { + // quotation mark + case '\"': + add('\"'); + break; + // reverse solidus + case '\\': + add('\\'); + break; + // solidus + case '/': + add('/'); + break; + // backspace + case 'b': + add('\b'); + break; + // form feed + case 'f': + add('\f'); + break; + // line feed + case 'n': + add('\n'); + break; + // carriage return + case 'r': + add('\r'); + break; + // tab + case 't': + add('\t'); + break; + + // unicode escapes + case 'u': + { + const int codepoint1 = get_codepoint(); + int codepoint = codepoint1; // start with codepoint1 + + if (JSON_HEDLEY_UNLIKELY(codepoint1 == -1)) + { + error_message = "invalid string: '\\u' must be followed by 4 hex digits"; + return token_type::parse_error; + } + + // check if code point is a high surrogate + if (0xD800 <= codepoint1 && codepoint1 <= 0xDBFF) + { + // expect next \uxxxx entry + if (JSON_HEDLEY_LIKELY(get() == '\\' && get() == 'u')) + { + const int codepoint2 = get_codepoint(); + + if (JSON_HEDLEY_UNLIKELY(codepoint2 == -1)) + { + error_message = "invalid string: '\\u' must be followed by 4 hex digits"; + return token_type::parse_error; + } + + // check if codepoint2 is a low surrogate + if (JSON_HEDLEY_LIKELY(0xDC00 <= codepoint2 && codepoint2 <= 0xDFFF)) + { + // overwrite codepoint + codepoint = static_cast( + // high surrogate occupies the most significant 22 bits + (static_cast(codepoint1) << 10u) + // low surrogate occupies the least significant 15 bits + + static_cast(codepoint2) + // there is still the 0xD800, 0xDC00 and 0x10000 noise + // in the result so we have to subtract with: + // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00 + - 0x35FDC00u); + } + else + { + error_message = "invalid string: surrogate U+D800..U+DBFF must be followed by U+DC00..U+DFFF"; + return token_type::parse_error; + } + } + else + { + error_message = "invalid string: surrogate U+D800..U+DBFF must be followed by U+DC00..U+DFFF"; + return token_type::parse_error; + } + } + else + { + if (JSON_HEDLEY_UNLIKELY(0xDC00 <= codepoint1 && codepoint1 <= 0xDFFF)) + { + error_message = "invalid string: surrogate U+DC00..U+DFFF must follow U+D800..U+DBFF"; + return token_type::parse_error; + } + } + + // result of the above calculation yields a proper codepoint + JSON_ASSERT(0x00 <= codepoint && codepoint <= 0x10FFFF); + + // translate codepoint into bytes + if (codepoint < 0x80) + { + // 1-byte characters: 0xxxxxxx (ASCII) + add(static_cast(codepoint)); + } + else if (codepoint <= 0x7FF) + { + // 2-byte characters: 110xxxxx 10xxxxxx + add(static_cast(0xC0u | (static_cast(codepoint) >> 6u))); + add(static_cast(0x80u | (static_cast(codepoint) & 0x3Fu))); + } + else if (codepoint <= 0xFFFF) + { + // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx + add(static_cast(0xE0u | (static_cast(codepoint) >> 12u))); + add(static_cast(0x80u | ((static_cast(codepoint) >> 6u) & 0x3Fu))); + add(static_cast(0x80u | (static_cast(codepoint) & 0x3Fu))); + } + else + { + // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx + add(static_cast(0xF0u | (static_cast(codepoint) >> 18u))); + add(static_cast(0x80u | ((static_cast(codepoint) >> 12u) & 0x3Fu))); + add(static_cast(0x80u | ((static_cast(codepoint) >> 6u) & 0x3Fu))); + add(static_cast(0x80u | (static_cast(codepoint) & 0x3Fu))); + } + + break; + } + + // other characters after escape + default: + error_message = "invalid string: forbidden character after backslash"; + return token_type::parse_error; + } + + break; + } + + // invalid control characters + case 0x00: + { + error_message = "invalid string: control character U+0000 (NUL) must be escaped to \\u0000"; + return token_type::parse_error; + } + + case 0x01: + { + error_message = "invalid string: control character U+0001 (SOH) must be escaped to \\u0001"; + return token_type::parse_error; + } + + case 0x02: + { + error_message = "invalid string: control character U+0002 (STX) must be escaped to \\u0002"; + return token_type::parse_error; + } + + case 0x03: + { + error_message = "invalid string: control character U+0003 (ETX) must be escaped to \\u0003"; + return token_type::parse_error; + } + + case 0x04: + { + error_message = "invalid string: control character U+0004 (EOT) must be escaped to \\u0004"; + return token_type::parse_error; + } + + case 0x05: + { + error_message = "invalid string: control character U+0005 (ENQ) must be escaped to \\u0005"; + return token_type::parse_error; + } + + case 0x06: + { + error_message = "invalid string: control character U+0006 (ACK) must be escaped to \\u0006"; + return token_type::parse_error; + } + + case 0x07: + { + error_message = "invalid string: control character U+0007 (BEL) must be escaped to \\u0007"; + return token_type::parse_error; + } + + case 0x08: + { + error_message = "invalid string: control character U+0008 (BS) must be escaped to \\u0008 or \\b"; + return token_type::parse_error; + } + + case 0x09: + { + error_message = "invalid string: control character U+0009 (HT) must be escaped to \\u0009 or \\t"; + return token_type::parse_error; + } + + case 0x0A: + { + error_message = "invalid string: control character U+000A (LF) must be escaped to \\u000A or \\n"; + return token_type::parse_error; + } + + case 0x0B: + { + error_message = "invalid string: control character U+000B (VT) must be escaped to \\u000B"; + return token_type::parse_error; + } + + case 0x0C: + { + error_message = "invalid string: control character U+000C (FF) must be escaped to \\u000C or \\f"; + return token_type::parse_error; + } + + case 0x0D: + { + error_message = "invalid string: control character U+000D (CR) must be escaped to \\u000D or \\r"; + return token_type::parse_error; + } + + case 0x0E: + { + error_message = "invalid string: control character U+000E (SO) must be escaped to \\u000E"; + return token_type::parse_error; + } + + case 0x0F: + { + error_message = "invalid string: control character U+000F (SI) must be escaped to \\u000F"; + return token_type::parse_error; + } + + case 0x10: + { + error_message = "invalid string: control character U+0010 (DLE) must be escaped to \\u0010"; + return token_type::parse_error; + } + + case 0x11: + { + error_message = "invalid string: control character U+0011 (DC1) must be escaped to \\u0011"; + return token_type::parse_error; + } + + case 0x12: + { + error_message = "invalid string: control character U+0012 (DC2) must be escaped to \\u0012"; + return token_type::parse_error; + } + + case 0x13: + { + error_message = "invalid string: control character U+0013 (DC3) must be escaped to \\u0013"; + return token_type::parse_error; + } + + case 0x14: + { + error_message = "invalid string: control character U+0014 (DC4) must be escaped to \\u0014"; + return token_type::parse_error; + } + + case 0x15: + { + error_message = "invalid string: control character U+0015 (NAK) must be escaped to \\u0015"; + return token_type::parse_error; + } + + case 0x16: + { + error_message = "invalid string: control character U+0016 (SYN) must be escaped to \\u0016"; + return token_type::parse_error; + } + + case 0x17: + { + error_message = "invalid string: control character U+0017 (ETB) must be escaped to \\u0017"; + return token_type::parse_error; + } + + case 0x18: + { + error_message = "invalid string: control character U+0018 (CAN) must be escaped to \\u0018"; + return token_type::parse_error; + } + + case 0x19: + { + error_message = "invalid string: control character U+0019 (EM) must be escaped to \\u0019"; + return token_type::parse_error; + } + + case 0x1A: + { + error_message = "invalid string: control character U+001A (SUB) must be escaped to \\u001A"; + return token_type::parse_error; + } + + case 0x1B: + { + error_message = "invalid string: control character U+001B (ESC) must be escaped to \\u001B"; + return token_type::parse_error; + } + + case 0x1C: + { + error_message = "invalid string: control character U+001C (FS) must be escaped to \\u001C"; + return token_type::parse_error; + } + + case 0x1D: + { + error_message = "invalid string: control character U+001D (GS) must be escaped to \\u001D"; + return token_type::parse_error; + } + + case 0x1E: + { + error_message = "invalid string: control character U+001E (RS) must be escaped to \\u001E"; + return token_type::parse_error; + } + + case 0x1F: + { + error_message = "invalid string: control character U+001F (US) must be escaped to \\u001F"; + return token_type::parse_error; + } + + // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace)) + case 0x20: + case 0x21: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + case 0x38: + case 0x39: + case 0x3A: + case 0x3B: + case 0x3C: + case 0x3D: + case 0x3E: + case 0x3F: + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + case 0x58: + case 0x59: + case 0x5A: + case 0x5B: + case 0x5D: + case 0x5E: + case 0x5F: + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: + case 0x79: + case 0x7A: + case 0x7B: + case 0x7C: + case 0x7D: + case 0x7E: + case 0x7F: + { + add(current); + break; + } + + // U+0080..U+07FF: bytes C2..DF 80..BF + case 0xC2: + case 0xC3: + case 0xC4: + case 0xC5: + case 0xC6: + case 0xC7: + case 0xC8: + case 0xC9: + case 0xCA: + case 0xCB: + case 0xCC: + case 0xCD: + case 0xCE: + case 0xCF: + case 0xD0: + case 0xD1: + case 0xD2: + case 0xD3: + case 0xD4: + case 0xD5: + case 0xD6: + case 0xD7: + case 0xD8: + case 0xD9: + case 0xDA: + case 0xDB: + case 0xDC: + case 0xDD: + case 0xDE: + case 0xDF: + { + if (JSON_HEDLEY_UNLIKELY(!next_byte_in_range({0x80, 0xBF}))) + { + return token_type::parse_error; + } + break; + } + + // U+0800..U+0FFF: bytes E0 A0..BF 80..BF + case 0xE0: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0xA0, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+1000..U+CFFF: bytes E1..EC 80..BF 80..BF + // U+E000..U+FFFF: bytes EE..EF 80..BF 80..BF + case 0xE1: + case 0xE2: + case 0xE3: + case 0xE4: + case 0xE5: + case 0xE6: + case 0xE7: + case 0xE8: + case 0xE9: + case 0xEA: + case 0xEB: + case 0xEC: + case 0xEE: + case 0xEF: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+D000..U+D7FF: bytes ED 80..9F 80..BF + case 0xED: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0x80, 0x9F, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF + case 0xF0: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0x90, 0xBF, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF + case 0xF1: + case 0xF2: + case 0xF3: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0x80, 0xBF, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF + case 0xF4: + { + if (JSON_HEDLEY_UNLIKELY(!(next_byte_in_range({0x80, 0x8F, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // remaining bytes (80..C1 and F5..FF) are ill-formed + default: + { + error_message = "invalid string: ill-formed UTF-8 byte"; + return token_type::parse_error; + } + } + } + } + + /*! + * @brief scan a comment + * @return whether comment could be scanned successfully + */ + bool scan_comment() + { + switch (get()) + { + // single-line comments skip input until a newline or EOF is read + case '/': + { + while (true) + { + switch (get()) + { + case '\n': + case '\r': + case std::char_traits::eof(): + case '\0': + return true; + + default: + break; + } + } + } + + // multi-line comments skip input until */ is read + case '*': + { + while (true) + { + switch (get()) + { + case std::char_traits::eof(): + case '\0': + { + error_message = "invalid comment; missing closing '*/'"; + return false; + } + + case '*': + { + switch (get()) + { + case '/': + return true; + + default: + { + unget(); + continue; + } + } + } + + default: + continue; + } + } + } + + // unexpected character after reading '/' + default: + { + error_message = "invalid comment; expecting '/' or '*' after '/'"; + return false; + } + } + } + + JSON_HEDLEY_NON_NULL(2) + static void strtof(float& f, const char* str, char** endptr) noexcept + { + f = std::strtof(str, endptr); + } + + JSON_HEDLEY_NON_NULL(2) + static void strtof(double& f, const char* str, char** endptr) noexcept + { + f = std::strtod(str, endptr); + } + + JSON_HEDLEY_NON_NULL(2) + static void strtof(long double& f, const char* str, char** endptr) noexcept + { + f = std::strtold(str, endptr); + } + + /*! + @brief scan a number literal + + This function scans a string according to Sect. 6 of RFC 7159. + + The function is realized with a deterministic finite state machine derived + from the grammar described in RFC 7159. Starting in state "init", the + input is read and used to determined the next state. Only state "done" + accepts the number. State "error" is a trap state to model errors. In the + table below, "anything" means any character but the ones listed before. + + state | 0 | 1-9 | e E | + | - | . | anything + ---------|----------|----------|----------|---------|---------|----------|----------- + init | zero | any1 | [error] | [error] | minus | [error] | [error] + minus | zero | any1 | [error] | [error] | [error] | [error] | [error] + zero | done | done | exponent | done | done | decimal1 | done + any1 | any1 | any1 | exponent | done | done | decimal1 | done + decimal1 | decimal2 | decimal2 | [error] | [error] | [error] | [error] | [error] + decimal2 | decimal2 | decimal2 | exponent | done | done | done | done + exponent | any2 | any2 | [error] | sign | sign | [error] | [error] + sign | any2 | any2 | [error] | [error] | [error] | [error] | [error] + any2 | any2 | any2 | done | done | done | done | done + + The state machine is realized with one label per state (prefixed with + "scan_number_") and `goto` statements between them. The state machine + contains cycles, but any cycle can be left when EOF is read. Therefore, + the function is guaranteed to terminate. + + During scanning, the read bytes are stored in token_buffer. This string is + then converted to a signed integer, an unsigned integer, or a + floating-point number. + + @return token_type::value_unsigned, token_type::value_integer, or + token_type::value_float if number could be successfully scanned, + token_type::parse_error otherwise + + @note The scanner is independent of the current locale. Internally, the + locale's decimal point is used instead of `.` to work with the + locale-dependent converters. + */ + token_type scan_number() // lgtm [cpp/use-of-goto] + { + // reset token_buffer to store the number's bytes + reset(); + + // the type of the parsed number; initially set to unsigned; will be + // changed if minus sign, decimal point or exponent is read + token_type number_type = token_type::value_unsigned; + + // state (init): we just found out we need to scan a number + switch (current) + { + case '-': + { + add(current); + goto scan_number_minus; + } + + case '0': + { + add(current); + goto scan_number_zero; + } + + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + // all other characters are rejected outside scan_number() + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + +scan_number_minus: + // state: we just parsed a leading minus sign + number_type = token_type::value_integer; + switch (get()) + { + case '0': + { + add(current); + goto scan_number_zero; + } + + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + default: + { + error_message = "invalid number; expected digit after '-'"; + return token_type::parse_error; + } + } + +scan_number_zero: + // state: we just parse a zero (maybe with a leading minus sign) + switch (get()) + { + case '.': + { + add(decimal_point_char); + goto scan_number_decimal1; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_any1: + // state: we just parsed a number 0-9 (maybe with a leading minus sign) + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + case '.': + { + add(decimal_point_char); + goto scan_number_decimal1; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_decimal1: + // state: we just parsed a decimal point + number_type = token_type::value_float; + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_decimal2; + } + + default: + { + error_message = "invalid number; expected digit after '.'"; + return token_type::parse_error; + } + } + +scan_number_decimal2: + // we just parsed at least one number after a decimal point + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_decimal2; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_exponent: + // we just parsed an exponent + number_type = token_type::value_float; + switch (get()) + { + case '+': + case '-': + { + add(current); + goto scan_number_sign; + } + + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + { + error_message = + "invalid number; expected '+', '-', or digit after exponent"; + return token_type::parse_error; + } + } + +scan_number_sign: + // we just parsed an exponent sign + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + { + error_message = "invalid number; expected digit after exponent sign"; + return token_type::parse_error; + } + } + +scan_number_any2: + // we just parsed a number after the exponent or exponent sign + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + goto scan_number_done; + } + +scan_number_done: + // unget the character after the number (we only read it to know that + // we are done scanning a number) + unget(); + + char* endptr = nullptr; + errno = 0; + + // try to parse integers first and fall back to floats + if (number_type == token_type::value_unsigned) + { + const auto x = std::strtoull(token_buffer.data(), &endptr, 10); + + // we checked the number format before + JSON_ASSERT(endptr == token_buffer.data() + token_buffer.size()); + + if (errno == 0) + { + value_unsigned = static_cast(x); + if (value_unsigned == x) + { + return token_type::value_unsigned; + } + } + } + else if (number_type == token_type::value_integer) + { + const auto x = std::strtoll(token_buffer.data(), &endptr, 10); + + // we checked the number format before + JSON_ASSERT(endptr == token_buffer.data() + token_buffer.size()); + + if (errno == 0) + { + value_integer = static_cast(x); + if (value_integer == x) + { + return token_type::value_integer; + } + } + } + + // this code is reached if we parse a floating-point number or if an + // integer conversion above failed + strtof(value_float, token_buffer.data(), &endptr); + + // we checked the number format before + JSON_ASSERT(endptr == token_buffer.data() + token_buffer.size()); + + return token_type::value_float; + } + + /*! + @param[in] literal_text the literal text to expect + @param[in] length the length of the passed literal text + @param[in] return_type the token type to return on success + */ + JSON_HEDLEY_NON_NULL(2) + token_type scan_literal(const char_type* literal_text, const std::size_t length, + token_type return_type) + { + JSON_ASSERT(std::char_traits::to_char_type(current) == literal_text[0]); + for (std::size_t i = 1; i < length; ++i) + { + if (JSON_HEDLEY_UNLIKELY(std::char_traits::to_char_type(get()) != literal_text[i])) + { + error_message = "invalid literal"; + return token_type::parse_error; + } + } + return return_type; + } + + ///////////////////// + // input management + ///////////////////// + + /// reset token_buffer; current character is beginning of token + void reset() noexcept + { + token_buffer.clear(); + token_string.clear(); + token_string.push_back(std::char_traits::to_char_type(current)); + } + + /* + @brief get next character from the input + + This function provides the interface to the used input adapter. It does + not throw in case the input reached EOF, but returns a + `std::char_traits::eof()` in that case. Stores the scanned characters + for use in error messages. + + @return character read from the input + */ + char_int_type get() + { + ++position.chars_read_total; + ++position.chars_read_current_line; + + if (next_unget) + { + // just reset the next_unget variable and work with current + next_unget = false; + } + else + { + current = ia.get_character(); + } + + if (JSON_HEDLEY_LIKELY(current != std::char_traits::eof())) + { + token_string.push_back(std::char_traits::to_char_type(current)); + } + + if (current == '\n') + { + ++position.lines_read; + position.chars_read_current_line = 0; + } + + return current; + } + + /*! + @brief unget current character (read it again on next get) + + We implement unget by setting variable next_unget to true. The input is not + changed - we just simulate ungetting by modifying chars_read_total, + chars_read_current_line, and token_string. The next call to get() will + behave as if the unget character is read again. + */ + void unget() + { + next_unget = true; + + --position.chars_read_total; + + // in case we "unget" a newline, we have to also decrement the lines_read + if (position.chars_read_current_line == 0) + { + if (position.lines_read > 0) + { + --position.lines_read; + } + } + else + { + --position.chars_read_current_line; + } + + if (JSON_HEDLEY_LIKELY(current != std::char_traits::eof())) + { + JSON_ASSERT(!token_string.empty()); + token_string.pop_back(); + } + } + + /// add a character to token_buffer + void add(char_int_type c) + { + token_buffer.push_back(static_cast(c)); + } + + public: + ///////////////////// + // value getters + ///////////////////// + + /// return integer value + constexpr number_integer_t get_number_integer() const noexcept + { + return value_integer; + } + + /// return unsigned integer value + constexpr number_unsigned_t get_number_unsigned() const noexcept + { + return value_unsigned; + } + + /// return floating-point value + constexpr number_float_t get_number_float() const noexcept + { + return value_float; + } + + /// return current string value (implicitly resets the token; useful only once) + string_t& get_string() + { + return token_buffer; + } + + ///////////////////// + // diagnostics + ///////////////////// + + /// return position of last read token + constexpr position_t get_position() const noexcept + { + return position; + } + + /// return the last read token (for errors only). Will never contain EOF + /// (an arbitrary value that is not a valid char value, often -1), because + /// 255 may legitimately occur. May contain NUL, which should be escaped. + std::string get_token_string() const + { + // escape control characters + std::string result; + for (const auto c : token_string) + { + if (static_cast(c) <= '\x1F') + { + // escape control characters + std::array cs{{}}; + (std::snprintf)(cs.data(), cs.size(), "", static_cast(c)); + result += cs.data(); + } + else + { + // add character as is + result.push_back(static_cast(c)); + } + } + + return result; + } + + /// return syntax error message + JSON_HEDLEY_RETURNS_NON_NULL + constexpr const char* get_error_message() const noexcept + { + return error_message; + } + + ///////////////////// + // actual scanner + ///////////////////// + + /*! + @brief skip the UTF-8 byte order mark + @return true iff there is no BOM or the correct BOM has been skipped + */ + bool skip_bom() + { + if (get() == 0xEF) + { + // check if we completely parse the BOM + return get() == 0xBB && get() == 0xBF; + } + + // the first character is not the beginning of the BOM; unget it to + // process is later + unget(); + return true; + } + + void skip_whitespace() + { + do + { + get(); + } + while (current == ' ' || current == '\t' || current == '\n' || current == '\r'); + } + + token_type scan() + { + // initially, skip the BOM + if (position.chars_read_total == 0 && !skip_bom()) + { + error_message = "invalid BOM; must be 0xEF 0xBB 0xBF if given"; + return token_type::parse_error; + } + + // read next character and ignore whitespace + skip_whitespace(); + + // ignore comments + while (ignore_comments && current == '/') + { + if (!scan_comment()) + { + return token_type::parse_error; + } + + // skip following whitespace + skip_whitespace(); + } + + switch (current) + { + // structural characters + case '[': + return token_type::begin_array; + case ']': + return token_type::end_array; + case '{': + return token_type::begin_object; + case '}': + return token_type::end_object; + case ':': + return token_type::name_separator; + case ',': + return token_type::value_separator; + + // literals + case 't': + { + std::array true_literal = {{'t', 'r', 'u', 'e'}}; + return scan_literal(true_literal.data(), true_literal.size(), token_type::literal_true); + } + case 'f': + { + std::array false_literal = {{'f', 'a', 'l', 's', 'e'}}; + return scan_literal(false_literal.data(), false_literal.size(), token_type::literal_false); + } + case 'n': + { + std::array null_literal = {{'n', 'u', 'l', 'l'}}; + return scan_literal(null_literal.data(), null_literal.size(), token_type::literal_null); + } + + // string + case '\"': + return scan_string(); + + // number + case '-': + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + return scan_number(); + + // end of input (the null byte is needed when parsing from + // string literals) + case '\0': + case std::char_traits::eof(): + return token_type::end_of_input; + + // error + default: + error_message = "invalid literal"; + return token_type::parse_error; + } + } + + private: + /// input adapter + InputAdapterType ia; + + /// whether comments should be ignored (true) or signaled as errors (false) + const bool ignore_comments = false; + + /// the current character + char_int_type current = std::char_traits::eof(); + + /// whether the next get() call should just return current + bool next_unget = false; + + /// the start position of the current token + position_t position {}; + + /// raw input token string (for error messages) + std::vector token_string {}; + + /// buffer for variable-length tokens (numbers, strings) + string_t token_buffer {}; + + /// a description of occurred lexer errors + const char* error_message = ""; + + // number values + number_integer_t value_integer = 0; + number_unsigned_t value_unsigned = 0; + number_float_t value_float = 0; + + /// the decimal point + const char_int_type decimal_point_char = '.'; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + + +#include // size_t +#include // declval +#include // string + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +template +using null_function_t = decltype(std::declval().null()); + +template +using boolean_function_t = + decltype(std::declval().boolean(std::declval())); + +template +using number_integer_function_t = + decltype(std::declval().number_integer(std::declval())); + +template +using number_unsigned_function_t = + decltype(std::declval().number_unsigned(std::declval())); + +template +using number_float_function_t = decltype(std::declval().number_float( + std::declval(), std::declval())); + +template +using string_function_t = + decltype(std::declval().string(std::declval())); + +template +using binary_function_t = + decltype(std::declval().binary(std::declval())); + +template +using start_object_function_t = + decltype(std::declval().start_object(std::declval())); + +template +using key_function_t = + decltype(std::declval().key(std::declval())); + +template +using end_object_function_t = decltype(std::declval().end_object()); + +template +using start_array_function_t = + decltype(std::declval().start_array(std::declval())); + +template +using end_array_function_t = decltype(std::declval().end_array()); + +template +using parse_error_function_t = decltype(std::declval().parse_error( + std::declval(), std::declval(), + std::declval())); + +template +struct is_sax +{ + private: + static_assert(is_basic_json::value, + "BasicJsonType must be of type basic_json<...>"); + + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + using exception_t = typename BasicJsonType::exception; + + public: + static constexpr bool value = + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value && + is_detected_exact::value; +}; + +template +struct is_sax_static_asserts +{ + private: + static_assert(is_basic_json::value, + "BasicJsonType must be of type basic_json<...>"); + + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + using exception_t = typename BasicJsonType::exception; + + public: + static_assert(is_detected_exact::value, + "Missing/invalid function: bool null()"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool boolean(bool)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool boolean(bool)"); + static_assert( + is_detected_exact::value, + "Missing/invalid function: bool number_integer(number_integer_t)"); + static_assert( + is_detected_exact::value, + "Missing/invalid function: bool number_unsigned(number_unsigned_t)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool number_float(number_float_t, const string_t&)"); + static_assert( + is_detected_exact::value, + "Missing/invalid function: bool string(string_t&)"); + static_assert( + is_detected_exact::value, + "Missing/invalid function: bool binary(binary_t&)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool start_object(std::size_t)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool key(string_t&)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool end_object()"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool start_array(std::size_t)"); + static_assert(is_detected_exact::value, + "Missing/invalid function: bool end_array()"); + static_assert( + is_detected_exact::value, + "Missing/invalid function: bool parse_error(std::size_t, const " + "std::string&, const exception&)"); +}; +} // namespace detail +} // namespace nlohmann + +// #include + + +namespace nlohmann +{ +namespace detail +{ + +/// how to treat CBOR tags +enum class cbor_tag_handler_t +{ + error, ///< throw a parse_error exception in case of a tag + ignore ///< ignore tags +}; + +/*! +@brief determine system byte order + +@return true if and only if system's byte order is little endian + +@note from https://stackoverflow.com/a/1001328/266378 +*/ +static inline bool little_endianess(int num = 1) noexcept +{ + return *reinterpret_cast(&num) == 1; +} + + +/////////////////// +// binary reader // +/////////////////// + +/*! +@brief deserialization of CBOR, MessagePack, and UBJSON values +*/ +template> +class binary_reader +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + using json_sax_t = SAX; + using char_type = typename InputAdapterType::char_type; + using char_int_type = typename std::char_traits::int_type; + + public: + /*! + @brief create a binary reader + + @param[in] adapter input adapter to read from + */ + explicit binary_reader(InputAdapterType&& adapter) : ia(std::move(adapter)) + { + (void)detail::is_sax_static_asserts {}; + } + + // make class move-only + binary_reader(const binary_reader&) = delete; + binary_reader(binary_reader&&) = default; + binary_reader& operator=(const binary_reader&) = delete; + binary_reader& operator=(binary_reader&&) = default; + ~binary_reader() = default; + + /*! + @param[in] format the binary format to parse + @param[in] sax_ a SAX event processor + @param[in] strict whether to expect the input to be consumed completed + @param[in] tag_handler how to treat CBOR tags + + @return + */ + JSON_HEDLEY_NON_NULL(3) + bool sax_parse(const input_format_t format, + json_sax_t* sax_, + const bool strict = true, + const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error) + { + sax = sax_; + bool result = false; + + switch (format) + { + case input_format_t::bson: + result = parse_bson_internal(); + break; + + case input_format_t::cbor: + result = parse_cbor_internal(true, tag_handler); + break; + + case input_format_t::msgpack: + result = parse_msgpack_internal(); + break; + + case input_format_t::ubjson: + result = parse_ubjson_internal(); + break; + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + + // strict mode: next byte must be EOF + if (result && strict) + { + if (format == input_format_t::ubjson) + { + get_ignore_noop(); + } + else + { + get(); + } + + if (JSON_HEDLEY_UNLIKELY(current != std::char_traits::eof())) + { + return sax->parse_error(chars_read, get_token_string(), + parse_error::create(110, chars_read, exception_message(format, "expected end of input; last byte: 0x" + get_token_string(), "value"))); + } + } + + return result; + } + + private: + ////////// + // BSON // + ////////// + + /*! + @brief Reads in a BSON-object and passes it to the SAX-parser. + @return whether a valid BSON-value was passed to the SAX parser + */ + bool parse_bson_internal() + { + std::int32_t document_size{}; + get_number(input_format_t::bson, document_size); + + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1)))) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_bson_element_list(/*is_array*/false))) + { + return false; + } + + return sax->end_object(); + } + + /*! + @brief Parses a C-style string from the BSON input. + @param[in, out] result A reference to the string variable where the read + string is to be stored. + @return `true` if the \x00-byte indicating the end of the string was + encountered before the EOF; false` indicates an unexpected EOF. + */ + bool get_bson_cstr(string_t& result) + { + auto out = std::back_inserter(result); + while (true) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::bson, "cstring"))) + { + return false; + } + if (current == 0x00) + { + return true; + } + *out++ = static_cast(current); + } + } + + /*! + @brief Parses a zero-terminated string of length @a len from the BSON + input. + @param[in] len The length (including the zero-byte at the end) of the + string to be read. + @param[in, out] result A reference to the string variable where the read + string is to be stored. + @tparam NumberType The type of the length @a len + @pre len >= 1 + @return `true` if the string was successfully parsed + */ + template + bool get_bson_string(const NumberType len, string_t& result) + { + if (JSON_HEDLEY_UNLIKELY(len < 1)) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::bson, "string length must be at least 1, is " + std::to_string(len), "string"))); + } + + return get_string(input_format_t::bson, len - static_cast(1), result) && get() != std::char_traits::eof(); + } + + /*! + @brief Parses a byte array input of length @a len from the BSON input. + @param[in] len The length of the byte array to be read. + @param[in, out] result A reference to the binary variable where the read + array is to be stored. + @tparam NumberType The type of the length @a len + @pre len >= 0 + @return `true` if the byte array was successfully parsed + */ + template + bool get_bson_binary(const NumberType len, binary_t& result) + { + if (JSON_HEDLEY_UNLIKELY(len < 0)) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::bson, "byte array length cannot be negative, is " + std::to_string(len), "binary"))); + } + + // All BSON binary values have a subtype + std::uint8_t subtype{}; + get_number(input_format_t::bson, subtype); + result.set_subtype(subtype); + + return get_binary(input_format_t::bson, len, result); + } + + /*! + @brief Read a BSON document element of the given @a element_type. + @param[in] element_type The BSON element type, c.f. http://bsonspec.org/spec.html + @param[in] element_type_parse_position The position in the input stream, + where the `element_type` was read. + @warning Not all BSON element types are supported yet. An unsupported + @a element_type will give rise to a parse_error.114: + Unsupported BSON record type 0x... + @return whether a valid BSON-object/array was passed to the SAX parser + */ + bool parse_bson_element_internal(const char_int_type element_type, + const std::size_t element_type_parse_position) + { + switch (element_type) + { + case 0x01: // double + { + double number{}; + return get_number(input_format_t::bson, number) && sax->number_float(static_cast(number), ""); + } + + case 0x02: // string + { + std::int32_t len{}; + string_t value; + return get_number(input_format_t::bson, len) && get_bson_string(len, value) && sax->string(value); + } + + case 0x03: // object + { + return parse_bson_internal(); + } + + case 0x04: // array + { + return parse_bson_array(); + } + + case 0x05: // binary + { + std::int32_t len{}; + binary_t value; + return get_number(input_format_t::bson, len) && get_bson_binary(len, value) && sax->binary(value); + } + + case 0x08: // boolean + { + return sax->boolean(get() != 0); + } + + case 0x0A: // null + { + return sax->null(); + } + + case 0x10: // int32 + { + std::int32_t value{}; + return get_number(input_format_t::bson, value) && sax->number_integer(value); + } + + case 0x12: // int64 + { + std::int64_t value{}; + return get_number(input_format_t::bson, value) && sax->number_integer(value); + } + + default: // anything else not supported (yet) + { + std::array cr{{}}; + (std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast(element_type)); + return sax->parse_error(element_type_parse_position, std::string(cr.data()), parse_error::create(114, element_type_parse_position, "Unsupported BSON record type 0x" + std::string(cr.data()))); + } + } + } + + /*! + @brief Read a BSON element list (as specified in the BSON-spec) + + The same binary layout is used for objects and arrays, hence it must be + indicated with the argument @a is_array which one is expected + (true --> array, false --> object). + + @param[in] is_array Determines if the element list being read is to be + treated as an object (@a is_array == false), or as an + array (@a is_array == true). + @return whether a valid BSON-object/array was passed to the SAX parser + */ + bool parse_bson_element_list(const bool is_array) + { + string_t key; + + while (auto element_type = get()) + { + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::bson, "element list"))) + { + return false; + } + + const std::size_t element_type_parse_position = chars_read; + if (JSON_HEDLEY_UNLIKELY(!get_bson_cstr(key))) + { + return false; + } + + if (!is_array && !sax->key(key)) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_bson_element_internal(element_type, element_type_parse_position))) + { + return false; + } + + // get_bson_cstr only appends + key.clear(); + } + + return true; + } + + /*! + @brief Reads an array from the BSON input and passes it to the SAX-parser. + @return whether a valid BSON-array was passed to the SAX parser + */ + bool parse_bson_array() + { + std::int32_t document_size{}; + get_number(input_format_t::bson, document_size); + + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1)))) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_bson_element_list(/*is_array*/true))) + { + return false; + } + + return sax->end_array(); + } + + ////////// + // CBOR // + ////////// + + /*! + @param[in] get_char whether a new character should be retrieved from the + input (true) or whether the last read character should + be considered instead (false) + @param[in] tag_handler how CBOR tags should be treated + + @return whether a valid CBOR value was passed to the SAX parser + */ + bool parse_cbor_internal(const bool get_char, + const cbor_tag_handler_t tag_handler) + { + switch (get_char ? get() : current) + { + // EOF + case std::char_traits::eof(): + return unexpect_eof(input_format_t::cbor, "value"); + + // Integer 0x00..0x17 (0..23) + case 0x00: + case 0x01: + case 0x02: + case 0x03: + case 0x04: + case 0x05: + case 0x06: + case 0x07: + case 0x08: + case 0x09: + case 0x0A: + case 0x0B: + case 0x0C: + case 0x0D: + case 0x0E: + case 0x0F: + case 0x10: + case 0x11: + case 0x12: + case 0x13: + case 0x14: + case 0x15: + case 0x16: + case 0x17: + return sax->number_unsigned(static_cast(current)); + + case 0x18: // Unsigned integer (one-byte uint8_t follows) + { + std::uint8_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_unsigned(number); + } + + case 0x19: // Unsigned integer (two-byte uint16_t follows) + { + std::uint16_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_unsigned(number); + } + + case 0x1A: // Unsigned integer (four-byte uint32_t follows) + { + std::uint32_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_unsigned(number); + } + + case 0x1B: // Unsigned integer (eight-byte uint64_t follows) + { + std::uint64_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_unsigned(number); + } + + // Negative integer -1-0x00..-1-0x17 (-1..-24) + case 0x20: + case 0x21: + case 0x22: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + return sax->number_integer(static_cast(0x20 - 1 - current)); + + case 0x38: // Negative integer (one-byte uint8_t follows) + { + std::uint8_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_integer(static_cast(-1) - number); + } + + case 0x39: // Negative integer -1-n (two-byte uint16_t follows) + { + std::uint16_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_integer(static_cast(-1) - number); + } + + case 0x3A: // Negative integer -1-n (four-byte uint32_t follows) + { + std::uint32_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_integer(static_cast(-1) - number); + } + + case 0x3B: // Negative integer -1-n (eight-byte uint64_t follows) + { + std::uint64_t number{}; + return get_number(input_format_t::cbor, number) && sax->number_integer(static_cast(-1) + - static_cast(number)); + } + + // Binary data (0x00..0x17 bytes follow) + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + case 0x58: // Binary data (one-byte uint8_t for n follows) + case 0x59: // Binary data (two-byte uint16_t for n follow) + case 0x5A: // Binary data (four-byte uint32_t for n follow) + case 0x5B: // Binary data (eight-byte uint64_t for n follow) + case 0x5F: // Binary data (indefinite length) + { + binary_t b; + return get_cbor_binary(b) && sax->binary(b); + } + + // UTF-8 string (0x00..0x17 bytes follow) + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: // UTF-8 string (one-byte uint8_t for n follows) + case 0x79: // UTF-8 string (two-byte uint16_t for n follow) + case 0x7A: // UTF-8 string (four-byte uint32_t for n follow) + case 0x7B: // UTF-8 string (eight-byte uint64_t for n follow) + case 0x7F: // UTF-8 string (indefinite length) + { + string_t s; + return get_cbor_string(s) && sax->string(s); + } + + // array (0x00..0x17 data items follow) + case 0x80: + case 0x81: + case 0x82: + case 0x83: + case 0x84: + case 0x85: + case 0x86: + case 0x87: + case 0x88: + case 0x89: + case 0x8A: + case 0x8B: + case 0x8C: + case 0x8D: + case 0x8E: + case 0x8F: + case 0x90: + case 0x91: + case 0x92: + case 0x93: + case 0x94: + case 0x95: + case 0x96: + case 0x97: + return get_cbor_array(static_cast(static_cast(current) & 0x1Fu), tag_handler); + + case 0x98: // array (one-byte uint8_t for n follows) + { + std::uint8_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_array(static_cast(len), tag_handler); + } + + case 0x99: // array (two-byte uint16_t for n follow) + { + std::uint16_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_array(static_cast(len), tag_handler); + } + + case 0x9A: // array (four-byte uint32_t for n follow) + { + std::uint32_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_array(static_cast(len), tag_handler); + } + + case 0x9B: // array (eight-byte uint64_t for n follow) + { + std::uint64_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_array(static_cast(len), tag_handler); + } + + case 0x9F: // array (indefinite length) + return get_cbor_array(std::size_t(-1), tag_handler); + + // map (0x00..0x17 pairs of data items follow) + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + return get_cbor_object(static_cast(static_cast(current) & 0x1Fu), tag_handler); + + case 0xB8: // map (one-byte uint8_t for n follows) + { + std::uint8_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_object(static_cast(len), tag_handler); + } + + case 0xB9: // map (two-byte uint16_t for n follow) + { + std::uint16_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_object(static_cast(len), tag_handler); + } + + case 0xBA: // map (four-byte uint32_t for n follow) + { + std::uint32_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_object(static_cast(len), tag_handler); + } + + case 0xBB: // map (eight-byte uint64_t for n follow) + { + std::uint64_t len{}; + return get_number(input_format_t::cbor, len) && get_cbor_object(static_cast(len), tag_handler); + } + + case 0xBF: // map (indefinite length) + return get_cbor_object(std::size_t(-1), tag_handler); + + case 0xC6: // tagged item + case 0xC7: + case 0xC8: + case 0xC9: + case 0xCA: + case 0xCB: + case 0xCC: + case 0xCD: + case 0xCE: + case 0xCF: + case 0xD0: + case 0xD1: + case 0xD2: + case 0xD3: + case 0xD4: + case 0xD8: // tagged item (1 bytes follow) + case 0xD9: // tagged item (2 bytes follow) + case 0xDA: // tagged item (4 bytes follow) + case 0xDB: // tagged item (8 bytes follow) + { + switch (tag_handler) + { + case cbor_tag_handler_t::error: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::cbor, "invalid byte: 0x" + last_token, "value"))); + } + + case cbor_tag_handler_t::ignore: + { + switch (current) + { + case 0xD8: + { + std::uint8_t len{}; + get_number(input_format_t::cbor, len); + break; + } + case 0xD9: + { + std::uint16_t len{}; + get_number(input_format_t::cbor, len); + break; + } + case 0xDA: + { + std::uint32_t len{}; + get_number(input_format_t::cbor, len); + break; + } + case 0xDB: + { + std::uint64_t len{}; + get_number(input_format_t::cbor, len); + break; + } + default: + break; + } + return parse_cbor_internal(true, tag_handler); + } + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + } + + case 0xF4: // false + return sax->boolean(false); + + case 0xF5: // true + return sax->boolean(true); + + case 0xF6: // null + return sax->null(); + + case 0xF9: // Half-Precision Float (two-byte IEEE 754) + { + const auto byte1_raw = get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::cbor, "number"))) + { + return false; + } + const auto byte2_raw = get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::cbor, "number"))) + { + return false; + } + + const auto byte1 = static_cast(byte1_raw); + const auto byte2 = static_cast(byte2_raw); + + // code from RFC 7049, Appendix D, Figure 3: + // As half-precision floating-point numbers were only added + // to IEEE 754 in 2008, today's programming platforms often + // still only have limited support for them. It is very + // easy to include at least decoding support for them even + // without such support. An example of a small decoder for + // half-precision floating-point numbers in the C language + // is shown in Fig. 3. + const auto half = static_cast((byte1 << 8u) + byte2); + const double val = [&half] + { + const int exp = (half >> 10u) & 0x1Fu; + const unsigned int mant = half & 0x3FFu; + JSON_ASSERT(0 <= exp&& exp <= 32); + JSON_ASSERT(mant <= 1024); + switch (exp) + { + case 0: + return std::ldexp(mant, -24); + case 31: + return (mant == 0) + ? std::numeric_limits::infinity() + : std::numeric_limits::quiet_NaN(); + default: + return std::ldexp(mant + 1024, exp - 25); + } + }(); + return sax->number_float((half & 0x8000u) != 0 + ? static_cast(-val) + : static_cast(val), ""); + } + + case 0xFA: // Single-Precision Float (four-byte IEEE 754) + { + float number{}; + return get_number(input_format_t::cbor, number) && sax->number_float(static_cast(number), ""); + } + + case 0xFB: // Double-Precision Float (eight-byte IEEE 754) + { + double number{}; + return get_number(input_format_t::cbor, number) && sax->number_float(static_cast(number), ""); + } + + default: // anything else (0xFF is handled inside the other types) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::cbor, "invalid byte: 0x" + last_token, "value"))); + } + } + } + + /*! + @brief reads a CBOR string + + This function first reads starting bytes to determine the expected + string length and then copies this number of bytes into a string. + Additionally, CBOR's strings with indefinite lengths are supported. + + @param[out] result created string + + @return whether string creation completed + */ + bool get_cbor_string(string_t& result) + { + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::cbor, "string"))) + { + return false; + } + + switch (current) + { + // UTF-8 string (0x00..0x17 bytes follow) + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + { + return get_string(input_format_t::cbor, static_cast(current) & 0x1Fu, result); + } + + case 0x78: // UTF-8 string (one-byte uint8_t for n follows) + { + std::uint8_t len{}; + return get_number(input_format_t::cbor, len) && get_string(input_format_t::cbor, len, result); + } + + case 0x79: // UTF-8 string (two-byte uint16_t for n follow) + { + std::uint16_t len{}; + return get_number(input_format_t::cbor, len) && get_string(input_format_t::cbor, len, result); + } + + case 0x7A: // UTF-8 string (four-byte uint32_t for n follow) + { + std::uint32_t len{}; + return get_number(input_format_t::cbor, len) && get_string(input_format_t::cbor, len, result); + } + + case 0x7B: // UTF-8 string (eight-byte uint64_t for n follow) + { + std::uint64_t len{}; + return get_number(input_format_t::cbor, len) && get_string(input_format_t::cbor, len, result); + } + + case 0x7F: // UTF-8 string (indefinite length) + { + while (get() != 0xFF) + { + string_t chunk; + if (!get_cbor_string(chunk)) + { + return false; + } + result.append(chunk); + } + return true; + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::cbor, "expected length specification (0x60-0x7B) or indefinite string type (0x7F); last byte: 0x" + last_token, "string"))); + } + } + } + + /*! + @brief reads a CBOR byte array + + This function first reads starting bytes to determine the expected + byte array length and then copies this number of bytes into the byte array. + Additionally, CBOR's byte arrays with indefinite lengths are supported. + + @param[out] result created byte array + + @return whether byte array creation completed + */ + bool get_cbor_binary(binary_t& result) + { + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::cbor, "binary"))) + { + return false; + } + + switch (current) + { + // Binary data (0x00..0x17 bytes follow) + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + { + return get_binary(input_format_t::cbor, static_cast(current) & 0x1Fu, result); + } + + case 0x58: // Binary data (one-byte uint8_t for n follows) + { + std::uint8_t len{}; + return get_number(input_format_t::cbor, len) && + get_binary(input_format_t::cbor, len, result); + } + + case 0x59: // Binary data (two-byte uint16_t for n follow) + { + std::uint16_t len{}; + return get_number(input_format_t::cbor, len) && + get_binary(input_format_t::cbor, len, result); + } + + case 0x5A: // Binary data (four-byte uint32_t for n follow) + { + std::uint32_t len{}; + return get_number(input_format_t::cbor, len) && + get_binary(input_format_t::cbor, len, result); + } + + case 0x5B: // Binary data (eight-byte uint64_t for n follow) + { + std::uint64_t len{}; + return get_number(input_format_t::cbor, len) && + get_binary(input_format_t::cbor, len, result); + } + + case 0x5F: // Binary data (indefinite length) + { + while (get() != 0xFF) + { + binary_t chunk; + if (!get_cbor_binary(chunk)) + { + return false; + } + result.insert(result.end(), chunk.begin(), chunk.end()); + } + return true; + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::cbor, "expected length specification (0x40-0x5B) or indefinite binary array type (0x5F); last byte: 0x" + last_token, "binary"))); + } + } + } + + /*! + @param[in] len the length of the array or std::size_t(-1) for an + array of indefinite size + @param[in] tag_handler how CBOR tags should be treated + @return whether array creation completed + */ + bool get_cbor_array(const std::size_t len, + const cbor_tag_handler_t tag_handler) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(len))) + { + return false; + } + + if (len != std::size_t(-1)) + { + for (std::size_t i = 0; i < len; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!parse_cbor_internal(true, tag_handler))) + { + return false; + } + } + } + else + { + while (get() != 0xFF) + { + if (JSON_HEDLEY_UNLIKELY(!parse_cbor_internal(false, tag_handler))) + { + return false; + } + } + } + + return sax->end_array(); + } + + /*! + @param[in] len the length of the object or std::size_t(-1) for an + object of indefinite size + @param[in] tag_handler how CBOR tags should be treated + @return whether object creation completed + */ + bool get_cbor_object(const std::size_t len, + const cbor_tag_handler_t tag_handler) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(len))) + { + return false; + } + + string_t key; + if (len != std::size_t(-1)) + { + for (std::size_t i = 0; i < len; ++i) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!get_cbor_string(key) || !sax->key(key))) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_cbor_internal(true, tag_handler))) + { + return false; + } + key.clear(); + } + } + else + { + while (get() != 0xFF) + { + if (JSON_HEDLEY_UNLIKELY(!get_cbor_string(key) || !sax->key(key))) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_cbor_internal(true, tag_handler))) + { + return false; + } + key.clear(); + } + } + + return sax->end_object(); + } + + ///////////// + // MsgPack // + ///////////// + + /*! + @return whether a valid MessagePack value was passed to the SAX parser + */ + bool parse_msgpack_internal() + { + switch (get()) + { + // EOF + case std::char_traits::eof(): + return unexpect_eof(input_format_t::msgpack, "value"); + + // positive fixint + case 0x00: + case 0x01: + case 0x02: + case 0x03: + case 0x04: + case 0x05: + case 0x06: + case 0x07: + case 0x08: + case 0x09: + case 0x0A: + case 0x0B: + case 0x0C: + case 0x0D: + case 0x0E: + case 0x0F: + case 0x10: + case 0x11: + case 0x12: + case 0x13: + case 0x14: + case 0x15: + case 0x16: + case 0x17: + case 0x18: + case 0x19: + case 0x1A: + case 0x1B: + case 0x1C: + case 0x1D: + case 0x1E: + case 0x1F: + case 0x20: + case 0x21: + case 0x22: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + case 0x38: + case 0x39: + case 0x3A: + case 0x3B: + case 0x3C: + case 0x3D: + case 0x3E: + case 0x3F: + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + case 0x58: + case 0x59: + case 0x5A: + case 0x5B: + case 0x5C: + case 0x5D: + case 0x5E: + case 0x5F: + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: + case 0x79: + case 0x7A: + case 0x7B: + case 0x7C: + case 0x7D: + case 0x7E: + case 0x7F: + return sax->number_unsigned(static_cast(current)); + + // fixmap + case 0x80: + case 0x81: + case 0x82: + case 0x83: + case 0x84: + case 0x85: + case 0x86: + case 0x87: + case 0x88: + case 0x89: + case 0x8A: + case 0x8B: + case 0x8C: + case 0x8D: + case 0x8E: + case 0x8F: + return get_msgpack_object(static_cast(static_cast(current) & 0x0Fu)); + + // fixarray + case 0x90: + case 0x91: + case 0x92: + case 0x93: + case 0x94: + case 0x95: + case 0x96: + case 0x97: + case 0x98: + case 0x99: + case 0x9A: + case 0x9B: + case 0x9C: + case 0x9D: + case 0x9E: + case 0x9F: + return get_msgpack_array(static_cast(static_cast(current) & 0x0Fu)); + + // fixstr + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + case 0xB8: + case 0xB9: + case 0xBA: + case 0xBB: + case 0xBC: + case 0xBD: + case 0xBE: + case 0xBF: + case 0xD9: // str 8 + case 0xDA: // str 16 + case 0xDB: // str 32 + { + string_t s; + return get_msgpack_string(s) && sax->string(s); + } + + case 0xC0: // nil + return sax->null(); + + case 0xC2: // false + return sax->boolean(false); + + case 0xC3: // true + return sax->boolean(true); + + case 0xC4: // bin 8 + case 0xC5: // bin 16 + case 0xC6: // bin 32 + case 0xC7: // ext 8 + case 0xC8: // ext 16 + case 0xC9: // ext 32 + case 0xD4: // fixext 1 + case 0xD5: // fixext 2 + case 0xD6: // fixext 4 + case 0xD7: // fixext 8 + case 0xD8: // fixext 16 + { + binary_t b; + return get_msgpack_binary(b) && sax->binary(b); + } + + case 0xCA: // float 32 + { + float number{}; + return get_number(input_format_t::msgpack, number) && sax->number_float(static_cast(number), ""); + } + + case 0xCB: // float 64 + { + double number{}; + return get_number(input_format_t::msgpack, number) && sax->number_float(static_cast(number), ""); + } + + case 0xCC: // uint 8 + { + std::uint8_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_unsigned(number); + } + + case 0xCD: // uint 16 + { + std::uint16_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_unsigned(number); + } + + case 0xCE: // uint 32 + { + std::uint32_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_unsigned(number); + } + + case 0xCF: // uint 64 + { + std::uint64_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_unsigned(number); + } + + case 0xD0: // int 8 + { + std::int8_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_integer(number); + } + + case 0xD1: // int 16 + { + std::int16_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_integer(number); + } + + case 0xD2: // int 32 + { + std::int32_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_integer(number); + } + + case 0xD3: // int 64 + { + std::int64_t number{}; + return get_number(input_format_t::msgpack, number) && sax->number_integer(number); + } + + case 0xDC: // array 16 + { + std::uint16_t len{}; + return get_number(input_format_t::msgpack, len) && get_msgpack_array(static_cast(len)); + } + + case 0xDD: // array 32 + { + std::uint32_t len{}; + return get_number(input_format_t::msgpack, len) && get_msgpack_array(static_cast(len)); + } + + case 0xDE: // map 16 + { + std::uint16_t len{}; + return get_number(input_format_t::msgpack, len) && get_msgpack_object(static_cast(len)); + } + + case 0xDF: // map 32 + { + std::uint32_t len{}; + return get_number(input_format_t::msgpack, len) && get_msgpack_object(static_cast(len)); + } + + // negative fixint + case 0xE0: + case 0xE1: + case 0xE2: + case 0xE3: + case 0xE4: + case 0xE5: + case 0xE6: + case 0xE7: + case 0xE8: + case 0xE9: + case 0xEA: + case 0xEB: + case 0xEC: + case 0xED: + case 0xEE: + case 0xEF: + case 0xF0: + case 0xF1: + case 0xF2: + case 0xF3: + case 0xF4: + case 0xF5: + case 0xF6: + case 0xF7: + case 0xF8: + case 0xF9: + case 0xFA: + case 0xFB: + case 0xFC: + case 0xFD: + case 0xFE: + case 0xFF: + return sax->number_integer(static_cast(current)); + + default: // anything else + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::msgpack, "invalid byte: 0x" + last_token, "value"))); + } + } + } + + /*! + @brief reads a MessagePack string + + This function first reads starting bytes to determine the expected + string length and then copies this number of bytes into a string. + + @param[out] result created string + + @return whether string creation completed + */ + bool get_msgpack_string(string_t& result) + { + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::msgpack, "string"))) + { + return false; + } + + switch (current) + { + // fixstr + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + case 0xB8: + case 0xB9: + case 0xBA: + case 0xBB: + case 0xBC: + case 0xBD: + case 0xBE: + case 0xBF: + { + return get_string(input_format_t::msgpack, static_cast(current) & 0x1Fu, result); + } + + case 0xD9: // str 8 + { + std::uint8_t len{}; + return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result); + } + + case 0xDA: // str 16 + { + std::uint16_t len{}; + return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result); + } + + case 0xDB: // str 32 + { + std::uint32_t len{}; + return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result); + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::msgpack, "expected length specification (0xA0-0xBF, 0xD9-0xDB); last byte: 0x" + last_token, "string"))); + } + } + } + + /*! + @brief reads a MessagePack byte array + + This function first reads starting bytes to determine the expected + byte array length and then copies this number of bytes into a byte array. + + @param[out] result created byte array + + @return whether byte array creation completed + */ + bool get_msgpack_binary(binary_t& result) + { + // helper function to set the subtype + auto assign_and_return_true = [&result](std::int8_t subtype) + { + result.set_subtype(static_cast(subtype)); + return true; + }; + + switch (current) + { + case 0xC4: // bin 8 + { + std::uint8_t len{}; + return get_number(input_format_t::msgpack, len) && + get_binary(input_format_t::msgpack, len, result); + } + + case 0xC5: // bin 16 + { + std::uint16_t len{}; + return get_number(input_format_t::msgpack, len) && + get_binary(input_format_t::msgpack, len, result); + } + + case 0xC6: // bin 32 + { + std::uint32_t len{}; + return get_number(input_format_t::msgpack, len) && + get_binary(input_format_t::msgpack, len, result); + } + + case 0xC7: // ext 8 + { + std::uint8_t len{}; + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, len) && + get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, len, result) && + assign_and_return_true(subtype); + } + + case 0xC8: // ext 16 + { + std::uint16_t len{}; + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, len) && + get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, len, result) && + assign_and_return_true(subtype); + } + + case 0xC9: // ext 32 + { + std::uint32_t len{}; + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, len) && + get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, len, result) && + assign_and_return_true(subtype); + } + + case 0xD4: // fixext 1 + { + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, 1, result) && + assign_and_return_true(subtype); + } + + case 0xD5: // fixext 2 + { + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, 2, result) && + assign_and_return_true(subtype); + } + + case 0xD6: // fixext 4 + { + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, 4, result) && + assign_and_return_true(subtype); + } + + case 0xD7: // fixext 8 + { + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, 8, result) && + assign_and_return_true(subtype); + } + + case 0xD8: // fixext 16 + { + std::int8_t subtype{}; + return get_number(input_format_t::msgpack, subtype) && + get_binary(input_format_t::msgpack, 16, result) && + assign_and_return_true(subtype); + } + + default: // LCOV_EXCL_LINE + return false; // LCOV_EXCL_LINE + } + } + + /*! + @param[in] len the length of the array + @return whether array creation completed + */ + bool get_msgpack_array(const std::size_t len) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(len))) + { + return false; + } + + for (std::size_t i = 0; i < len; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!parse_msgpack_internal())) + { + return false; + } + } + + return sax->end_array(); + } + + /*! + @param[in] len the length of the object + @return whether object creation completed + */ + bool get_msgpack_object(const std::size_t len) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(len))) + { + return false; + } + + string_t key; + for (std::size_t i = 0; i < len; ++i) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!get_msgpack_string(key) || !sax->key(key))) + { + return false; + } + + if (JSON_HEDLEY_UNLIKELY(!parse_msgpack_internal())) + { + return false; + } + key.clear(); + } + + return sax->end_object(); + } + + //////////// + // UBJSON // + //////////// + + /*! + @param[in] get_char whether a new character should be retrieved from the + input (true, default) or whether the last read + character should be considered instead + + @return whether a valid UBJSON value was passed to the SAX parser + */ + bool parse_ubjson_internal(const bool get_char = true) + { + return get_ubjson_value(get_char ? get_ignore_noop() : current); + } + + /*! + @brief reads a UBJSON string + + This function is either called after reading the 'S' byte explicitly + indicating a string, or in case of an object key where the 'S' byte can be + left out. + + @param[out] result created string + @param[in] get_char whether a new character should be retrieved from the + input (true, default) or whether the last read + character should be considered instead + + @return whether string creation completed + */ + bool get_ubjson_string(string_t& result, const bool get_char = true) + { + if (get_char) + { + get(); // TODO(niels): may we ignore N here? + } + + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::ubjson, "value"))) + { + return false; + } + + switch (current) + { + case 'U': + { + std::uint8_t len{}; + return get_number(input_format_t::ubjson, len) && get_string(input_format_t::ubjson, len, result); + } + + case 'i': + { + std::int8_t len{}; + return get_number(input_format_t::ubjson, len) && get_string(input_format_t::ubjson, len, result); + } + + case 'I': + { + std::int16_t len{}; + return get_number(input_format_t::ubjson, len) && get_string(input_format_t::ubjson, len, result); + } + + case 'l': + { + std::int32_t len{}; + return get_number(input_format_t::ubjson, len) && get_string(input_format_t::ubjson, len, result); + } + + case 'L': + { + std::int64_t len{}; + return get_number(input_format_t::ubjson, len) && get_string(input_format_t::ubjson, len, result); + } + + default: + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::ubjson, "expected length type specification (U, i, I, l, L); last byte: 0x" + last_token, "string"))); + } + } + + /*! + @param[out] result determined size + @return whether size determination completed + */ + bool get_ubjson_size_value(std::size_t& result) + { + switch (get_ignore_noop()) + { + case 'U': + { + std::uint8_t number{}; + if (JSON_HEDLEY_UNLIKELY(!get_number(input_format_t::ubjson, number))) + { + return false; + } + result = static_cast(number); + return true; + } + + case 'i': + { + std::int8_t number{}; + if (JSON_HEDLEY_UNLIKELY(!get_number(input_format_t::ubjson, number))) + { + return false; + } + result = static_cast(number); + return true; + } + + case 'I': + { + std::int16_t number{}; + if (JSON_HEDLEY_UNLIKELY(!get_number(input_format_t::ubjson, number))) + { + return false; + } + result = static_cast(number); + return true; + } + + case 'l': + { + std::int32_t number{}; + if (JSON_HEDLEY_UNLIKELY(!get_number(input_format_t::ubjson, number))) + { + return false; + } + result = static_cast(number); + return true; + } + + case 'L': + { + std::int64_t number{}; + if (JSON_HEDLEY_UNLIKELY(!get_number(input_format_t::ubjson, number))) + { + return false; + } + result = static_cast(number); + return true; + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::ubjson, "expected length type specification (U, i, I, l, L) after '#'; last byte: 0x" + last_token, "size"))); + } + } + } + + /*! + @brief determine the type and size for a container + + In the optimized UBJSON format, a type and a size can be provided to allow + for a more compact representation. + + @param[out] result pair of the size and the type + + @return whether pair creation completed + */ + bool get_ubjson_size_type(std::pair& result) + { + result.first = string_t::npos; // size + result.second = 0; // type + + get_ignore_noop(); + + if (current == '$') + { + result.second = get(); // must not ignore 'N', because 'N' maybe the type + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::ubjson, "type"))) + { + return false; + } + + get_ignore_noop(); + if (JSON_HEDLEY_UNLIKELY(current != '#')) + { + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::ubjson, "value"))) + { + return false; + } + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::ubjson, "expected '#' after type information; last byte: 0x" + last_token, "size"))); + } + + return get_ubjson_size_value(result.first); + } + + if (current == '#') + { + return get_ubjson_size_value(result.first); + } + + return true; + } + + /*! + @param prefix the previously read or set type prefix + @return whether value creation completed + */ + bool get_ubjson_value(const char_int_type prefix) + { + switch (prefix) + { + case std::char_traits::eof(): // EOF + return unexpect_eof(input_format_t::ubjson, "value"); + + case 'T': // true + return sax->boolean(true); + case 'F': // false + return sax->boolean(false); + + case 'Z': // null + return sax->null(); + + case 'U': + { + std::uint8_t number{}; + return get_number(input_format_t::ubjson, number) && sax->number_unsigned(number); + } + + case 'i': + { + std::int8_t number{}; + return get_number(input_format_t::ubjson, number) && sax->number_integer(number); + } + + case 'I': + { + std::int16_t number{}; + return get_number(input_format_t::ubjson, number) && sax->number_integer(number); + } + + case 'l': + { + std::int32_t number{}; + return get_number(input_format_t::ubjson, number) && sax->number_integer(number); + } + + case 'L': + { + std::int64_t number{}; + return get_number(input_format_t::ubjson, number) && sax->number_integer(number); + } + + case 'd': + { + float number{}; + return get_number(input_format_t::ubjson, number) && sax->number_float(static_cast(number), ""); + } + + case 'D': + { + double number{}; + return get_number(input_format_t::ubjson, number) && sax->number_float(static_cast(number), ""); + } + + case 'H': + { + return get_ubjson_high_precision_number(); + } + + case 'C': // char + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::ubjson, "char"))) + { + return false; + } + if (JSON_HEDLEY_UNLIKELY(current > 127)) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, exception_message(input_format_t::ubjson, "byte after 'C' must be in range 0x00..0x7F; last byte: 0x" + last_token, "char"))); + } + string_t s(1, static_cast(current)); + return sax->string(s); + } + + case 'S': // string + { + string_t s; + return get_ubjson_string(s) && sax->string(s); + } + + case '[': // array + return get_ubjson_array(); + + case '{': // object + return get_ubjson_object(); + + default: // anything else + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, exception_message(input_format_t::ubjson, "invalid byte: 0x" + last_token, "value"))); + } + } + } + + /*! + @return whether array creation completed + */ + bool get_ubjson_array() + { + std::pair size_and_type; + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type))) + { + return false; + } + + if (size_and_type.first != string_t::npos) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(size_and_type.first))) + { + return false; + } + + if (size_and_type.second != 0) + { + if (size_and_type.second != 'N') + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_value(size_and_type.second))) + { + return false; + } + } + } + } + else + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!parse_ubjson_internal())) + { + return false; + } + } + } + } + else + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1)))) + { + return false; + } + + while (current != ']') + { + if (JSON_HEDLEY_UNLIKELY(!parse_ubjson_internal(false))) + { + return false; + } + get_ignore_noop(); + } + } + + return sax->end_array(); + } + + /*! + @return whether object creation completed + */ + bool get_ubjson_object() + { + std::pair size_and_type; + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type))) + { + return false; + } + + string_t key; + if (size_and_type.first != string_t::npos) + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(size_and_type.first))) + { + return false; + } + + if (size_and_type.second != 0) + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key) || !sax->key(key))) + { + return false; + } + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_value(size_and_type.second))) + { + return false; + } + key.clear(); + } + } + else + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key) || !sax->key(key))) + { + return false; + } + if (JSON_HEDLEY_UNLIKELY(!parse_ubjson_internal())) + { + return false; + } + key.clear(); + } + } + } + else + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1)))) + { + return false; + } + + while (current != '}') + { + if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key, false) || !sax->key(key))) + { + return false; + } + if (JSON_HEDLEY_UNLIKELY(!parse_ubjson_internal())) + { + return false; + } + get_ignore_noop(); + key.clear(); + } + } + + return sax->end_object(); + } + + // Note, no reader for UBJSON binary types is implemented because they do + // not exist + + bool get_ubjson_high_precision_number() + { + // get size of following number string + std::size_t size{}; + auto res = get_ubjson_size_value(size); + if (JSON_HEDLEY_UNLIKELY(!res)) + { + return res; + } + + // get number string + std::vector number_vector; + for (std::size_t i = 0; i < size; ++i) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::ubjson, "number"))) + { + return false; + } + number_vector.push_back(static_cast(current)); + } + + // parse number string + auto number_ia = detail::input_adapter(std::forward(number_vector)); + auto number_lexer = detail::lexer(std::move(number_ia), false); + const auto result_number = number_lexer.scan(); + const auto number_string = number_lexer.get_token_string(); + const auto result_remainder = number_lexer.scan(); + + using token_type = typename detail::lexer_base::token_type; + + if (JSON_HEDLEY_UNLIKELY(result_remainder != token_type::end_of_input)) + { + return sax->parse_error(chars_read, number_string, parse_error::create(115, chars_read, exception_message(input_format_t::ubjson, "invalid number text: " + number_lexer.get_token_string(), "high-precision number"))); + } + + switch (result_number) + { + case token_type::value_integer: + return sax->number_integer(number_lexer.get_number_integer()); + case token_type::value_unsigned: + return sax->number_unsigned(number_lexer.get_number_unsigned()); + case token_type::value_float: + return sax->number_float(number_lexer.get_number_float(), std::move(number_string)); + default: + return sax->parse_error(chars_read, number_string, parse_error::create(115, chars_read, exception_message(input_format_t::ubjson, "invalid number text: " + number_lexer.get_token_string(), "high-precision number"))); + } + } + + /////////////////////// + // Utility functions // + /////////////////////// + + /*! + @brief get next character from the input + + This function provides the interface to the used input adapter. It does + not throw in case the input reached EOF, but returns a -'ve valued + `std::char_traits::eof()` in that case. + + @return character read from the input + */ + char_int_type get() + { + ++chars_read; + return current = ia.get_character(); + } + + /*! + @return character read from the input after ignoring all 'N' entries + */ + char_int_type get_ignore_noop() + { + do + { + get(); + } + while (current == 'N'); + + return current; + } + + /* + @brief read a number from the input + + @tparam NumberType the type of the number + @param[in] format the current format (for diagnostics) + @param[out] result number of type @a NumberType + + @return whether conversion completed + + @note This function needs to respect the system's endianess, because + bytes in CBOR, MessagePack, and UBJSON are stored in network order + (big endian) and therefore need reordering on little endian systems. + */ + template + bool get_number(const input_format_t format, NumberType& result) + { + // step 1: read input into array with system's byte order + std::array vec; + for (std::size_t i = 0; i < sizeof(NumberType); ++i) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(format, "number"))) + { + return false; + } + + // reverse byte order prior to conversion if necessary + if (is_little_endian != InputIsLittleEndian) + { + vec[sizeof(NumberType) - i - 1] = static_cast(current); + } + else + { + vec[i] = static_cast(current); // LCOV_EXCL_LINE + } + } + + // step 2: convert array into number of type T and return + std::memcpy(&result, vec.data(), sizeof(NumberType)); + return true; + } + + /*! + @brief create a string by reading characters from the input + + @tparam NumberType the type of the number + @param[in] format the current format (for diagnostics) + @param[in] len number of characters to read + @param[out] result string created by reading @a len bytes + + @return whether string creation completed + + @note We can not reserve @a len bytes for the result, because @a len + may be too large. Usually, @ref unexpect_eof() detects the end of + the input before we run out of string memory. + */ + template + bool get_string(const input_format_t format, + const NumberType len, + string_t& result) + { + bool success = true; + for (NumberType i = 0; i < len; i++) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(format, "string"))) + { + success = false; + break; + } + result.push_back(static_cast(current)); + }; + return success; + } + + /*! + @brief create a byte array by reading bytes from the input + + @tparam NumberType the type of the number + @param[in] format the current format (for diagnostics) + @param[in] len number of bytes to read + @param[out] result byte array created by reading @a len bytes + + @return whether byte array creation completed + + @note We can not reserve @a len bytes for the result, because @a len + may be too large. Usually, @ref unexpect_eof() detects the end of + the input before we run out of memory. + */ + template + bool get_binary(const input_format_t format, + const NumberType len, + binary_t& result) + { + bool success = true; + for (NumberType i = 0; i < len; i++) + { + get(); + if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(format, "binary"))) + { + success = false; + break; + } + result.push_back(static_cast(current)); + } + return success; + } + + /*! + @param[in] format the current format (for diagnostics) + @param[in] context further context information (for diagnostics) + @return whether the last read character is not EOF + */ + JSON_HEDLEY_NON_NULL(3) + bool unexpect_eof(const input_format_t format, const char* context) const + { + if (JSON_HEDLEY_UNLIKELY(current == std::char_traits::eof())) + { + return sax->parse_error(chars_read, "", + parse_error::create(110, chars_read, exception_message(format, "unexpected end of input", context))); + } + return true; + } + + /*! + @return a string representation of the last read byte + */ + std::string get_token_string() const + { + std::array cr{{}}; + (std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast(current)); + return std::string{cr.data()}; + } + + /*! + @param[in] format the current format + @param[in] detail a detailed error message + @param[in] context further context information + @return a message string to use in the parse_error exceptions + */ + std::string exception_message(const input_format_t format, + const std::string& detail, + const std::string& context) const + { + std::string error_msg = "syntax error while parsing "; + + switch (format) + { + case input_format_t::cbor: + error_msg += "CBOR"; + break; + + case input_format_t::msgpack: + error_msg += "MessagePack"; + break; + + case input_format_t::ubjson: + error_msg += "UBJSON"; + break; + + case input_format_t::bson: + error_msg += "BSON"; + break; + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + + return error_msg + " " + context + ": " + detail; + } + + private: + /// input adapter + InputAdapterType ia; + + /// the current character + char_int_type current = std::char_traits::eof(); + + /// the number of characters read + std::size_t chars_read = 0; + + /// whether we can assume little endianess + const bool is_little_endian = little_endianess(); + + /// the SAX parser + json_sax_t* sax = nullptr; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + +// #include + + +#include // isfinite +#include // uint8_t +#include // function +#include // string +#include // move +#include // vector + +// #include + +// #include + +// #include + +// #include + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +//////////// +// parser // +//////////// + +enum class parse_event_t : uint8_t +{ + /// the parser read `{` and started to process a JSON object + object_start, + /// the parser read `}` and finished processing a JSON object + object_end, + /// the parser read `[` and started to process a JSON array + array_start, + /// the parser read `]` and finished processing a JSON array + array_end, + /// the parser read a key of a value in an object + key, + /// the parser finished reading a JSON value + value +}; + +template +using parser_callback_t = + std::function; + +/*! +@brief syntax analysis + +This class implements a recursive descent parser. +*/ +template +class parser +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using lexer_t = lexer; + using token_type = typename lexer_t::token_type; + + public: + /// a parser reading from an input adapter + explicit parser(InputAdapterType&& adapter, + const parser_callback_t cb = nullptr, + const bool allow_exceptions_ = true, + const bool skip_comments = false) + : callback(cb) + , m_lexer(std::move(adapter), skip_comments) + , allow_exceptions(allow_exceptions_) + { + // read first token + get_token(); + } + + /*! + @brief public parser interface + + @param[in] strict whether to expect the last token to be EOF + @param[in,out] result parsed JSON value + + @throw parse_error.101 in case of an unexpected token + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + */ + void parse(const bool strict, BasicJsonType& result) + { + if (callback) + { + json_sax_dom_callback_parser sdp(result, callback, allow_exceptions); + sax_parse_internal(&sdp); + result.assert_invariant(); + + // in strict mode, input must be completely read + if (strict && (get_token() != token_type::end_of_input)) + { + sdp.parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::end_of_input, "value"))); + } + + // in case of an error, return discarded value + if (sdp.is_errored()) + { + result = value_t::discarded; + return; + } + + // set top-level value to null if it was discarded by the callback + // function + if (result.is_discarded()) + { + result = nullptr; + } + } + else + { + json_sax_dom_parser sdp(result, allow_exceptions); + sax_parse_internal(&sdp); + result.assert_invariant(); + + // in strict mode, input must be completely read + if (strict && (get_token() != token_type::end_of_input)) + { + sdp.parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::end_of_input, "value"))); + } + + // in case of an error, return discarded value + if (sdp.is_errored()) + { + result = value_t::discarded; + return; + } + } + } + + /*! + @brief public accept interface + + @param[in] strict whether to expect the last token to be EOF + @return whether the input is a proper JSON text + */ + bool accept(const bool strict = true) + { + json_sax_acceptor sax_acceptor; + return sax_parse(&sax_acceptor, strict); + } + + template + JSON_HEDLEY_NON_NULL(2) + bool sax_parse(SAX* sax, const bool strict = true) + { + (void)detail::is_sax_static_asserts {}; + const bool result = sax_parse_internal(sax); + + // strict mode: next byte must be EOF + if (result && strict && (get_token() != token_type::end_of_input)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::end_of_input, "value"))); + } + + return result; + } + + private: + template + JSON_HEDLEY_NON_NULL(2) + bool sax_parse_internal(SAX* sax) + { + // stack to remember the hierarchy of structured values we are parsing + // true = array; false = object + std::vector states; + // value to avoid a goto (see comment where set to true) + bool skip_to_state_evaluation = false; + + while (true) + { + if (!skip_to_state_evaluation) + { + // invariant: get_token() was called before each iteration + switch (last_token) + { + case token_type::begin_object: + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1)))) + { + return false; + } + + // closing } -> we are done + if (get_token() == token_type::end_object) + { + if (JSON_HEDLEY_UNLIKELY(!sax->end_object())) + { + return false; + } + break; + } + + // parse key + if (JSON_HEDLEY_UNLIKELY(last_token != token_type::value_string)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::value_string, "object key"))); + } + if (JSON_HEDLEY_UNLIKELY(!sax->key(m_lexer.get_string()))) + { + return false; + } + + // parse separator (:) + if (JSON_HEDLEY_UNLIKELY(get_token() != token_type::name_separator)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::name_separator, "object separator"))); + } + + // remember we are now inside an object + states.push_back(false); + + // parse values + get_token(); + continue; + } + + case token_type::begin_array: + { + if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1)))) + { + return false; + } + + // closing ] -> we are done + if (get_token() == token_type::end_array) + { + if (JSON_HEDLEY_UNLIKELY(!sax->end_array())) + { + return false; + } + break; + } + + // remember we are now inside an array + states.push_back(true); + + // parse values (no need to call get_token) + continue; + } + + case token_type::value_float: + { + const auto res = m_lexer.get_number_float(); + + if (JSON_HEDLEY_UNLIKELY(!std::isfinite(res))) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + out_of_range::create(406, "number overflow parsing '" + m_lexer.get_token_string() + "'")); + } + + if (JSON_HEDLEY_UNLIKELY(!sax->number_float(res, m_lexer.get_string()))) + { + return false; + } + + break; + } + + case token_type::literal_false: + { + if (JSON_HEDLEY_UNLIKELY(!sax->boolean(false))) + { + return false; + } + break; + } + + case token_type::literal_null: + { + if (JSON_HEDLEY_UNLIKELY(!sax->null())) + { + return false; + } + break; + } + + case token_type::literal_true: + { + if (JSON_HEDLEY_UNLIKELY(!sax->boolean(true))) + { + return false; + } + break; + } + + case token_type::value_integer: + { + if (JSON_HEDLEY_UNLIKELY(!sax->number_integer(m_lexer.get_number_integer()))) + { + return false; + } + break; + } + + case token_type::value_string: + { + if (JSON_HEDLEY_UNLIKELY(!sax->string(m_lexer.get_string()))) + { + return false; + } + break; + } + + case token_type::value_unsigned: + { + if (JSON_HEDLEY_UNLIKELY(!sax->number_unsigned(m_lexer.get_number_unsigned()))) + { + return false; + } + break; + } + + case token_type::parse_error: + { + // using "uninitialized" to avoid "expected" message + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::uninitialized, "value"))); + } + + default: // the last token was unexpected + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::literal_or_value, "value"))); + } + } + } + else + { + skip_to_state_evaluation = false; + } + + // we reached this line after we successfully parsed a value + if (states.empty()) + { + // empty stack: we reached the end of the hierarchy: done + return true; + } + + if (states.back()) // array + { + // comma -> next value + if (get_token() == token_type::value_separator) + { + // parse a new value + get_token(); + continue; + } + + // closing ] + if (JSON_HEDLEY_LIKELY(last_token == token_type::end_array)) + { + if (JSON_HEDLEY_UNLIKELY(!sax->end_array())) + { + return false; + } + + // We are done with this array. Before we can parse a + // new value, we need to evaluate the new state first. + // By setting skip_to_state_evaluation to false, we + // are effectively jumping to the beginning of this if. + JSON_ASSERT(!states.empty()); + states.pop_back(); + skip_to_state_evaluation = true; + continue; + } + + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::end_array, "array"))); + } + else // object + { + // comma -> next value + if (get_token() == token_type::value_separator) + { + // parse key + if (JSON_HEDLEY_UNLIKELY(get_token() != token_type::value_string)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::value_string, "object key"))); + } + + if (JSON_HEDLEY_UNLIKELY(!sax->key(m_lexer.get_string()))) + { + return false; + } + + // parse separator (:) + if (JSON_HEDLEY_UNLIKELY(get_token() != token_type::name_separator)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::name_separator, "object separator"))); + } + + // parse values + get_token(); + continue; + } + + // closing } + if (JSON_HEDLEY_LIKELY(last_token == token_type::end_object)) + { + if (JSON_HEDLEY_UNLIKELY(!sax->end_object())) + { + return false; + } + + // We are done with this object. Before we can parse a + // new value, we need to evaluate the new state first. + // By setting skip_to_state_evaluation to false, we + // are effectively jumping to the beginning of this if. + JSON_ASSERT(!states.empty()); + states.pop_back(); + skip_to_state_evaluation = true; + continue; + } + + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), + exception_message(token_type::end_object, "object"))); + } + } + } + + /// get next token from lexer + token_type get_token() + { + return last_token = m_lexer.scan(); + } + + std::string exception_message(const token_type expected, const std::string& context) + { + std::string error_msg = "syntax error "; + + if (!context.empty()) + { + error_msg += "while parsing " + context + " "; + } + + error_msg += "- "; + + if (last_token == token_type::parse_error) + { + error_msg += std::string(m_lexer.get_error_message()) + "; last read: '" + + m_lexer.get_token_string() + "'"; + } + else + { + error_msg += "unexpected " + std::string(lexer_t::token_type_name(last_token)); + } + + if (expected != token_type::uninitialized) + { + error_msg += "; expected " + std::string(lexer_t::token_type_name(expected)); + } + + return error_msg; + } + + private: + /// callback function + const parser_callback_t callback = nullptr; + /// the type of the last read token + token_type last_token = token_type::uninitialized; + /// the lexer + lexer_t m_lexer; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; +}; +} // namespace detail +} // namespace nlohmann + +// #include + + +// #include + + +#include // ptrdiff_t +#include // numeric_limits + +namespace nlohmann +{ +namespace detail +{ +/* +@brief an iterator for primitive JSON types + +This class models an iterator for primitive JSON types (boolean, number, +string). It's only purpose is to allow the iterator/const_iterator classes +to "iterate" over primitive values. Internally, the iterator is modeled by +a `difference_type` variable. Value begin_value (`0`) models the begin, +end_value (`1`) models past the end. +*/ +class primitive_iterator_t +{ + private: + using difference_type = std::ptrdiff_t; + static constexpr difference_type begin_value = 0; + static constexpr difference_type end_value = begin_value + 1; + + /// iterator as signed integer type + difference_type m_it = (std::numeric_limits::min)(); + + public: + constexpr difference_type get_value() const noexcept + { + return m_it; + } + + /// set iterator to a defined beginning + void set_begin() noexcept + { + m_it = begin_value; + } + + /// set iterator to a defined past the end + void set_end() noexcept + { + m_it = end_value; + } + + /// return whether the iterator can be dereferenced + constexpr bool is_begin() const noexcept + { + return m_it == begin_value; + } + + /// return whether the iterator is at end + constexpr bool is_end() const noexcept + { + return m_it == end_value; + } + + friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it == rhs.m_it; + } + + friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it < rhs.m_it; + } + + primitive_iterator_t operator+(difference_type n) noexcept + { + auto result = *this; + result += n; + return result; + } + + friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it - rhs.m_it; + } + + primitive_iterator_t& operator++() noexcept + { + ++m_it; + return *this; + } + + primitive_iterator_t const operator++(int) noexcept + { + auto result = *this; + ++m_it; + return result; + } + + primitive_iterator_t& operator--() noexcept + { + --m_it; + return *this; + } + + primitive_iterator_t const operator--(int) noexcept + { + auto result = *this; + --m_it; + return result; + } + + primitive_iterator_t& operator+=(difference_type n) noexcept + { + m_it += n; + return *this; + } + + primitive_iterator_t& operator-=(difference_type n) noexcept + { + m_it -= n; + return *this; + } +}; +} // namespace detail +} // namespace nlohmann + + +namespace nlohmann +{ +namespace detail +{ +/*! +@brief an iterator value + +@note This structure could easily be a union, but MSVC currently does not allow +unions members with complex constructors, see https://github.com/nlohmann/json/pull/105. +*/ +template struct internal_iterator +{ + /// iterator for JSON objects + typename BasicJsonType::object_t::iterator object_iterator {}; + /// iterator for JSON arrays + typename BasicJsonType::array_t::iterator array_iterator {}; + /// generic iterator for all other types + primitive_iterator_t primitive_iterator {}; +}; +} // namespace detail +} // namespace nlohmann + +// #include + + +#include // iterator, random_access_iterator_tag, bidirectional_iterator_tag, advance, next +#include // conditional, is_const, remove_const + +// #include + +// #include + +// #include + +// #include + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +// forward declare, to be able to friend it later on +template class iteration_proxy; +template class iteration_proxy_value; + +/*! +@brief a template for a bidirectional iterator for the @ref basic_json class +This class implements a both iterators (iterator and const_iterator) for the +@ref basic_json class. +@note An iterator is called *initialized* when a pointer to a JSON value has + been set (e.g., by a constructor or a copy assignment). If the iterator is + default-constructed, it is *uninitialized* and most methods are undefined. + **The library uses assertions to detect calls on uninitialized iterators.** +@requirement The class satisfies the following concept requirements: +- +[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator): + The iterator that can be moved can be moved in both directions (i.e. + incremented and decremented). +@since version 1.0.0, simplified in version 2.0.9, change to bidirectional + iterators in version 3.0.0 (see https://github.com/nlohmann/json/issues/593) +*/ +template +class iter_impl +{ + /// allow basic_json to access private members + friend iter_impl::value, typename std::remove_const::type, const BasicJsonType>::type>; + friend BasicJsonType; + friend iteration_proxy; + friend iteration_proxy_value; + + using object_t = typename BasicJsonType::object_t; + using array_t = typename BasicJsonType::array_t; + // make sure BasicJsonType is basic_json or const basic_json + static_assert(is_basic_json::type>::value, + "iter_impl only accepts (const) basic_json"); + + public: + + /// The std::iterator class template (used as a base class to provide typedefs) is deprecated in C++17. + /// The C++ Standard has never required user-defined iterators to derive from std::iterator. + /// A user-defined iterator should provide publicly accessible typedefs named + /// iterator_category, value_type, difference_type, pointer, and reference. + /// Note that value_type is required to be non-const, even for constant iterators. + using iterator_category = std::bidirectional_iterator_tag; + + /// the type of the values when the iterator is dereferenced + using value_type = typename BasicJsonType::value_type; + /// a type to represent differences between iterators + using difference_type = typename BasicJsonType::difference_type; + /// defines a pointer to the type iterated over (value_type) + using pointer = typename std::conditional::value, + typename BasicJsonType::const_pointer, + typename BasicJsonType::pointer>::type; + /// defines a reference to the type iterated over (value_type) + using reference = + typename std::conditional::value, + typename BasicJsonType::const_reference, + typename BasicJsonType::reference>::type; + + /// default constructor + iter_impl() = default; + + /*! + @brief constructor for a given JSON instance + @param[in] object pointer to a JSON object for this iterator + @pre object != nullptr + @post The iterator is initialized; i.e. `m_object != nullptr`. + */ + explicit iter_impl(pointer object) noexcept : m_object(object) + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = typename object_t::iterator(); + break; + } + + case value_t::array: + { + m_it.array_iterator = typename array_t::iterator(); + break; + } + + default: + { + m_it.primitive_iterator = primitive_iterator_t(); + break; + } + } + } + + /*! + @note The conventional copy constructor and copy assignment are implicitly + defined. Combined with the following converting constructor and + assignment, they support: (1) copy from iterator to iterator, (2) + copy from const iterator to const iterator, and (3) conversion from + iterator to const iterator. However conversion from const iterator + to iterator is not defined. + */ + + /*! + @brief const copy constructor + @param[in] other const iterator to copy from + @note This copy constructor had to be defined explicitly to circumvent a bug + occurring on msvc v19.0 compiler (VS 2015) debug build. For more + information refer to: https://github.com/nlohmann/json/issues/1608 + */ + iter_impl(const iter_impl& other) noexcept + : m_object(other.m_object), m_it(other.m_it) + {} + + /*! + @brief converting assignment + @param[in] other const iterator to copy from + @return const/non-const iterator + @note It is not checked whether @a other is initialized. + */ + iter_impl& operator=(const iter_impl& other) noexcept + { + m_object = other.m_object; + m_it = other.m_it; + return *this; + } + + /*! + @brief converting constructor + @param[in] other non-const iterator to copy from + @note It is not checked whether @a other is initialized. + */ + iter_impl(const iter_impl::type>& other) noexcept + : m_object(other.m_object), m_it(other.m_it) + {} + + /*! + @brief converting assignment + @param[in] other non-const iterator to copy from + @return const/non-const iterator + @note It is not checked whether @a other is initialized. + */ + iter_impl& operator=(const iter_impl::type>& other) noexcept + { + m_object = other.m_object; + m_it = other.m_it; + return *this; + } + + private: + /*! + @brief set the iterator to the first value + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + void set_begin() noexcept + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = m_object->m_value.object->begin(); + break; + } + + case value_t::array: + { + m_it.array_iterator = m_object->m_value.array->begin(); + break; + } + + case value_t::null: + { + // set to end so begin()==end() is true: null is empty + m_it.primitive_iterator.set_end(); + break; + } + + default: + { + m_it.primitive_iterator.set_begin(); + break; + } + } + } + + /*! + @brief set the iterator past the last value + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + void set_end() noexcept + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = m_object->m_value.object->end(); + break; + } + + case value_t::array: + { + m_it.array_iterator = m_object->m_value.array->end(); + break; + } + + default: + { + m_it.primitive_iterator.set_end(); + break; + } + } + } + + public: + /*! + @brief return a reference to the value pointed to by the iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference operator*() const + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + JSON_ASSERT(m_it.object_iterator != m_object->m_value.object->end()); + return m_it.object_iterator->second; + } + + case value_t::array: + { + JSON_ASSERT(m_it.array_iterator != m_object->m_value.array->end()); + return *m_it.array_iterator; + } + + case value_t::null: + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + + default: + { + if (JSON_HEDLEY_LIKELY(m_it.primitive_iterator.is_begin())) + { + return *m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief dereference the iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + pointer operator->() const + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + JSON_ASSERT(m_it.object_iterator != m_object->m_value.object->end()); + return &(m_it.object_iterator->second); + } + + case value_t::array: + { + JSON_ASSERT(m_it.array_iterator != m_object->m_value.array->end()); + return &*m_it.array_iterator; + } + + default: + { + if (JSON_HEDLEY_LIKELY(m_it.primitive_iterator.is_begin())) + { + return m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief post-increment (it++) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl const operator++(int) + { + auto result = *this; + ++(*this); + return result; + } + + /*! + @brief pre-increment (++it) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator++() + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + std::advance(m_it.object_iterator, 1); + break; + } + + case value_t::array: + { + std::advance(m_it.array_iterator, 1); + break; + } + + default: + { + ++m_it.primitive_iterator; + break; + } + } + + return *this; + } + + /*! + @brief post-decrement (it--) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl const operator--(int) + { + auto result = *this; + --(*this); + return result; + } + + /*! + @brief pre-decrement (--it) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator--() + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + std::advance(m_it.object_iterator, -1); + break; + } + + case value_t::array: + { + std::advance(m_it.array_iterator, -1); + break; + } + + default: + { + --m_it.primitive_iterator; + break; + } + } + + return *this; + } + + /*! + @brief comparison: equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator==(const iter_impl& other) const + { + // if objects are not the same, the comparison is undefined + if (JSON_HEDLEY_UNLIKELY(m_object != other.m_object)) + { + JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); + } + + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + return (m_it.object_iterator == other.m_it.object_iterator); + + case value_t::array: + return (m_it.array_iterator == other.m_it.array_iterator); + + default: + return (m_it.primitive_iterator == other.m_it.primitive_iterator); + } + } + + /*! + @brief comparison: not equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator!=(const iter_impl& other) const + { + return !operator==(other); + } + + /*! + @brief comparison: smaller + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator<(const iter_impl& other) const + { + // if objects are not the same, the comparison is undefined + if (JSON_HEDLEY_UNLIKELY(m_object != other.m_object)) + { + JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); + } + + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators")); + + case value_t::array: + return (m_it.array_iterator < other.m_it.array_iterator); + + default: + return (m_it.primitive_iterator < other.m_it.primitive_iterator); + } + } + + /*! + @brief comparison: less than or equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator<=(const iter_impl& other) const + { + return !other.operator < (*this); + } + + /*! + @brief comparison: greater than + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator>(const iter_impl& other) const + { + return !operator<=(other); + } + + /*! + @brief comparison: greater than or equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator>=(const iter_impl& other) const + { + return !operator<(other); + } + + /*! + @brief add to iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator+=(difference_type i) + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); + + case value_t::array: + { + std::advance(m_it.array_iterator, i); + break; + } + + default: + { + m_it.primitive_iterator += i; + break; + } + } + + return *this; + } + + /*! + @brief subtract from iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator-=(difference_type i) + { + return operator+=(-i); + } + + /*! + @brief add to iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl operator+(difference_type i) const + { + auto result = *this; + result += i; + return result; + } + + /*! + @brief addition of distance and iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + friend iter_impl operator+(difference_type i, const iter_impl& it) + { + auto result = it; + result += i; + return result; + } + + /*! + @brief subtract from iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl operator-(difference_type i) const + { + auto result = *this; + result -= i; + return result; + } + + /*! + @brief return difference + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + difference_type operator-(const iter_impl& other) const + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); + + case value_t::array: + return m_it.array_iterator - other.m_it.array_iterator; + + default: + return m_it.primitive_iterator - other.m_it.primitive_iterator; + } + } + + /*! + @brief access to successor + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference operator[](difference_type n) const + { + JSON_ASSERT(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators")); + + case value_t::array: + return *std::next(m_it.array_iterator, n); + + case value_t::null: + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + + default: + { + if (JSON_HEDLEY_LIKELY(m_it.primitive_iterator.get_value() == -n)) + { + return *m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief return the key of an object iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + const typename object_t::key_type& key() const + { + JSON_ASSERT(m_object != nullptr); + + if (JSON_HEDLEY_LIKELY(m_object->is_object())) + { + return m_it.object_iterator->first; + } + + JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators")); + } + + /*! + @brief return the value of an iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference value() const + { + return operator*(); + } + + private: + /// associated JSON instance + pointer m_object = nullptr; + /// the actual iterator of the associated instance + internal_iterator::type> m_it {}; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + + +#include // ptrdiff_t +#include // reverse_iterator +#include // declval + +namespace nlohmann +{ +namespace detail +{ +////////////////////// +// reverse_iterator // +////////////////////// + +/*! +@brief a template for a reverse iterator class + +@tparam Base the base iterator type to reverse. Valid types are @ref +iterator (to create @ref reverse_iterator) and @ref const_iterator (to +create @ref const_reverse_iterator). + +@requirement The class satisfies the following concept requirements: +- +[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator): + The iterator that can be moved can be moved in both directions (i.e. + incremented and decremented). +- [OutputIterator](https://en.cppreference.com/w/cpp/named_req/OutputIterator): + It is possible to write to the pointed-to element (only if @a Base is + @ref iterator). + +@since version 1.0.0 +*/ +template +class json_reverse_iterator : public std::reverse_iterator +{ + public: + using difference_type = std::ptrdiff_t; + /// shortcut to the reverse iterator adapter + using base_iterator = std::reverse_iterator; + /// the reference type for the pointed-to element + using reference = typename Base::reference; + + /// create reverse iterator from iterator + explicit json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept + : base_iterator(it) {} + + /// create reverse iterator from base class + explicit json_reverse_iterator(const base_iterator& it) noexcept : base_iterator(it) {} + + /// post-increment (it++) + json_reverse_iterator const operator++(int) + { + return static_cast(base_iterator::operator++(1)); + } + + /// pre-increment (++it) + json_reverse_iterator& operator++() + { + return static_cast(base_iterator::operator++()); + } + + /// post-decrement (it--) + json_reverse_iterator const operator--(int) + { + return static_cast(base_iterator::operator--(1)); + } + + /// pre-decrement (--it) + json_reverse_iterator& operator--() + { + return static_cast(base_iterator::operator--()); + } + + /// add to iterator + json_reverse_iterator& operator+=(difference_type i) + { + return static_cast(base_iterator::operator+=(i)); + } + + /// add to iterator + json_reverse_iterator operator+(difference_type i) const + { + return static_cast(base_iterator::operator+(i)); + } + + /// subtract from iterator + json_reverse_iterator operator-(difference_type i) const + { + return static_cast(base_iterator::operator-(i)); + } + + /// return difference + difference_type operator-(const json_reverse_iterator& other) const + { + return base_iterator(*this) - base_iterator(other); + } + + /// access to successor + reference operator[](difference_type n) const + { + return *(this->operator+(n)); + } + + /// return the key of an object iterator + auto key() const -> decltype(std::declval().key()) + { + auto it = --this->base(); + return it.key(); + } + + /// return the value of an iterator + reference value() const + { + auto it = --this->base(); + return it.operator * (); + } +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + + +#include // all_of +#include // isdigit +#include // max +#include // accumulate +#include // string +#include // move +#include // vector + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +template +class json_pointer +{ + // allow basic_json to access private members + NLOHMANN_BASIC_JSON_TPL_DECLARATION + friend class basic_json; + + public: + /*! + @brief create JSON pointer + + Create a JSON pointer according to the syntax described in + [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3). + + @param[in] s string representing the JSON pointer; if omitted, the empty + string is assumed which references the whole JSON value + + @throw parse_error.107 if the given JSON pointer @a s is nonempty and does + not begin with a slash (`/`); see example below + + @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s is + not followed by `0` (representing `~`) or `1` (representing `/`); see + example below + + @liveexample{The example shows the construction several valid JSON pointers + as well as the exceptional behavior.,json_pointer} + + @since version 2.0.0 + */ + explicit json_pointer(const std::string& s = "") + : reference_tokens(split(s)) + {} + + /*! + @brief return a string representation of the JSON pointer + + @invariant For each JSON pointer `ptr`, it holds: + @code {.cpp} + ptr == json_pointer(ptr.to_string()); + @endcode + + @return a string representation of the JSON pointer + + @liveexample{The example shows the result of `to_string`.,json_pointer__to_string} + + @since version 2.0.0 + */ + std::string to_string() const + { + return std::accumulate(reference_tokens.begin(), reference_tokens.end(), + std::string{}, + [](const std::string & a, const std::string & b) + { + return a + "/" + escape(b); + }); + } + + /// @copydoc to_string() + operator std::string() const + { + return to_string(); + } + + /*! + @brief append another JSON pointer at the end of this JSON pointer + + @param[in] ptr JSON pointer to append + @return JSON pointer with @a ptr appended + + @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add} + + @complexity Linear in the length of @a ptr. + + @sa @ref operator/=(std::string) to append a reference token + @sa @ref operator/=(std::size_t) to append an array index + @sa @ref operator/(const json_pointer&, const json_pointer&) for a binary operator + + @since version 3.6.0 + */ + json_pointer& operator/=(const json_pointer& ptr) + { + reference_tokens.insert(reference_tokens.end(), + ptr.reference_tokens.begin(), + ptr.reference_tokens.end()); + return *this; + } + + /*! + @brief append an unescaped reference token at the end of this JSON pointer + + @param[in] token reference token to append + @return JSON pointer with @a token appended without escaping @a token + + @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add} + + @complexity Amortized constant. + + @sa @ref operator/=(const json_pointer&) to append a JSON pointer + @sa @ref operator/=(std::size_t) to append an array index + @sa @ref operator/(const json_pointer&, std::size_t) for a binary operator + + @since version 3.6.0 + */ + json_pointer& operator/=(std::string token) + { + push_back(std::move(token)); + return *this; + } + + /*! + @brief append an array index at the end of this JSON pointer + + @param[in] array_idx array index to append + @return JSON pointer with @a array_idx appended + + @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add} + + @complexity Amortized constant. + + @sa @ref operator/=(const json_pointer&) to append a JSON pointer + @sa @ref operator/=(std::string) to append a reference token + @sa @ref operator/(const json_pointer&, std::string) for a binary operator + + @since version 3.6.0 + */ + json_pointer& operator/=(std::size_t array_idx) + { + return *this /= std::to_string(array_idx); + } + + /*! + @brief create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer + + @param[in] lhs JSON pointer + @param[in] rhs JSON pointer + @return a new JSON pointer with @a rhs appended to @a lhs + + @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary} + + @complexity Linear in the length of @a lhs and @a rhs. + + @sa @ref operator/=(const json_pointer&) to append a JSON pointer + + @since version 3.6.0 + */ + friend json_pointer operator/(const json_pointer& lhs, + const json_pointer& rhs) + { + return json_pointer(lhs) /= rhs; + } + + /*! + @brief create a new JSON pointer by appending the unescaped token at the end of the JSON pointer + + @param[in] ptr JSON pointer + @param[in] token reference token + @return a new JSON pointer with unescaped @a token appended to @a ptr + + @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary} + + @complexity Linear in the length of @a ptr. + + @sa @ref operator/=(std::string) to append a reference token + + @since version 3.6.0 + */ + friend json_pointer operator/(const json_pointer& ptr, std::string token) + { + return json_pointer(ptr) /= std::move(token); + } + + /*! + @brief create a new JSON pointer by appending the array-index-token at the end of the JSON pointer + + @param[in] ptr JSON pointer + @param[in] array_idx array index + @return a new JSON pointer with @a array_idx appended to @a ptr + + @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary} + + @complexity Linear in the length of @a ptr. + + @sa @ref operator/=(std::size_t) to append an array index + + @since version 3.6.0 + */ + friend json_pointer operator/(const json_pointer& ptr, std::size_t array_idx) + { + return json_pointer(ptr) /= array_idx; + } + + /*! + @brief returns the parent of this JSON pointer + + @return parent of this JSON pointer; in case this JSON pointer is the root, + the root itself is returned + + @complexity Linear in the length of the JSON pointer. + + @liveexample{The example shows the result of `parent_pointer` for different + JSON Pointers.,json_pointer__parent_pointer} + + @since version 3.6.0 + */ + json_pointer parent_pointer() const + { + if (empty()) + { + return *this; + } + + json_pointer res = *this; + res.pop_back(); + return res; + } + + /*! + @brief remove last reference token + + @pre not `empty()` + + @liveexample{The example shows the usage of `pop_back`.,json_pointer__pop_back} + + @complexity Constant. + + @throw out_of_range.405 if JSON pointer has no parent + + @since version 3.6.0 + */ + void pop_back() + { + if (JSON_HEDLEY_UNLIKELY(empty())) + { + JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent")); + } + + reference_tokens.pop_back(); + } + + /*! + @brief return last reference token + + @pre not `empty()` + @return last reference token + + @liveexample{The example shows the usage of `back`.,json_pointer__back} + + @complexity Constant. + + @throw out_of_range.405 if JSON pointer has no parent + + @since version 3.6.0 + */ + const std::string& back() const + { + if (JSON_HEDLEY_UNLIKELY(empty())) + { + JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent")); + } + + return reference_tokens.back(); + } + + /*! + @brief append an unescaped token at the end of the reference pointer + + @param[in] token token to add + + @complexity Amortized constant. + + @liveexample{The example shows the result of `push_back` for different + JSON Pointers.,json_pointer__push_back} + + @since version 3.6.0 + */ + void push_back(const std::string& token) + { + reference_tokens.push_back(token); + } + + /// @copydoc push_back(const std::string&) + void push_back(std::string&& token) + { + reference_tokens.push_back(std::move(token)); + } + + /*! + @brief return whether pointer points to the root document + + @return true iff the JSON pointer points to the root document + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example shows the result of `empty` for different JSON + Pointers.,json_pointer__empty} + + @since version 3.6.0 + */ + bool empty() const noexcept + { + return reference_tokens.empty(); + } + + private: + /*! + @param[in] s reference token to be converted into an array index + + @return integer representation of @a s + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index begins not with a digit + @throw out_of_range.404 if string @a s could not be converted to an integer + @throw out_of_range.410 if an array index exceeds size_type + */ + static typename BasicJsonType::size_type array_index(const std::string& s) + { + using size_type = typename BasicJsonType::size_type; + + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && s[0] == '0')) + { + JSON_THROW(detail::parse_error::create(106, 0, + "array index '" + s + + "' must not begin with '0'")); + } + + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && !(s[0] >= '1' && s[0] <= '9'))) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + s + "' is not a number")); + } + + std::size_t processed_chars = 0; + unsigned long long res = 0; + JSON_TRY + { + res = std::stoull(s, &processed_chars); + } + JSON_CATCH(std::out_of_range&) + { + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + s + "'")); + } + + // check if the string was completely read + if (JSON_HEDLEY_UNLIKELY(processed_chars != s.size())) + { + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + s + "'")); + } + + // only triggered on special platforms (like 32bit), see also + // https://github.com/nlohmann/json/pull/2203 + if (res >= static_cast((std::numeric_limits::max)())) + { + JSON_THROW(detail::out_of_range::create(410, "array index " + s + " exceeds size_type")); // LCOV_EXCL_LINE + } + + return static_cast(res); + } + + json_pointer top() const + { + if (JSON_HEDLEY_UNLIKELY(empty())) + { + JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent")); + } + + json_pointer result = *this; + result.reference_tokens = {reference_tokens[0]}; + return result; + } + + /*! + @brief create and return a reference to the pointed to value + + @complexity Linear in the number of reference tokens. + + @throw parse_error.109 if array index is not a number + @throw type_error.313 if value cannot be unflattened + */ + BasicJsonType& get_and_create(BasicJsonType& j) const + { + auto result = &j; + + // in case no reference tokens exist, return a reference to the JSON value + // j which will be overwritten by a primitive value + for (const auto& reference_token : reference_tokens) + { + switch (result->type()) + { + case detail::value_t::null: + { + if (reference_token == "0") + { + // start a new array if reference token is 0 + result = &result->operator[](0); + } + else + { + // start a new object otherwise + result = &result->operator[](reference_token); + } + break; + } + + case detail::value_t::object: + { + // create an entry in the object + result = &result->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + // create an entry in the array + result = &result->operator[](array_index(reference_token)); + break; + } + + /* + The following code is only reached if there exists a reference + token _and_ the current value is primitive. In this case, we have + an error situation, because primitive values may only occur as + single value; that is, with an empty list of reference tokens. + */ + default: + JSON_THROW(detail::type_error::create(313, "invalid value to unflatten")); + } + } + + return *result; + } + + /*! + @brief return a reference to the pointed to value + + @note This version does not throw if a value is not present, but tries to + create nested values instead. For instance, calling this function + with pointer `"/this/that"` on a null value is equivalent to calling + `operator[]("this").operator[]("that")` on that value, effectively + changing the null value to an object. + + @param[in] ptr a JSON value + + @return reference to the JSON value pointed to by the JSON pointer + + @complexity Linear in the length of the JSON pointer. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + BasicJsonType& get_unchecked(BasicJsonType* ptr) const + { + for (const auto& reference_token : reference_tokens) + { + // convert null values to arrays or objects before continuing + if (ptr->is_null()) + { + // check if reference token is a number + const bool nums = + std::all_of(reference_token.begin(), reference_token.end(), + [](const unsigned char x) + { + return std::isdigit(x); + }); + + // change value to array for numbers or "-" or to object otherwise + *ptr = (nums || reference_token == "-") + ? detail::value_t::array + : detail::value_t::object; + } + + switch (ptr->type()) + { + case detail::value_t::object: + { + // use unchecked object access + ptr = &ptr->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + if (reference_token == "-") + { + // explicitly treat "-" as index beyond the end + ptr = &ptr->operator[](ptr->m_value.array->size()); + } + else + { + // convert array index to number; unchecked access + ptr = &ptr->operator[](array_index(reference_token)); + } + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + BasicJsonType& get_checked(BasicJsonType* ptr) const + { + for (const auto& reference_token : reference_tokens) + { + switch (ptr->type()) + { + case detail::value_t::object: + { + // note: at performs range check + ptr = &ptr->at(reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_HEDLEY_UNLIKELY(reference_token == "-")) + { + // "-" always fails the range check + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // note: at performs range check + ptr = &ptr->at(array_index(reference_token)); + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @brief return a const reference to the pointed to value + + @param[in] ptr a JSON value + + @return const reference to the JSON value pointed to by the JSON + pointer + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + const BasicJsonType& get_unchecked(const BasicJsonType* ptr) const + { + for (const auto& reference_token : reference_tokens) + { + switch (ptr->type()) + { + case detail::value_t::object: + { + // use unchecked object access + ptr = &ptr->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_HEDLEY_UNLIKELY(reference_token == "-")) + { + // "-" cannot be used for const access + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // use unchecked array access + ptr = &ptr->operator[](array_index(reference_token)); + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + const BasicJsonType& get_checked(const BasicJsonType* ptr) const + { + for (const auto& reference_token : reference_tokens) + { + switch (ptr->type()) + { + case detail::value_t::object: + { + // note: at performs range check + ptr = &ptr->at(reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_HEDLEY_UNLIKELY(reference_token == "-")) + { + // "-" always fails the range check + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // note: at performs range check + ptr = &ptr->at(array_index(reference_token)); + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + */ + bool contains(const BasicJsonType* ptr) const + { + for (const auto& reference_token : reference_tokens) + { + switch (ptr->type()) + { + case detail::value_t::object: + { + if (!ptr->contains(reference_token)) + { + // we did not find the key in the object + return false; + } + + ptr = &ptr->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_HEDLEY_UNLIKELY(reference_token == "-")) + { + // "-" always fails the range check + return false; + } + if (JSON_HEDLEY_UNLIKELY(reference_token.size() == 1 && !("0" <= reference_token && reference_token <= "9"))) + { + // invalid char + return false; + } + if (JSON_HEDLEY_UNLIKELY(reference_token.size() > 1)) + { + if (JSON_HEDLEY_UNLIKELY(!('1' <= reference_token[0] && reference_token[0] <= '9'))) + { + // first char should be between '1' and '9' + return false; + } + for (std::size_t i = 1; i < reference_token.size(); i++) + { + if (JSON_HEDLEY_UNLIKELY(!('0' <= reference_token[i] && reference_token[i] <= '9'))) + { + // other char should be between '0' and '9' + return false; + } + } + } + + const auto idx = array_index(reference_token); + if (idx >= ptr->size()) + { + // index out of range + return false; + } + + ptr = &ptr->operator[](idx); + break; + } + + default: + { + // we do not expect primitive values if there is still a + // reference token to process + return false; + } + } + } + + // no reference token left means we found a primitive value + return true; + } + + /*! + @brief split the string input to reference tokens + + @note This function is only called by the json_pointer constructor. + All exceptions below are documented there. + + @throw parse_error.107 if the pointer is not empty or begins with '/' + @throw parse_error.108 if character '~' is not followed by '0' or '1' + */ + static std::vector split(const std::string& reference_string) + { + std::vector result; + + // special case: empty reference string -> no reference tokens + if (reference_string.empty()) + { + return result; + } + + // check if nonempty reference string begins with slash + if (JSON_HEDLEY_UNLIKELY(reference_string[0] != '/')) + { + JSON_THROW(detail::parse_error::create(107, 1, + "JSON pointer must be empty or begin with '/' - was: '" + + reference_string + "'")); + } + + // extract the reference tokens: + // - slash: position of the last read slash (or end of string) + // - start: position after the previous slash + for ( + // search for the first slash after the first character + std::size_t slash = reference_string.find_first_of('/', 1), + // set the beginning of the first reference token + start = 1; + // we can stop if start == 0 (if slash == std::string::npos) + start != 0; + // set the beginning of the next reference token + // (will eventually be 0 if slash == std::string::npos) + start = (slash == std::string::npos) ? 0 : slash + 1, + // find next slash + slash = reference_string.find_first_of('/', start)) + { + // use the text between the beginning of the reference token + // (start) and the last slash (slash). + auto reference_token = reference_string.substr(start, slash - start); + + // check reference tokens are properly escaped + for (std::size_t pos = reference_token.find_first_of('~'); + pos != std::string::npos; + pos = reference_token.find_first_of('~', pos + 1)) + { + JSON_ASSERT(reference_token[pos] == '~'); + + // ~ must be followed by 0 or 1 + if (JSON_HEDLEY_UNLIKELY(pos == reference_token.size() - 1 || + (reference_token[pos + 1] != '0' && + reference_token[pos + 1] != '1'))) + { + JSON_THROW(detail::parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'")); + } + } + + // finally, store the reference token + unescape(reference_token); + result.push_back(reference_token); + } + + return result; + } + + /*! + @brief replace all occurrences of a substring by another string + + @param[in,out] s the string to manipulate; changed so that all + occurrences of @a f are replaced with @a t + @param[in] f the substring to replace with @a t + @param[in] t the string to replace @a f + + @pre The search string @a f must not be empty. **This precondition is + enforced with an assertion.** + + @since version 2.0.0 + */ + static void replace_substring(std::string& s, const std::string& f, + const std::string& t) + { + JSON_ASSERT(!f.empty()); + for (auto pos = s.find(f); // find first occurrence of f + pos != std::string::npos; // make sure f was found + s.replace(pos, f.size(), t), // replace with t, and + pos = s.find(f, pos + t.size())) // find next occurrence of f + {} + } + + /// escape "~" to "~0" and "/" to "~1" + static std::string escape(std::string s) + { + replace_substring(s, "~", "~0"); + replace_substring(s, "/", "~1"); + return s; + } + + /// unescape "~1" to tilde and "~0" to slash (order is important!) + static void unescape(std::string& s) + { + replace_substring(s, "~1", "/"); + replace_substring(s, "~0", "~"); + } + + /*! + @param[in] reference_string the reference string to the current value + @param[in] value the value to consider + @param[in,out] result the result object to insert values to + + @note Empty objects or arrays are flattened to `null`. + */ + static void flatten(const std::string& reference_string, + const BasicJsonType& value, + BasicJsonType& result) + { + switch (value.type()) + { + case detail::value_t::array: + { + if (value.m_value.array->empty()) + { + // flatten empty array as null + result[reference_string] = nullptr; + } + else + { + // iterate array and use index as reference string + for (std::size_t i = 0; i < value.m_value.array->size(); ++i) + { + flatten(reference_string + "/" + std::to_string(i), + value.m_value.array->operator[](i), result); + } + } + break; + } + + case detail::value_t::object: + { + if (value.m_value.object->empty()) + { + // flatten empty object as null + result[reference_string] = nullptr; + } + else + { + // iterate object and use keys as reference string + for (const auto& element : *value.m_value.object) + { + flatten(reference_string + "/" + escape(element.first), element.second, result); + } + } + break; + } + + default: + { + // add primitive value with its reference string + result[reference_string] = value; + break; + } + } + } + + /*! + @param[in] value flattened JSON + + @return unflattened JSON + + @throw parse_error.109 if array index is not a number + @throw type_error.314 if value is not an object + @throw type_error.315 if object values are not primitive + @throw type_error.313 if value cannot be unflattened + */ + static BasicJsonType + unflatten(const BasicJsonType& value) + { + if (JSON_HEDLEY_UNLIKELY(!value.is_object())) + { + JSON_THROW(detail::type_error::create(314, "only objects can be unflattened")); + } + + BasicJsonType result; + + // iterate the JSON object values + for (const auto& element : *value.m_value.object) + { + if (JSON_HEDLEY_UNLIKELY(!element.second.is_primitive())) + { + JSON_THROW(detail::type_error::create(315, "values in object must be primitive")); + } + + // assign value to reference pointed to by JSON pointer; Note that if + // the JSON pointer is "" (i.e., points to the whole value), function + // get_and_create returns a reference to result itself. An assignment + // will then create a primitive value. + json_pointer(element.first).get_and_create(result) = element.second; + } + + return result; + } + + /*! + @brief compares two JSON pointers for equality + + @param[in] lhs JSON pointer to compare + @param[in] rhs JSON pointer to compare + @return whether @a lhs is equal to @a rhs + + @complexity Linear in the length of the JSON pointer + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + */ + friend bool operator==(json_pointer const& lhs, + json_pointer const& rhs) noexcept + { + return lhs.reference_tokens == rhs.reference_tokens; + } + + /*! + @brief compares two JSON pointers for inequality + + @param[in] lhs JSON pointer to compare + @param[in] rhs JSON pointer to compare + @return whether @a lhs is not equal @a rhs + + @complexity Linear in the length of the JSON pointer + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + */ + friend bool operator!=(json_pointer const& lhs, + json_pointer const& rhs) noexcept + { + return !(lhs == rhs); + } + + /// the reference tokens + std::vector reference_tokens; +}; +} // namespace nlohmann + +// #include + + +#include +#include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +template +class json_ref +{ + public: + using value_type = BasicJsonType; + + json_ref(value_type&& value) + : owned_value(std::move(value)) + , value_ref(&owned_value) + , is_rvalue(true) + {} + + json_ref(const value_type& value) + : value_ref(const_cast(&value)) + , is_rvalue(false) + {} + + json_ref(std::initializer_list init) + : owned_value(init) + , value_ref(&owned_value) + , is_rvalue(true) + {} + + template < + class... Args, + enable_if_t::value, int> = 0 > + json_ref(Args && ... args) + : owned_value(std::forward(args)...) + , value_ref(&owned_value) + , is_rvalue(true) + {} + + // class should be movable only + json_ref(json_ref&&) = default; + json_ref(const json_ref&) = delete; + json_ref& operator=(const json_ref&) = delete; + json_ref& operator=(json_ref&&) = delete; + ~json_ref() = default; + + value_type moved_or_copied() const + { + if (is_rvalue) + { + return std::move(*value_ref); + } + return *value_ref; + } + + value_type const& operator*() const + { + return *static_cast(value_ref); + } + + value_type const* operator->() const + { + return static_cast(value_ref); + } + + private: + mutable value_type owned_value = nullptr; + value_type* value_ref = nullptr; + const bool is_rvalue = true; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + +// #include + +// #include + + +#include // reverse +#include // array +#include // uint8_t, uint16_t, uint32_t, uint64_t +#include // memcpy +#include // numeric_limits +#include // string +#include // isnan, isinf + +// #include + +// #include + +// #include + + +#include // copy +#include // size_t +#include // streamsize +#include // back_inserter +#include // shared_ptr, make_shared +#include // basic_ostream +#include // basic_string +#include // vector +// #include + + +namespace nlohmann +{ +namespace detail +{ +/// abstract output adapter interface +template struct output_adapter_protocol +{ + virtual void write_character(CharType c) = 0; + virtual void write_characters(const CharType* s, std::size_t length) = 0; + virtual ~output_adapter_protocol() = default; +}; + +/// a type to simplify interfaces +template +using output_adapter_t = std::shared_ptr>; + +/// output adapter for byte vectors +template +class output_vector_adapter : public output_adapter_protocol +{ + public: + explicit output_vector_adapter(std::vector& vec) noexcept + : v(vec) + {} + + void write_character(CharType c) override + { + v.push_back(c); + } + + JSON_HEDLEY_NON_NULL(2) + void write_characters(const CharType* s, std::size_t length) override + { + std::copy(s, s + length, std::back_inserter(v)); + } + + private: + std::vector& v; +}; + +/// output adapter for output streams +template +class output_stream_adapter : public output_adapter_protocol +{ + public: + explicit output_stream_adapter(std::basic_ostream& s) noexcept + : stream(s) + {} + + void write_character(CharType c) override + { + stream.put(c); + } + + JSON_HEDLEY_NON_NULL(2) + void write_characters(const CharType* s, std::size_t length) override + { + stream.write(s, static_cast(length)); + } + + private: + std::basic_ostream& stream; +}; + +/// output adapter for basic_string +template> +class output_string_adapter : public output_adapter_protocol +{ + public: + explicit output_string_adapter(StringType& s) noexcept + : str(s) + {} + + void write_character(CharType c) override + { + str.push_back(c); + } + + JSON_HEDLEY_NON_NULL(2) + void write_characters(const CharType* s, std::size_t length) override + { + str.append(s, length); + } + + private: + StringType& str; +}; + +template> +class output_adapter +{ + public: + output_adapter(std::vector& vec) + : oa(std::make_shared>(vec)) {} + + output_adapter(std::basic_ostream& s) + : oa(std::make_shared>(s)) {} + + output_adapter(StringType& s) + : oa(std::make_shared>(s)) {} + + operator output_adapter_t() + { + return oa; + } + + private: + output_adapter_t oa = nullptr; +}; +} // namespace detail +} // namespace nlohmann + + +namespace nlohmann +{ +namespace detail +{ +/////////////////// +// binary writer // +/////////////////// + +/*! +@brief serialization to CBOR and MessagePack values +*/ +template +class binary_writer +{ + using string_t = typename BasicJsonType::string_t; + using binary_t = typename BasicJsonType::binary_t; + using number_float_t = typename BasicJsonType::number_float_t; + + public: + /*! + @brief create a binary writer + + @param[in] adapter output adapter to write to + */ + explicit binary_writer(output_adapter_t adapter) : oa(adapter) + { + JSON_ASSERT(oa); + } + + /*! + @param[in] j JSON value to serialize + @pre j.type() == value_t::object + */ + void write_bson(const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::object: + { + write_bson_object(*j.m_value.object); + break; + } + + default: + { + JSON_THROW(type_error::create(317, "to serialize to BSON, top-level type must be object, but is " + std::string(j.type_name()))); + } + } + } + + /*! + @param[in] j JSON value to serialize + */ + void write_cbor(const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::null: + { + oa->write_character(to_char_type(0xF6)); + break; + } + + case value_t::boolean: + { + oa->write_character(j.m_value.boolean + ? to_char_type(0xF5) + : to_char_type(0xF4)); + break; + } + + case value_t::number_integer: + { + if (j.m_value.number_integer >= 0) + { + // CBOR does not differentiate between positive signed + // integers and unsigned integers. Therefore, we used the + // code from the value_t::number_unsigned case here. + if (j.m_value.number_integer <= 0x17) + { + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x18)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x19)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x1A)); + write_number(static_cast(j.m_value.number_integer)); + } + else + { + oa->write_character(to_char_type(0x1B)); + write_number(static_cast(j.m_value.number_integer)); + } + } + else + { + // The conversions below encode the sign in the first + // byte, and the value is converted to a positive number. + const auto positive_number = -1 - j.m_value.number_integer; + if (j.m_value.number_integer >= -24) + { + write_number(static_cast(0x20 + positive_number)); + } + else if (positive_number <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x38)); + write_number(static_cast(positive_number)); + } + else if (positive_number <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x39)); + write_number(static_cast(positive_number)); + } + else if (positive_number <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x3A)); + write_number(static_cast(positive_number)); + } + else + { + oa->write_character(to_char_type(0x3B)); + write_number(static_cast(positive_number)); + } + } + break; + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned <= 0x17) + { + write_number(static_cast(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x18)); + write_number(static_cast(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x19)); + write_number(static_cast(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x1A)); + write_number(static_cast(j.m_value.number_unsigned)); + } + else + { + oa->write_character(to_char_type(0x1B)); + write_number(static_cast(j.m_value.number_unsigned)); + } + break; + } + + case value_t::number_float: + { + if (std::isnan(j.m_value.number_float)) + { + // NaN is 0xf97e00 in CBOR + oa->write_character(to_char_type(0xF9)); + oa->write_character(to_char_type(0x7E)); + oa->write_character(to_char_type(0x00)); + } + else if (std::isinf(j.m_value.number_float)) + { + // Infinity is 0xf97c00, -Infinity is 0xf9fc00 + oa->write_character(to_char_type(0xf9)); + oa->write_character(j.m_value.number_float > 0 ? to_char_type(0x7C) : to_char_type(0xFC)); + oa->write_character(to_char_type(0x00)); + } + else + { + write_compact_float(j.m_value.number_float, detail::input_format_t::cbor); + } + break; + } + + case value_t::string: + { + // step 1: write control byte and the string length + const auto N = j.m_value.string->size(); + if (N <= 0x17) + { + write_number(static_cast(0x60 + N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x78)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x79)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x7A)); + write_number(static_cast(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x7B)); + write_number(static_cast(N)); + } + // LCOV_EXCL_STOP + + // step 2: write the string + oa->write_characters( + reinterpret_cast(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + // step 1: write control byte and the array size + const auto N = j.m_value.array->size(); + if (N <= 0x17) + { + write_number(static_cast(0x80 + N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x98)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x99)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x9A)); + write_number(static_cast(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x9B)); + write_number(static_cast(N)); + } + // LCOV_EXCL_STOP + + // step 2: write each element + for (const auto& el : *j.m_value.array) + { + write_cbor(el); + } + break; + } + + case value_t::binary: + { + if (j.m_value.binary->has_subtype()) + { + write_number(static_cast(0xd8)); + write_number(j.m_value.binary->subtype()); + } + + // step 1: write control byte and the binary array size + const auto N = j.m_value.binary->size(); + if (N <= 0x17) + { + write_number(static_cast(0x40 + N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x58)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x59)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x5A)); + write_number(static_cast(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0x5B)); + write_number(static_cast(N)); + } + // LCOV_EXCL_STOP + + // step 2: write each element + oa->write_characters( + reinterpret_cast(j.m_value.binary->data()), + N); + + break; + } + + case value_t::object: + { + // step 1: write control byte and the object size + const auto N = j.m_value.object->size(); + if (N <= 0x17) + { + write_number(static_cast(0xA0 + N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0xB8)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0xB9)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0xBA)); + write_number(static_cast(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits::max)()) + { + oa->write_character(to_char_type(0xBB)); + write_number(static_cast(N)); + } + // LCOV_EXCL_STOP + + // step 2: write each element + for (const auto& el : *j.m_value.object) + { + write_cbor(el.first); + write_cbor(el.second); + } + break; + } + + default: + break; + } + } + + /*! + @param[in] j JSON value to serialize + */ + void write_msgpack(const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::null: // nil + { + oa->write_character(to_char_type(0xC0)); + break; + } + + case value_t::boolean: // true and false + { + oa->write_character(j.m_value.boolean + ? to_char_type(0xC3) + : to_char_type(0xC2)); + break; + } + + case value_t::number_integer: + { + if (j.m_value.number_integer >= 0) + { + // MessagePack does not differentiate between positive + // signed integers and unsigned integers. Therefore, we used + // the code from the value_t::number_unsigned case here. + if (j.m_value.number_unsigned < 128) + { + // positive fixnum + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 8 + oa->write_character(to_char_type(0xCC)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 16 + oa->write_character(to_char_type(0xCD)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 32 + oa->write_character(to_char_type(0xCE)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 64 + oa->write_character(to_char_type(0xCF)); + write_number(static_cast(j.m_value.number_integer)); + } + } + else + { + if (j.m_value.number_integer >= -32) + { + // negative fixnum + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits::min)() && + j.m_value.number_integer <= (std::numeric_limits::max)()) + { + // int 8 + oa->write_character(to_char_type(0xD0)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits::min)() && + j.m_value.number_integer <= (std::numeric_limits::max)()) + { + // int 16 + oa->write_character(to_char_type(0xD1)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits::min)() && + j.m_value.number_integer <= (std::numeric_limits::max)()) + { + // int 32 + oa->write_character(to_char_type(0xD2)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits::min)() && + j.m_value.number_integer <= (std::numeric_limits::max)()) + { + // int 64 + oa->write_character(to_char_type(0xD3)); + write_number(static_cast(j.m_value.number_integer)); + } + } + break; + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned < 128) + { + // positive fixnum + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 8 + oa->write_character(to_char_type(0xCC)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 16 + oa->write_character(to_char_type(0xCD)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 32 + oa->write_character(to_char_type(0xCE)); + write_number(static_cast(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) + { + // uint 64 + oa->write_character(to_char_type(0xCF)); + write_number(static_cast(j.m_value.number_integer)); + } + break; + } + + case value_t::number_float: + { + write_compact_float(j.m_value.number_float, detail::input_format_t::msgpack); + break; + } + + case value_t::string: + { + // step 1: write control byte and the string length + const auto N = j.m_value.string->size(); + if (N <= 31) + { + // fixstr + write_number(static_cast(0xA0 | N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // str 8 + oa->write_character(to_char_type(0xD9)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // str 16 + oa->write_character(to_char_type(0xDA)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // str 32 + oa->write_character(to_char_type(0xDB)); + write_number(static_cast(N)); + } + + // step 2: write the string + oa->write_characters( + reinterpret_cast(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + // step 1: write control byte and the array size + const auto N = j.m_value.array->size(); + if (N <= 15) + { + // fixarray + write_number(static_cast(0x90 | N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // array 16 + oa->write_character(to_char_type(0xDC)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // array 32 + oa->write_character(to_char_type(0xDD)); + write_number(static_cast(N)); + } + + // step 2: write each element + for (const auto& el : *j.m_value.array) + { + write_msgpack(el); + } + break; + } + + case value_t::binary: + { + // step 0: determine if the binary type has a set subtype to + // determine whether or not to use the ext or fixext types + const bool use_ext = j.m_value.binary->has_subtype(); + + // step 1: write control byte and the byte string length + const auto N = j.m_value.binary->size(); + if (N <= (std::numeric_limits::max)()) + { + std::uint8_t output_type{}; + bool fixed = true; + if (use_ext) + { + switch (N) + { + case 1: + output_type = 0xD4; // fixext 1 + break; + case 2: + output_type = 0xD5; // fixext 2 + break; + case 4: + output_type = 0xD6; // fixext 4 + break; + case 8: + output_type = 0xD7; // fixext 8 + break; + case 16: + output_type = 0xD8; // fixext 16 + break; + default: + output_type = 0xC7; // ext 8 + fixed = false; + break; + } + + } + else + { + output_type = 0xC4; // bin 8 + fixed = false; + } + + oa->write_character(to_char_type(output_type)); + if (!fixed) + { + write_number(static_cast(N)); + } + } + else if (N <= (std::numeric_limits::max)()) + { + std::uint8_t output_type = use_ext + ? 0xC8 // ext 16 + : 0xC5; // bin 16 + + oa->write_character(to_char_type(output_type)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + std::uint8_t output_type = use_ext + ? 0xC9 // ext 32 + : 0xC6; // bin 32 + + oa->write_character(to_char_type(output_type)); + write_number(static_cast(N)); + } + + // step 1.5: if this is an ext type, write the subtype + if (use_ext) + { + write_number(static_cast(j.m_value.binary->subtype())); + } + + // step 2: write the byte string + oa->write_characters( + reinterpret_cast(j.m_value.binary->data()), + N); + + break; + } + + case value_t::object: + { + // step 1: write control byte and the object size + const auto N = j.m_value.object->size(); + if (N <= 15) + { + // fixmap + write_number(static_cast(0x80 | (N & 0xF))); + } + else if (N <= (std::numeric_limits::max)()) + { + // map 16 + oa->write_character(to_char_type(0xDE)); + write_number(static_cast(N)); + } + else if (N <= (std::numeric_limits::max)()) + { + // map 32 + oa->write_character(to_char_type(0xDF)); + write_number(static_cast(N)); + } + + // step 2: write each element + for (const auto& el : *j.m_value.object) + { + write_msgpack(el.first); + write_msgpack(el.second); + } + break; + } + + default: + break; + } + } + + /*! + @param[in] j JSON value to serialize + @param[in] use_count whether to use '#' prefixes (optimized format) + @param[in] use_type whether to use '$' prefixes (optimized format) + @param[in] add_prefix whether prefixes need to be used for this value + */ + void write_ubjson(const BasicJsonType& j, const bool use_count, + const bool use_type, const bool add_prefix = true) + { + switch (j.type()) + { + case value_t::null: + { + if (add_prefix) + { + oa->write_character(to_char_type('Z')); + } + break; + } + + case value_t::boolean: + { + if (add_prefix) + { + oa->write_character(j.m_value.boolean + ? to_char_type('T') + : to_char_type('F')); + } + break; + } + + case value_t::number_integer: + { + write_number_with_ubjson_prefix(j.m_value.number_integer, add_prefix); + break; + } + + case value_t::number_unsigned: + { + write_number_with_ubjson_prefix(j.m_value.number_unsigned, add_prefix); + break; + } + + case value_t::number_float: + { + write_number_with_ubjson_prefix(j.m_value.number_float, add_prefix); + break; + } + + case value_t::string: + { + if (add_prefix) + { + oa->write_character(to_char_type('S')); + } + write_number_with_ubjson_prefix(j.m_value.string->size(), true); + oa->write_characters( + reinterpret_cast(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + if (add_prefix) + { + oa->write_character(to_char_type('[')); + } + + bool prefix_required = true; + if (use_type && !j.m_value.array->empty()) + { + JSON_ASSERT(use_count); + const CharType first_prefix = ubjson_prefix(j.front()); + const bool same_prefix = std::all_of(j.begin() + 1, j.end(), + [this, first_prefix](const BasicJsonType & v) + { + return ubjson_prefix(v) == first_prefix; + }); + + if (same_prefix) + { + prefix_required = false; + oa->write_character(to_char_type('$')); + oa->write_character(first_prefix); + } + } + + if (use_count) + { + oa->write_character(to_char_type('#')); + write_number_with_ubjson_prefix(j.m_value.array->size(), true); + } + + for (const auto& el : *j.m_value.array) + { + write_ubjson(el, use_count, use_type, prefix_required); + } + + if (!use_count) + { + oa->write_character(to_char_type(']')); + } + + break; + } + + case value_t::binary: + { + if (add_prefix) + { + oa->write_character(to_char_type('[')); + } + + if (use_type && !j.m_value.binary->empty()) + { + JSON_ASSERT(use_count); + oa->write_character(to_char_type('$')); + oa->write_character('U'); + } + + if (use_count) + { + oa->write_character(to_char_type('#')); + write_number_with_ubjson_prefix(j.m_value.binary->size(), true); + } + + if (use_type) + { + oa->write_characters( + reinterpret_cast(j.m_value.binary->data()), + j.m_value.binary->size()); + } + else + { + for (size_t i = 0; i < j.m_value.binary->size(); ++i) + { + oa->write_character(to_char_type('U')); + oa->write_character(j.m_value.binary->data()[i]); + } + } + + if (!use_count) + { + oa->write_character(to_char_type(']')); + } + + break; + } + + case value_t::object: + { + if (add_prefix) + { + oa->write_character(to_char_type('{')); + } + + bool prefix_required = true; + if (use_type && !j.m_value.object->empty()) + { + JSON_ASSERT(use_count); + const CharType first_prefix = ubjson_prefix(j.front()); + const bool same_prefix = std::all_of(j.begin(), j.end(), + [this, first_prefix](const BasicJsonType & v) + { + return ubjson_prefix(v) == first_prefix; + }); + + if (same_prefix) + { + prefix_required = false; + oa->write_character(to_char_type('$')); + oa->write_character(first_prefix); + } + } + + if (use_count) + { + oa->write_character(to_char_type('#')); + write_number_with_ubjson_prefix(j.m_value.object->size(), true); + } + + for (const auto& el : *j.m_value.object) + { + write_number_with_ubjson_prefix(el.first.size(), true); + oa->write_characters( + reinterpret_cast(el.first.c_str()), + el.first.size()); + write_ubjson(el.second, use_count, use_type, prefix_required); + } + + if (!use_count) + { + oa->write_character(to_char_type('}')); + } + + break; + } + + default: + break; + } + } + + private: + ////////// + // BSON // + ////////// + + /*! + @return The size of a BSON document entry header, including the id marker + and the entry name size (and its null-terminator). + */ + static std::size_t calc_bson_entry_header_size(const string_t& name) + { + const auto it = name.find(static_cast(0)); + if (JSON_HEDLEY_UNLIKELY(it != BasicJsonType::string_t::npos)) + { + JSON_THROW(out_of_range::create(409, + "BSON key cannot contain code point U+0000 (at byte " + std::to_string(it) + ")")); + } + + return /*id*/ 1ul + name.size() + /*zero-terminator*/1u; + } + + /*! + @brief Writes the given @a element_type and @a name to the output adapter + */ + void write_bson_entry_header(const string_t& name, + const std::uint8_t element_type) + { + oa->write_character(to_char_type(element_type)); // boolean + oa->write_characters( + reinterpret_cast(name.c_str()), + name.size() + 1u); + } + + /*! + @brief Writes a BSON element with key @a name and boolean value @a value + */ + void write_bson_boolean(const string_t& name, + const bool value) + { + write_bson_entry_header(name, 0x08); + oa->write_character(value ? to_char_type(0x01) : to_char_type(0x00)); + } + + /*! + @brief Writes a BSON element with key @a name and double value @a value + */ + void write_bson_double(const string_t& name, + const double value) + { + write_bson_entry_header(name, 0x01); + write_number(value); + } + + /*! + @return The size of the BSON-encoded string in @a value + */ + static std::size_t calc_bson_string_size(const string_t& value) + { + return sizeof(std::int32_t) + value.size() + 1ul; + } + + /*! + @brief Writes a BSON element with key @a name and string value @a value + */ + void write_bson_string(const string_t& name, + const string_t& value) + { + write_bson_entry_header(name, 0x02); + + write_number(static_cast(value.size() + 1ul)); + oa->write_characters( + reinterpret_cast(value.c_str()), + value.size() + 1); + } + + /*! + @brief Writes a BSON element with key @a name and null value + */ + void write_bson_null(const string_t& name) + { + write_bson_entry_header(name, 0x0A); + } + + /*! + @return The size of the BSON-encoded integer @a value + */ + static std::size_t calc_bson_integer_size(const std::int64_t value) + { + return (std::numeric_limits::min)() <= value && value <= (std::numeric_limits::max)() + ? sizeof(std::int32_t) + : sizeof(std::int64_t); + } + + /*! + @brief Writes a BSON element with key @a name and integer @a value + */ + void write_bson_integer(const string_t& name, + const std::int64_t value) + { + if ((std::numeric_limits::min)() <= value && value <= (std::numeric_limits::max)()) + { + write_bson_entry_header(name, 0x10); // int32 + write_number(static_cast(value)); + } + else + { + write_bson_entry_header(name, 0x12); // int64 + write_number(static_cast(value)); + } + } + + /*! + @return The size of the BSON-encoded unsigned integer in @a j + */ + static constexpr std::size_t calc_bson_unsigned_size(const std::uint64_t value) noexcept + { + return (value <= static_cast((std::numeric_limits::max)())) + ? sizeof(std::int32_t) + : sizeof(std::int64_t); + } + + /*! + @brief Writes a BSON element with key @a name and unsigned @a value + */ + void write_bson_unsigned(const string_t& name, + const std::uint64_t value) + { + if (value <= static_cast((std::numeric_limits::max)())) + { + write_bson_entry_header(name, 0x10 /* int32 */); + write_number(static_cast(value)); + } + else if (value <= static_cast((std::numeric_limits::max)())) + { + write_bson_entry_header(name, 0x12 /* int64 */); + write_number(static_cast(value)); + } + else + { + JSON_THROW(out_of_range::create(407, "integer number " + std::to_string(value) + " cannot be represented by BSON as it does not fit int64")); + } + } + + /*! + @brief Writes a BSON element with key @a name and object @a value + */ + void write_bson_object_entry(const string_t& name, + const typename BasicJsonType::object_t& value) + { + write_bson_entry_header(name, 0x03); // object + write_bson_object(value); + } + + /*! + @return The size of the BSON-encoded array @a value + */ + static std::size_t calc_bson_array_size(const typename BasicJsonType::array_t& value) + { + std::size_t array_index = 0ul; + + const std::size_t embedded_document_size = std::accumulate(std::begin(value), std::end(value), std::size_t(0), [&array_index](std::size_t result, const typename BasicJsonType::array_t::value_type & el) + { + return result + calc_bson_element_size(std::to_string(array_index++), el); + }); + + return sizeof(std::int32_t) + embedded_document_size + 1ul; + } + + /*! + @return The size of the BSON-encoded binary array @a value + */ + static std::size_t calc_bson_binary_size(const typename BasicJsonType::binary_t& value) + { + return sizeof(std::int32_t) + value.size() + 1ul; + } + + /*! + @brief Writes a BSON element with key @a name and array @a value + */ + void write_bson_array(const string_t& name, + const typename BasicJsonType::array_t& value) + { + write_bson_entry_header(name, 0x04); // array + write_number(static_cast(calc_bson_array_size(value))); + + std::size_t array_index = 0ul; + + for (const auto& el : value) + { + write_bson_element(std::to_string(array_index++), el); + } + + oa->write_character(to_char_type(0x00)); + } + + /*! + @brief Writes a BSON element with key @a name and binary value @a value + */ + void write_bson_binary(const string_t& name, + const binary_t& value) + { + write_bson_entry_header(name, 0x05); + + write_number(static_cast(value.size())); + write_number(value.has_subtype() ? value.subtype() : std::uint8_t(0x00)); + + oa->write_characters(reinterpret_cast(value.data()), value.size()); + } + + /*! + @brief Calculates the size necessary to serialize the JSON value @a j with its @a name + @return The calculated size for the BSON document entry for @a j with the given @a name. + */ + static std::size_t calc_bson_element_size(const string_t& name, + const BasicJsonType& j) + { + const auto header_size = calc_bson_entry_header_size(name); + switch (j.type()) + { + case value_t::object: + return header_size + calc_bson_object_size(*j.m_value.object); + + case value_t::array: + return header_size + calc_bson_array_size(*j.m_value.array); + + case value_t::binary: + return header_size + calc_bson_binary_size(*j.m_value.binary); + + case value_t::boolean: + return header_size + 1ul; + + case value_t::number_float: + return header_size + 8ul; + + case value_t::number_integer: + return header_size + calc_bson_integer_size(j.m_value.number_integer); + + case value_t::number_unsigned: + return header_size + calc_bson_unsigned_size(j.m_value.number_unsigned); + + case value_t::string: + return header_size + calc_bson_string_size(*j.m_value.string); + + case value_t::null: + return header_size + 0ul; + + // LCOV_EXCL_START + default: + JSON_ASSERT(false); + return 0ul; + // LCOV_EXCL_STOP + } + } + + /*! + @brief Serializes the JSON value @a j to BSON and associates it with the + key @a name. + @param name The name to associate with the JSON entity @a j within the + current BSON document + @return The size of the BSON entry + */ + void write_bson_element(const string_t& name, + const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::object: + return write_bson_object_entry(name, *j.m_value.object); + + case value_t::array: + return write_bson_array(name, *j.m_value.array); + + case value_t::binary: + return write_bson_binary(name, *j.m_value.binary); + + case value_t::boolean: + return write_bson_boolean(name, j.m_value.boolean); + + case value_t::number_float: + return write_bson_double(name, j.m_value.number_float); + + case value_t::number_integer: + return write_bson_integer(name, j.m_value.number_integer); + + case value_t::number_unsigned: + return write_bson_unsigned(name, j.m_value.number_unsigned); + + case value_t::string: + return write_bson_string(name, *j.m_value.string); + + case value_t::null: + return write_bson_null(name); + + // LCOV_EXCL_START + default: + JSON_ASSERT(false); + return; + // LCOV_EXCL_STOP + } + } + + /*! + @brief Calculates the size of the BSON serialization of the given + JSON-object @a j. + @param[in] j JSON value to serialize + @pre j.type() == value_t::object + */ + static std::size_t calc_bson_object_size(const typename BasicJsonType::object_t& value) + { + std::size_t document_size = std::accumulate(value.begin(), value.end(), std::size_t(0), + [](size_t result, const typename BasicJsonType::object_t::value_type & el) + { + return result += calc_bson_element_size(el.first, el.second); + }); + + return sizeof(std::int32_t) + document_size + 1ul; + } + + /*! + @param[in] j JSON value to serialize + @pre j.type() == value_t::object + */ + void write_bson_object(const typename BasicJsonType::object_t& value) + { + write_number(static_cast(calc_bson_object_size(value))); + + for (const auto& el : value) + { + write_bson_element(el.first, el.second); + } + + oa->write_character(to_char_type(0x00)); + } + + ////////// + // CBOR // + ////////// + + static constexpr CharType get_cbor_float_prefix(float /*unused*/) + { + return to_char_type(0xFA); // Single-Precision Float + } + + static constexpr CharType get_cbor_float_prefix(double /*unused*/) + { + return to_char_type(0xFB); // Double-Precision Float + } + + ///////////// + // MsgPack // + ///////////// + + static constexpr CharType get_msgpack_float_prefix(float /*unused*/) + { + return to_char_type(0xCA); // float 32 + } + + static constexpr CharType get_msgpack_float_prefix(double /*unused*/) + { + return to_char_type(0xCB); // float 64 + } + + //////////// + // UBJSON // + //////////// + + // UBJSON: write number (floating point) + template::value, int>::type = 0> + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if (add_prefix) + { + oa->write_character(get_ubjson_float_prefix(n)); + } + write_number(n); + } + + // UBJSON: write number (unsigned integer) + template::value, int>::type = 0> + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if (n <= static_cast((std::numeric_limits::max)())) + { + if (add_prefix) + { + oa->write_character(to_char_type('i')); // int8 + } + write_number(static_cast(n)); + } + else if (n <= (std::numeric_limits::max)()) + { + if (add_prefix) + { + oa->write_character(to_char_type('U')); // uint8 + } + write_number(static_cast(n)); + } + else if (n <= static_cast((std::numeric_limits::max)())) + { + if (add_prefix) + { + oa->write_character(to_char_type('I')); // int16 + } + write_number(static_cast(n)); + } + else if (n <= static_cast((std::numeric_limits::max)())) + { + if (add_prefix) + { + oa->write_character(to_char_type('l')); // int32 + } + write_number(static_cast(n)); + } + else if (n <= static_cast((std::numeric_limits::max)())) + { + if (add_prefix) + { + oa->write_character(to_char_type('L')); // int64 + } + write_number(static_cast(n)); + } + else + { + if (add_prefix) + { + oa->write_character(to_char_type('H')); // high-precision number + } + + const auto number = BasicJsonType(n).dump(); + write_number_with_ubjson_prefix(number.size(), true); + for (std::size_t i = 0; i < number.size(); ++i) + { + oa->write_character(to_char_type(static_cast(number[i]))); + } + } + } + + // UBJSON: write number (signed integer) + template < typename NumberType, typename std::enable_if < + std::is_signed::value&& + !std::is_floating_point::value, int >::type = 0 > + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if ((std::numeric_limits::min)() <= n && n <= (std::numeric_limits::max)()) + { + if (add_prefix) + { + oa->write_character(to_char_type('i')); // int8 + } + write_number(static_cast(n)); + } + else if (static_cast((std::numeric_limits::min)()) <= n && n <= static_cast((std::numeric_limits::max)())) + { + if (add_prefix) + { + oa->write_character(to_char_type('U')); // uint8 + } + write_number(static_cast(n)); + } + else if ((std::numeric_limits::min)() <= n && n <= (std::numeric_limits::max)()) + { + if (add_prefix) + { + oa->write_character(to_char_type('I')); // int16 + } + write_number(static_cast(n)); + } + else if ((std::numeric_limits::min)() <= n && n <= (std::numeric_limits::max)()) + { + if (add_prefix) + { + oa->write_character(to_char_type('l')); // int32 + } + write_number(static_cast(n)); + } + else if ((std::numeric_limits::min)() <= n && n <= (std::numeric_limits::max)()) + { + if (add_prefix) + { + oa->write_character(to_char_type('L')); // int64 + } + write_number(static_cast(n)); + } + // LCOV_EXCL_START + else + { + if (add_prefix) + { + oa->write_character(to_char_type('H')); // high-precision number + } + + const auto number = BasicJsonType(n).dump(); + write_number_with_ubjson_prefix(number.size(), true); + for (std::size_t i = 0; i < number.size(); ++i) + { + oa->write_character(to_char_type(static_cast(number[i]))); + } + } + // LCOV_EXCL_STOP + } + + /*! + @brief determine the type prefix of container values + */ + CharType ubjson_prefix(const BasicJsonType& j) const noexcept + { + switch (j.type()) + { + case value_t::null: + return 'Z'; + + case value_t::boolean: + return j.m_value.boolean ? 'T' : 'F'; + + case value_t::number_integer: + { + if ((std::numeric_limits::min)() <= j.m_value.number_integer && j.m_value.number_integer <= (std::numeric_limits::max)()) + { + return 'i'; + } + if ((std::numeric_limits::min)() <= j.m_value.number_integer && j.m_value.number_integer <= (std::numeric_limits::max)()) + { + return 'U'; + } + if ((std::numeric_limits::min)() <= j.m_value.number_integer && j.m_value.number_integer <= (std::numeric_limits::max)()) + { + return 'I'; + } + if ((std::numeric_limits::min)() <= j.m_value.number_integer && j.m_value.number_integer <= (std::numeric_limits::max)()) + { + return 'l'; + } + if ((std::numeric_limits::min)() <= j.m_value.number_integer && j.m_value.number_integer <= (std::numeric_limits::max)()) + { + return 'L'; + } + // anything else is treated as high-precision number + return 'H'; // LCOV_EXCL_LINE + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned <= static_cast((std::numeric_limits::max)())) + { + return 'i'; + } + if (j.m_value.number_unsigned <= static_cast((std::numeric_limits::max)())) + { + return 'U'; + } + if (j.m_value.number_unsigned <= static_cast((std::numeric_limits::max)())) + { + return 'I'; + } + if (j.m_value.number_unsigned <= static_cast((std::numeric_limits::max)())) + { + return 'l'; + } + if (j.m_value.number_unsigned <= static_cast((std::numeric_limits::max)())) + { + return 'L'; + } + // anything else is treated as high-precision number + return 'H'; // LCOV_EXCL_LINE + } + + case value_t::number_float: + return get_ubjson_float_prefix(j.m_value.number_float); + + case value_t::string: + return 'S'; + + case value_t::array: // fallthrough + case value_t::binary: + return '['; + + case value_t::object: + return '{'; + + default: // discarded values + return 'N'; + } + } + + static constexpr CharType get_ubjson_float_prefix(float /*unused*/) + { + return 'd'; // float 32 + } + + static constexpr CharType get_ubjson_float_prefix(double /*unused*/) + { + return 'D'; // float 64 + } + + /////////////////////// + // Utility functions // + /////////////////////// + + /* + @brief write a number to output input + @param[in] n number of type @a NumberType + @tparam NumberType the type of the number + @tparam OutputIsLittleEndian Set to true if output data is + required to be little endian + + @note This function needs to respect the system's endianess, because bytes + in CBOR, MessagePack, and UBJSON are stored in network order (big + endian) and therefore need reordering on little endian systems. + */ + template + void write_number(const NumberType n) + { + // step 1: write number to array of length NumberType + std::array vec; + std::memcpy(vec.data(), &n, sizeof(NumberType)); + + // step 2: write array to output (with possible reordering) + if (is_little_endian != OutputIsLittleEndian) + { + // reverse byte order prior to conversion if necessary + std::reverse(vec.begin(), vec.end()); + } + + oa->write_characters(vec.data(), sizeof(NumberType)); + } + + void write_compact_float(const number_float_t n, detail::input_format_t format) + { + if (static_cast(n) >= static_cast(std::numeric_limits::lowest()) && + static_cast(n) <= static_cast((std::numeric_limits::max)()) && + static_cast(static_cast(n)) == static_cast(n)) + { + oa->write_character(format == detail::input_format_t::cbor + ? get_cbor_float_prefix(static_cast(n)) + : get_msgpack_float_prefix(static_cast(n))); + write_number(static_cast(n)); + } + else + { + oa->write_character(format == detail::input_format_t::cbor + ? get_cbor_float_prefix(n) + : get_msgpack_float_prefix(n)); + write_number(n); + } + } + + public: + // The following to_char_type functions are implement the conversion + // between uint8_t and CharType. In case CharType is not unsigned, + // such a conversion is required to allow values greater than 128. + // See for a discussion. + template < typename C = CharType, + enable_if_t < std::is_signed::value && std::is_signed::value > * = nullptr > + static constexpr CharType to_char_type(std::uint8_t x) noexcept + { + return *reinterpret_cast(&x); + } + + template < typename C = CharType, + enable_if_t < std::is_signed::value && std::is_unsigned::value > * = nullptr > + static CharType to_char_type(std::uint8_t x) noexcept + { + static_assert(sizeof(std::uint8_t) == sizeof(CharType), "size of CharType must be equal to std::uint8_t"); + static_assert(std::is_trivial::value, "CharType must be trivial"); + CharType result; + std::memcpy(&result, &x, sizeof(x)); + return result; + } + + template::value>* = nullptr> + static constexpr CharType to_char_type(std::uint8_t x) noexcept + { + return x; + } + + template < typename InputCharType, typename C = CharType, + enable_if_t < + std::is_signed::value && + std::is_signed::value && + std::is_same::type>::value + > * = nullptr > + static constexpr CharType to_char_type(InputCharType x) noexcept + { + return x; + } + + private: + /// whether we can assume little endianess + const bool is_little_endian = little_endianess(); + + /// the output + output_adapter_t oa = nullptr; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + + +#include // reverse, remove, fill, find, none_of +#include // array +#include // localeconv, lconv +#include // labs, isfinite, isnan, signbit +#include // size_t, ptrdiff_t +#include // uint8_t +#include // snprintf +#include // numeric_limits +#include // string, char_traits +#include // is_same +#include // move + +// #include + + +#include // array +#include // signbit, isfinite +#include // intN_t, uintN_t +#include // memcpy, memmove +#include // numeric_limits +#include // conditional + +// #include + + +namespace nlohmann +{ +namespace detail +{ + +/*! +@brief implements the Grisu2 algorithm for binary to decimal floating-point +conversion. + +This implementation is a slightly modified version of the reference +implementation which may be obtained from +http://florian.loitsch.com/publications (bench.tar.gz). + +The code is distributed under the MIT license, Copyright (c) 2009 Florian Loitsch. + +For a detailed description of the algorithm see: + +[1] Loitsch, "Printing Floating-Point Numbers Quickly and Accurately with + Integers", Proceedings of the ACM SIGPLAN 2010 Conference on Programming + Language Design and Implementation, PLDI 2010 +[2] Burger, Dybvig, "Printing Floating-Point Numbers Quickly and Accurately", + Proceedings of the ACM SIGPLAN 1996 Conference on Programming Language + Design and Implementation, PLDI 1996 +*/ +namespace dtoa_impl +{ + +template +Target reinterpret_bits(const Source source) +{ + static_assert(sizeof(Target) == sizeof(Source), "size mismatch"); + + Target target; + std::memcpy(&target, &source, sizeof(Source)); + return target; +} + +struct diyfp // f * 2^e +{ + static constexpr int kPrecision = 64; // = q + + std::uint64_t f = 0; + int e = 0; + + constexpr diyfp(std::uint64_t f_, int e_) noexcept : f(f_), e(e_) {} + + /*! + @brief returns x - y + @pre x.e == y.e and x.f >= y.f + */ + static diyfp sub(const diyfp& x, const diyfp& y) noexcept + { + JSON_ASSERT(x.e == y.e); + JSON_ASSERT(x.f >= y.f); + + return {x.f - y.f, x.e}; + } + + /*! + @brief returns x * y + @note The result is rounded. (Only the upper q bits are returned.) + */ + static diyfp mul(const diyfp& x, const diyfp& y) noexcept + { + static_assert(kPrecision == 64, "internal error"); + + // Computes: + // f = round((x.f * y.f) / 2^q) + // e = x.e + y.e + q + + // Emulate the 64-bit * 64-bit multiplication: + // + // p = u * v + // = (u_lo + 2^32 u_hi) (v_lo + 2^32 v_hi) + // = (u_lo v_lo ) + 2^32 ((u_lo v_hi ) + (u_hi v_lo )) + 2^64 (u_hi v_hi ) + // = (p0 ) + 2^32 ((p1 ) + (p2 )) + 2^64 (p3 ) + // = (p0_lo + 2^32 p0_hi) + 2^32 ((p1_lo + 2^32 p1_hi) + (p2_lo + 2^32 p2_hi)) + 2^64 (p3 ) + // = (p0_lo ) + 2^32 (p0_hi + p1_lo + p2_lo ) + 2^64 (p1_hi + p2_hi + p3) + // = (p0_lo ) + 2^32 (Q ) + 2^64 (H ) + // = (p0_lo ) + 2^32 (Q_lo + 2^32 Q_hi ) + 2^64 (H ) + // + // (Since Q might be larger than 2^32 - 1) + // + // = (p0_lo + 2^32 Q_lo) + 2^64 (Q_hi + H) + // + // (Q_hi + H does not overflow a 64-bit int) + // + // = p_lo + 2^64 p_hi + + const std::uint64_t u_lo = x.f & 0xFFFFFFFFu; + const std::uint64_t u_hi = x.f >> 32u; + const std::uint64_t v_lo = y.f & 0xFFFFFFFFu; + const std::uint64_t v_hi = y.f >> 32u; + + const std::uint64_t p0 = u_lo * v_lo; + const std::uint64_t p1 = u_lo * v_hi; + const std::uint64_t p2 = u_hi * v_lo; + const std::uint64_t p3 = u_hi * v_hi; + + const std::uint64_t p0_hi = p0 >> 32u; + const std::uint64_t p1_lo = p1 & 0xFFFFFFFFu; + const std::uint64_t p1_hi = p1 >> 32u; + const std::uint64_t p2_lo = p2 & 0xFFFFFFFFu; + const std::uint64_t p2_hi = p2 >> 32u; + + std::uint64_t Q = p0_hi + p1_lo + p2_lo; + + // The full product might now be computed as + // + // p_hi = p3 + p2_hi + p1_hi + (Q >> 32) + // p_lo = p0_lo + (Q << 32) + // + // But in this particular case here, the full p_lo is not required. + // Effectively we only need to add the highest bit in p_lo to p_hi (and + // Q_hi + 1 does not overflow). + + Q += std::uint64_t{1} << (64u - 32u - 1u); // round, ties up + + const std::uint64_t h = p3 + p2_hi + p1_hi + (Q >> 32u); + + return {h, x.e + y.e + 64}; + } + + /*! + @brief normalize x such that the significand is >= 2^(q-1) + @pre x.f != 0 + */ + static diyfp normalize(diyfp x) noexcept + { + JSON_ASSERT(x.f != 0); + + while ((x.f >> 63u) == 0) + { + x.f <<= 1u; + x.e--; + } + + return x; + } + + /*! + @brief normalize x such that the result has the exponent E + @pre e >= x.e and the upper e - x.e bits of x.f must be zero. + */ + static diyfp normalize_to(const diyfp& x, const int target_exponent) noexcept + { + const int delta = x.e - target_exponent; + + JSON_ASSERT(delta >= 0); + JSON_ASSERT(((x.f << delta) >> delta) == x.f); + + return {x.f << delta, target_exponent}; + } +}; + +struct boundaries +{ + diyfp w; + diyfp minus; + diyfp plus; +}; + +/*! +Compute the (normalized) diyfp representing the input number 'value' and its +boundaries. + +@pre value must be finite and positive +*/ +template +boundaries compute_boundaries(FloatType value) +{ + JSON_ASSERT(std::isfinite(value)); + JSON_ASSERT(value > 0); + + // Convert the IEEE representation into a diyfp. + // + // If v is denormal: + // value = 0.F * 2^(1 - bias) = ( F) * 2^(1 - bias - (p-1)) + // If v is normalized: + // value = 1.F * 2^(E - bias) = (2^(p-1) + F) * 2^(E - bias - (p-1)) + + static_assert(std::numeric_limits::is_iec559, + "internal error: dtoa_short requires an IEEE-754 floating-point implementation"); + + constexpr int kPrecision = std::numeric_limits::digits; // = p (includes the hidden bit) + constexpr int kBias = std::numeric_limits::max_exponent - 1 + (kPrecision - 1); + constexpr int kMinExp = 1 - kBias; + constexpr std::uint64_t kHiddenBit = std::uint64_t{1} << (kPrecision - 1); // = 2^(p-1) + + using bits_type = typename std::conditional::type; + + const std::uint64_t bits = reinterpret_bits(value); + const std::uint64_t E = bits >> (kPrecision - 1); + const std::uint64_t F = bits & (kHiddenBit - 1); + + const bool is_denormal = E == 0; + const diyfp v = is_denormal + ? diyfp(F, kMinExp) + : diyfp(F + kHiddenBit, static_cast(E) - kBias); + + // Compute the boundaries m- and m+ of the floating-point value + // v = f * 2^e. + // + // Determine v- and v+, the floating-point predecessor and successor if v, + // respectively. + // + // v- = v - 2^e if f != 2^(p-1) or e == e_min (A) + // = v - 2^(e-1) if f == 2^(p-1) and e > e_min (B) + // + // v+ = v + 2^e + // + // Let m- = (v- + v) / 2 and m+ = (v + v+) / 2. All real numbers _strictly_ + // between m- and m+ round to v, regardless of how the input rounding + // algorithm breaks ties. + // + // ---+-------------+-------------+-------------+-------------+--- (A) + // v- m- v m+ v+ + // + // -----------------+------+------+-------------+-------------+--- (B) + // v- m- v m+ v+ + + const bool lower_boundary_is_closer = F == 0 && E > 1; + const diyfp m_plus = diyfp(2 * v.f + 1, v.e - 1); + const diyfp m_minus = lower_boundary_is_closer + ? diyfp(4 * v.f - 1, v.e - 2) // (B) + : diyfp(2 * v.f - 1, v.e - 1); // (A) + + // Determine the normalized w+ = m+. + const diyfp w_plus = diyfp::normalize(m_plus); + + // Determine w- = m- such that e_(w-) = e_(w+). + const diyfp w_minus = diyfp::normalize_to(m_minus, w_plus.e); + + return {diyfp::normalize(v), w_minus, w_plus}; +} + +// Given normalized diyfp w, Grisu needs to find a (normalized) cached +// power-of-ten c, such that the exponent of the product c * w = f * 2^e lies +// within a certain range [alpha, gamma] (Definition 3.2 from [1]) +// +// alpha <= e = e_c + e_w + q <= gamma +// +// or +// +// f_c * f_w * 2^alpha <= f_c 2^(e_c) * f_w 2^(e_w) * 2^q +// <= f_c * f_w * 2^gamma +// +// Since c and w are normalized, i.e. 2^(q-1) <= f < 2^q, this implies +// +// 2^(q-1) * 2^(q-1) * 2^alpha <= c * w * 2^q < 2^q * 2^q * 2^gamma +// +// or +// +// 2^(q - 2 + alpha) <= c * w < 2^(q + gamma) +// +// The choice of (alpha,gamma) determines the size of the table and the form of +// the digit generation procedure. Using (alpha,gamma)=(-60,-32) works out well +// in practice: +// +// The idea is to cut the number c * w = f * 2^e into two parts, which can be +// processed independently: An integral part p1, and a fractional part p2: +// +// f * 2^e = ( (f div 2^-e) * 2^-e + (f mod 2^-e) ) * 2^e +// = (f div 2^-e) + (f mod 2^-e) * 2^e +// = p1 + p2 * 2^e +// +// The conversion of p1 into decimal form requires a series of divisions and +// modulos by (a power of) 10. These operations are faster for 32-bit than for +// 64-bit integers, so p1 should ideally fit into a 32-bit integer. This can be +// achieved by choosing +// +// -e >= 32 or e <= -32 := gamma +// +// In order to convert the fractional part +// +// p2 * 2^e = p2 / 2^-e = d[-1] / 10^1 + d[-2] / 10^2 + ... +// +// into decimal form, the fraction is repeatedly multiplied by 10 and the digits +// d[-i] are extracted in order: +// +// (10 * p2) div 2^-e = d[-1] +// (10 * p2) mod 2^-e = d[-2] / 10^1 + ... +// +// The multiplication by 10 must not overflow. It is sufficient to choose +// +// 10 * p2 < 16 * p2 = 2^4 * p2 <= 2^64. +// +// Since p2 = f mod 2^-e < 2^-e, +// +// -e <= 60 or e >= -60 := alpha + +constexpr int kAlpha = -60; +constexpr int kGamma = -32; + +struct cached_power // c = f * 2^e ~= 10^k +{ + std::uint64_t f; + int e; + int k; +}; + +/*! +For a normalized diyfp w = f * 2^e, this function returns a (normalized) cached +power-of-ten c = f_c * 2^e_c, such that the exponent of the product w * c +satisfies (Definition 3.2 from [1]) + + alpha <= e_c + e + q <= gamma. +*/ +inline cached_power get_cached_power_for_binary_exponent(int e) +{ + // Now + // + // alpha <= e_c + e + q <= gamma (1) + // ==> f_c * 2^alpha <= c * 2^e * 2^q + // + // and since the c's are normalized, 2^(q-1) <= f_c, + // + // ==> 2^(q - 1 + alpha) <= c * 2^(e + q) + // ==> 2^(alpha - e - 1) <= c + // + // If c were an exact power of ten, i.e. c = 10^k, one may determine k as + // + // k = ceil( log_10( 2^(alpha - e - 1) ) ) + // = ceil( (alpha - e - 1) * log_10(2) ) + // + // From the paper: + // "In theory the result of the procedure could be wrong since c is rounded, + // and the computation itself is approximated [...]. In practice, however, + // this simple function is sufficient." + // + // For IEEE double precision floating-point numbers converted into + // normalized diyfp's w = f * 2^e, with q = 64, + // + // e >= -1022 (min IEEE exponent) + // -52 (p - 1) + // -52 (p - 1, possibly normalize denormal IEEE numbers) + // -11 (normalize the diyfp) + // = -1137 + // + // and + // + // e <= +1023 (max IEEE exponent) + // -52 (p - 1) + // -11 (normalize the diyfp) + // = 960 + // + // This binary exponent range [-1137,960] results in a decimal exponent + // range [-307,324]. One does not need to store a cached power for each + // k in this range. For each such k it suffices to find a cached power + // such that the exponent of the product lies in [alpha,gamma]. + // This implies that the difference of the decimal exponents of adjacent + // table entries must be less than or equal to + // + // floor( (gamma - alpha) * log_10(2) ) = 8. + // + // (A smaller distance gamma-alpha would require a larger table.) + + // NB: + // Actually this function returns c, such that -60 <= e_c + e + 64 <= -34. + + constexpr int kCachedPowersMinDecExp = -300; + constexpr int kCachedPowersDecStep = 8; + + static constexpr std::array kCachedPowers = + { + { + { 0xAB70FE17C79AC6CA, -1060, -300 }, + { 0xFF77B1FCBEBCDC4F, -1034, -292 }, + { 0xBE5691EF416BD60C, -1007, -284 }, + { 0x8DD01FAD907FFC3C, -980, -276 }, + { 0xD3515C2831559A83, -954, -268 }, + { 0x9D71AC8FADA6C9B5, -927, -260 }, + { 0xEA9C227723EE8BCB, -901, -252 }, + { 0xAECC49914078536D, -874, -244 }, + { 0x823C12795DB6CE57, -847, -236 }, + { 0xC21094364DFB5637, -821, -228 }, + { 0x9096EA6F3848984F, -794, -220 }, + { 0xD77485CB25823AC7, -768, -212 }, + { 0xA086CFCD97BF97F4, -741, -204 }, + { 0xEF340A98172AACE5, -715, -196 }, + { 0xB23867FB2A35B28E, -688, -188 }, + { 0x84C8D4DFD2C63F3B, -661, -180 }, + { 0xC5DD44271AD3CDBA, -635, -172 }, + { 0x936B9FCEBB25C996, -608, -164 }, + { 0xDBAC6C247D62A584, -582, -156 }, + { 0xA3AB66580D5FDAF6, -555, -148 }, + { 0xF3E2F893DEC3F126, -529, -140 }, + { 0xB5B5ADA8AAFF80B8, -502, -132 }, + { 0x87625F056C7C4A8B, -475, -124 }, + { 0xC9BCFF6034C13053, -449, -116 }, + { 0x964E858C91BA2655, -422, -108 }, + { 0xDFF9772470297EBD, -396, -100 }, + { 0xA6DFBD9FB8E5B88F, -369, -92 }, + { 0xF8A95FCF88747D94, -343, -84 }, + { 0xB94470938FA89BCF, -316, -76 }, + { 0x8A08F0F8BF0F156B, -289, -68 }, + { 0xCDB02555653131B6, -263, -60 }, + { 0x993FE2C6D07B7FAC, -236, -52 }, + { 0xE45C10C42A2B3B06, -210, -44 }, + { 0xAA242499697392D3, -183, -36 }, + { 0xFD87B5F28300CA0E, -157, -28 }, + { 0xBCE5086492111AEB, -130, -20 }, + { 0x8CBCCC096F5088CC, -103, -12 }, + { 0xD1B71758E219652C, -77, -4 }, + { 0x9C40000000000000, -50, 4 }, + { 0xE8D4A51000000000, -24, 12 }, + { 0xAD78EBC5AC620000, 3, 20 }, + { 0x813F3978F8940984, 30, 28 }, + { 0xC097CE7BC90715B3, 56, 36 }, + { 0x8F7E32CE7BEA5C70, 83, 44 }, + { 0xD5D238A4ABE98068, 109, 52 }, + { 0x9F4F2726179A2245, 136, 60 }, + { 0xED63A231D4C4FB27, 162, 68 }, + { 0xB0DE65388CC8ADA8, 189, 76 }, + { 0x83C7088E1AAB65DB, 216, 84 }, + { 0xC45D1DF942711D9A, 242, 92 }, + { 0x924D692CA61BE758, 269, 100 }, + { 0xDA01EE641A708DEA, 295, 108 }, + { 0xA26DA3999AEF774A, 322, 116 }, + { 0xF209787BB47D6B85, 348, 124 }, + { 0xB454E4A179DD1877, 375, 132 }, + { 0x865B86925B9BC5C2, 402, 140 }, + { 0xC83553C5C8965D3D, 428, 148 }, + { 0x952AB45CFA97A0B3, 455, 156 }, + { 0xDE469FBD99A05FE3, 481, 164 }, + { 0xA59BC234DB398C25, 508, 172 }, + { 0xF6C69A72A3989F5C, 534, 180 }, + { 0xB7DCBF5354E9BECE, 561, 188 }, + { 0x88FCF317F22241E2, 588, 196 }, + { 0xCC20CE9BD35C78A5, 614, 204 }, + { 0x98165AF37B2153DF, 641, 212 }, + { 0xE2A0B5DC971F303A, 667, 220 }, + { 0xA8D9D1535CE3B396, 694, 228 }, + { 0xFB9B7CD9A4A7443C, 720, 236 }, + { 0xBB764C4CA7A44410, 747, 244 }, + { 0x8BAB8EEFB6409C1A, 774, 252 }, + { 0xD01FEF10A657842C, 800, 260 }, + { 0x9B10A4E5E9913129, 827, 268 }, + { 0xE7109BFBA19C0C9D, 853, 276 }, + { 0xAC2820D9623BF429, 880, 284 }, + { 0x80444B5E7AA7CF85, 907, 292 }, + { 0xBF21E44003ACDD2D, 933, 300 }, + { 0x8E679C2F5E44FF8F, 960, 308 }, + { 0xD433179D9C8CB841, 986, 316 }, + { 0x9E19DB92B4E31BA9, 1013, 324 }, + } + }; + + // This computation gives exactly the same results for k as + // k = ceil((kAlpha - e - 1) * 0.30102999566398114) + // for |e| <= 1500, but doesn't require floating-point operations. + // NB: log_10(2) ~= 78913 / 2^18 + JSON_ASSERT(e >= -1500); + JSON_ASSERT(e <= 1500); + const int f = kAlpha - e - 1; + const int k = (f * 78913) / (1 << 18) + static_cast(f > 0); + + const int index = (-kCachedPowersMinDecExp + k + (kCachedPowersDecStep - 1)) / kCachedPowersDecStep; + JSON_ASSERT(index >= 0); + JSON_ASSERT(static_cast(index) < kCachedPowers.size()); + + const cached_power cached = kCachedPowers[static_cast(index)]; + JSON_ASSERT(kAlpha <= cached.e + e + 64); + JSON_ASSERT(kGamma >= cached.e + e + 64); + + return cached; +} + +/*! +For n != 0, returns k, such that pow10 := 10^(k-1) <= n < 10^k. +For n == 0, returns 1 and sets pow10 := 1. +*/ +inline int find_largest_pow10(const std::uint32_t n, std::uint32_t& pow10) +{ + // LCOV_EXCL_START + if (n >= 1000000000) + { + pow10 = 1000000000; + return 10; + } + // LCOV_EXCL_STOP + else if (n >= 100000000) + { + pow10 = 100000000; + return 9; + } + else if (n >= 10000000) + { + pow10 = 10000000; + return 8; + } + else if (n >= 1000000) + { + pow10 = 1000000; + return 7; + } + else if (n >= 100000) + { + pow10 = 100000; + return 6; + } + else if (n >= 10000) + { + pow10 = 10000; + return 5; + } + else if (n >= 1000) + { + pow10 = 1000; + return 4; + } + else if (n >= 100) + { + pow10 = 100; + return 3; + } + else if (n >= 10) + { + pow10 = 10; + return 2; + } + else + { + pow10 = 1; + return 1; + } +} + +inline void grisu2_round(char* buf, int len, std::uint64_t dist, std::uint64_t delta, + std::uint64_t rest, std::uint64_t ten_k) +{ + JSON_ASSERT(len >= 1); + JSON_ASSERT(dist <= delta); + JSON_ASSERT(rest <= delta); + JSON_ASSERT(ten_k > 0); + + // <--------------------------- delta ----> + // <---- dist ---------> + // --------------[------------------+-------------------]-------------- + // M- w M+ + // + // ten_k + // <------> + // <---- rest ----> + // --------------[------------------+----+--------------]-------------- + // w V + // = buf * 10^k + // + // ten_k represents a unit-in-the-last-place in the decimal representation + // stored in buf. + // Decrement buf by ten_k while this takes buf closer to w. + + // The tests are written in this order to avoid overflow in unsigned + // integer arithmetic. + + while (rest < dist + && delta - rest >= ten_k + && (rest + ten_k < dist || dist - rest > rest + ten_k - dist)) + { + JSON_ASSERT(buf[len - 1] != '0'); + buf[len - 1]--; + rest += ten_k; + } +} + +/*! +Generates V = buffer * 10^decimal_exponent, such that M- <= V <= M+. +M- and M+ must be normalized and share the same exponent -60 <= e <= -32. +*/ +inline void grisu2_digit_gen(char* buffer, int& length, int& decimal_exponent, + diyfp M_minus, diyfp w, diyfp M_plus) +{ + static_assert(kAlpha >= -60, "internal error"); + static_assert(kGamma <= -32, "internal error"); + + // Generates the digits (and the exponent) of a decimal floating-point + // number V = buffer * 10^decimal_exponent in the range [M-, M+]. The diyfp's + // w, M- and M+ share the same exponent e, which satisfies alpha <= e <= gamma. + // + // <--------------------------- delta ----> + // <---- dist ---------> + // --------------[------------------+-------------------]-------------- + // M- w M+ + // + // Grisu2 generates the digits of M+ from left to right and stops as soon as + // V is in [M-,M+]. + + JSON_ASSERT(M_plus.e >= kAlpha); + JSON_ASSERT(M_plus.e <= kGamma); + + std::uint64_t delta = diyfp::sub(M_plus, M_minus).f; // (significand of (M+ - M-), implicit exponent is e) + std::uint64_t dist = diyfp::sub(M_plus, w ).f; // (significand of (M+ - w ), implicit exponent is e) + + // Split M+ = f * 2^e into two parts p1 and p2 (note: e < 0): + // + // M+ = f * 2^e + // = ((f div 2^-e) * 2^-e + (f mod 2^-e)) * 2^e + // = ((p1 ) * 2^-e + (p2 )) * 2^e + // = p1 + p2 * 2^e + + const diyfp one(std::uint64_t{1} << -M_plus.e, M_plus.e); + + auto p1 = static_cast(M_plus.f >> -one.e); // p1 = f div 2^-e (Since -e >= 32, p1 fits into a 32-bit int.) + std::uint64_t p2 = M_plus.f & (one.f - 1); // p2 = f mod 2^-e + + // 1) + // + // Generate the digits of the integral part p1 = d[n-1]...d[1]d[0] + + JSON_ASSERT(p1 > 0); + + std::uint32_t pow10; + const int k = find_largest_pow10(p1, pow10); + + // 10^(k-1) <= p1 < 10^k, pow10 = 10^(k-1) + // + // p1 = (p1 div 10^(k-1)) * 10^(k-1) + (p1 mod 10^(k-1)) + // = (d[k-1] ) * 10^(k-1) + (p1 mod 10^(k-1)) + // + // M+ = p1 + p2 * 2^e + // = d[k-1] * 10^(k-1) + (p1 mod 10^(k-1)) + p2 * 2^e + // = d[k-1] * 10^(k-1) + ((p1 mod 10^(k-1)) * 2^-e + p2) * 2^e + // = d[k-1] * 10^(k-1) + ( rest) * 2^e + // + // Now generate the digits d[n] of p1 from left to right (n = k-1,...,0) + // + // p1 = d[k-1]...d[n] * 10^n + d[n-1]...d[0] + // + // but stop as soon as + // + // rest * 2^e = (d[n-1]...d[0] * 2^-e + p2) * 2^e <= delta * 2^e + + int n = k; + while (n > 0) + { + // Invariants: + // M+ = buffer * 10^n + (p1 + p2 * 2^e) (buffer = 0 for n = k) + // pow10 = 10^(n-1) <= p1 < 10^n + // + const std::uint32_t d = p1 / pow10; // d = p1 div 10^(n-1) + const std::uint32_t r = p1 % pow10; // r = p1 mod 10^(n-1) + // + // M+ = buffer * 10^n + (d * 10^(n-1) + r) + p2 * 2^e + // = (buffer * 10 + d) * 10^(n-1) + (r + p2 * 2^e) + // + JSON_ASSERT(d <= 9); + buffer[length++] = static_cast('0' + d); // buffer := buffer * 10 + d + // + // M+ = buffer * 10^(n-1) + (r + p2 * 2^e) + // + p1 = r; + n--; + // + // M+ = buffer * 10^n + (p1 + p2 * 2^e) + // pow10 = 10^n + // + + // Now check if enough digits have been generated. + // Compute + // + // p1 + p2 * 2^e = (p1 * 2^-e + p2) * 2^e = rest * 2^e + // + // Note: + // Since rest and delta share the same exponent e, it suffices to + // compare the significands. + const std::uint64_t rest = (std::uint64_t{p1} << -one.e) + p2; + if (rest <= delta) + { + // V = buffer * 10^n, with M- <= V <= M+. + + decimal_exponent += n; + + // We may now just stop. But instead look if the buffer could be + // decremented to bring V closer to w. + // + // pow10 = 10^n is now 1 ulp in the decimal representation V. + // The rounding procedure works with diyfp's with an implicit + // exponent of e. + // + // 10^n = (10^n * 2^-e) * 2^e = ulp * 2^e + // + const std::uint64_t ten_n = std::uint64_t{pow10} << -one.e; + grisu2_round(buffer, length, dist, delta, rest, ten_n); + + return; + } + + pow10 /= 10; + // + // pow10 = 10^(n-1) <= p1 < 10^n + // Invariants restored. + } + + // 2) + // + // The digits of the integral part have been generated: + // + // M+ = d[k-1]...d[1]d[0] + p2 * 2^e + // = buffer + p2 * 2^e + // + // Now generate the digits of the fractional part p2 * 2^e. + // + // Note: + // No decimal point is generated: the exponent is adjusted instead. + // + // p2 actually represents the fraction + // + // p2 * 2^e + // = p2 / 2^-e + // = d[-1] / 10^1 + d[-2] / 10^2 + ... + // + // Now generate the digits d[-m] of p1 from left to right (m = 1,2,...) + // + // p2 * 2^e = d[-1]d[-2]...d[-m] * 10^-m + // + 10^-m * (d[-m-1] / 10^1 + d[-m-2] / 10^2 + ...) + // + // using + // + // 10^m * p2 = ((10^m * p2) div 2^-e) * 2^-e + ((10^m * p2) mod 2^-e) + // = ( d) * 2^-e + ( r) + // + // or + // 10^m * p2 * 2^e = d + r * 2^e + // + // i.e. + // + // M+ = buffer + p2 * 2^e + // = buffer + 10^-m * (d + r * 2^e) + // = (buffer * 10^m + d) * 10^-m + 10^-m * r * 2^e + // + // and stop as soon as 10^-m * r * 2^e <= delta * 2^e + + JSON_ASSERT(p2 > delta); + + int m = 0; + for (;;) + { + // Invariant: + // M+ = buffer * 10^-m + 10^-m * (d[-m-1] / 10 + d[-m-2] / 10^2 + ...) * 2^e + // = buffer * 10^-m + 10^-m * (p2 ) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * (10 * p2) ) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * ((10*p2 div 2^-e) * 2^-e + (10*p2 mod 2^-e)) * 2^e + // + JSON_ASSERT(p2 <= (std::numeric_limits::max)() / 10); + p2 *= 10; + const std::uint64_t d = p2 >> -one.e; // d = (10 * p2) div 2^-e + const std::uint64_t r = p2 & (one.f - 1); // r = (10 * p2) mod 2^-e + // + // M+ = buffer * 10^-m + 10^-m * (1/10 * (d * 2^-e + r) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * (d + r * 2^e)) + // = (buffer * 10 + d) * 10^(-m-1) + 10^(-m-1) * r * 2^e + // + JSON_ASSERT(d <= 9); + buffer[length++] = static_cast('0' + d); // buffer := buffer * 10 + d + // + // M+ = buffer * 10^(-m-1) + 10^(-m-1) * r * 2^e + // + p2 = r; + m++; + // + // M+ = buffer * 10^-m + 10^-m * p2 * 2^e + // Invariant restored. + + // Check if enough digits have been generated. + // + // 10^-m * p2 * 2^e <= delta * 2^e + // p2 * 2^e <= 10^m * delta * 2^e + // p2 <= 10^m * delta + delta *= 10; + dist *= 10; + if (p2 <= delta) + { + break; + } + } + + // V = buffer * 10^-m, with M- <= V <= M+. + + decimal_exponent -= m; + + // 1 ulp in the decimal representation is now 10^-m. + // Since delta and dist are now scaled by 10^m, we need to do the + // same with ulp in order to keep the units in sync. + // + // 10^m * 10^-m = 1 = 2^-e * 2^e = ten_m * 2^e + // + const std::uint64_t ten_m = one.f; + grisu2_round(buffer, length, dist, delta, p2, ten_m); + + // By construction this algorithm generates the shortest possible decimal + // number (Loitsch, Theorem 6.2) which rounds back to w. + // For an input number of precision p, at least + // + // N = 1 + ceil(p * log_10(2)) + // + // decimal digits are sufficient to identify all binary floating-point + // numbers (Matula, "In-and-Out conversions"). + // This implies that the algorithm does not produce more than N decimal + // digits. + // + // N = 17 for p = 53 (IEEE double precision) + // N = 9 for p = 24 (IEEE single precision) +} + +/*! +v = buf * 10^decimal_exponent +len is the length of the buffer (number of decimal digits) +The buffer must be large enough, i.e. >= max_digits10. +*/ +JSON_HEDLEY_NON_NULL(1) +inline void grisu2(char* buf, int& len, int& decimal_exponent, + diyfp m_minus, diyfp v, diyfp m_plus) +{ + JSON_ASSERT(m_plus.e == m_minus.e); + JSON_ASSERT(m_plus.e == v.e); + + // --------(-----------------------+-----------------------)-------- (A) + // m- v m+ + // + // --------------------(-----------+-----------------------)-------- (B) + // m- v m+ + // + // First scale v (and m- and m+) such that the exponent is in the range + // [alpha, gamma]. + + const cached_power cached = get_cached_power_for_binary_exponent(m_plus.e); + + const diyfp c_minus_k(cached.f, cached.e); // = c ~= 10^-k + + // The exponent of the products is = v.e + c_minus_k.e + q and is in the range [alpha,gamma] + const diyfp w = diyfp::mul(v, c_minus_k); + const diyfp w_minus = diyfp::mul(m_minus, c_minus_k); + const diyfp w_plus = diyfp::mul(m_plus, c_minus_k); + + // ----(---+---)---------------(---+---)---------------(---+---)---- + // w- w w+ + // = c*m- = c*v = c*m+ + // + // diyfp::mul rounds its result and c_minus_k is approximated too. w, w- and + // w+ are now off by a small amount. + // In fact: + // + // w - v * 10^k < 1 ulp + // + // To account for this inaccuracy, add resp. subtract 1 ulp. + // + // --------+---[---------------(---+---)---------------]---+-------- + // w- M- w M+ w+ + // + // Now any number in [M-, M+] (bounds included) will round to w when input, + // regardless of how the input rounding algorithm breaks ties. + // + // And digit_gen generates the shortest possible such number in [M-, M+]. + // Note that this does not mean that Grisu2 always generates the shortest + // possible number in the interval (m-, m+). + const diyfp M_minus(w_minus.f + 1, w_minus.e); + const diyfp M_plus (w_plus.f - 1, w_plus.e ); + + decimal_exponent = -cached.k; // = -(-k) = k + + grisu2_digit_gen(buf, len, decimal_exponent, M_minus, w, M_plus); +} + +/*! +v = buf * 10^decimal_exponent +len is the length of the buffer (number of decimal digits) +The buffer must be large enough, i.e. >= max_digits10. +*/ +template +JSON_HEDLEY_NON_NULL(1) +void grisu2(char* buf, int& len, int& decimal_exponent, FloatType value) +{ + static_assert(diyfp::kPrecision >= std::numeric_limits::digits + 3, + "internal error: not enough precision"); + + JSON_ASSERT(std::isfinite(value)); + JSON_ASSERT(value > 0); + + // If the neighbors (and boundaries) of 'value' are always computed for double-precision + // numbers, all float's can be recovered using strtod (and strtof). However, the resulting + // decimal representations are not exactly "short". + // + // The documentation for 'std::to_chars' (https://en.cppreference.com/w/cpp/utility/to_chars) + // says "value is converted to a string as if by std::sprintf in the default ("C") locale" + // and since sprintf promotes float's to double's, I think this is exactly what 'std::to_chars' + // does. + // On the other hand, the documentation for 'std::to_chars' requires that "parsing the + // representation using the corresponding std::from_chars function recovers value exactly". That + // indicates that single precision floating-point numbers should be recovered using + // 'std::strtof'. + // + // NB: If the neighbors are computed for single-precision numbers, there is a single float + // (7.0385307e-26f) which can't be recovered using strtod. The resulting double precision + // value is off by 1 ulp. +#if 0 + const boundaries w = compute_boundaries(static_cast(value)); +#else + const boundaries w = compute_boundaries(value); +#endif + + grisu2(buf, len, decimal_exponent, w.minus, w.w, w.plus); +} + +/*! +@brief appends a decimal representation of e to buf +@return a pointer to the element following the exponent. +@pre -1000 < e < 1000 +*/ +JSON_HEDLEY_NON_NULL(1) +JSON_HEDLEY_RETURNS_NON_NULL +inline char* append_exponent(char* buf, int e) +{ + JSON_ASSERT(e > -1000); + JSON_ASSERT(e < 1000); + + if (e < 0) + { + e = -e; + *buf++ = '-'; + } + else + { + *buf++ = '+'; + } + + auto k = static_cast(e); + if (k < 10) + { + // Always print at least two digits in the exponent. + // This is for compatibility with printf("%g"). + *buf++ = '0'; + *buf++ = static_cast('0' + k); + } + else if (k < 100) + { + *buf++ = static_cast('0' + k / 10); + k %= 10; + *buf++ = static_cast('0' + k); + } + else + { + *buf++ = static_cast('0' + k / 100); + k %= 100; + *buf++ = static_cast('0' + k / 10); + k %= 10; + *buf++ = static_cast('0' + k); + } + + return buf; +} + +/*! +@brief prettify v = buf * 10^decimal_exponent + +If v is in the range [10^min_exp, 10^max_exp) it will be printed in fixed-point +notation. Otherwise it will be printed in exponential notation. + +@pre min_exp < 0 +@pre max_exp > 0 +*/ +JSON_HEDLEY_NON_NULL(1) +JSON_HEDLEY_RETURNS_NON_NULL +inline char* format_buffer(char* buf, int len, int decimal_exponent, + int min_exp, int max_exp) +{ + JSON_ASSERT(min_exp < 0); + JSON_ASSERT(max_exp > 0); + + const int k = len; + const int n = len + decimal_exponent; + + // v = buf * 10^(n-k) + // k is the length of the buffer (number of decimal digits) + // n is the position of the decimal point relative to the start of the buffer. + + if (k <= n && n <= max_exp) + { + // digits[000] + // len <= max_exp + 2 + + std::memset(buf + k, '0', static_cast(n) - static_cast(k)); + // Make it look like a floating-point number (#362, #378) + buf[n + 0] = '.'; + buf[n + 1] = '0'; + return buf + (static_cast(n) + 2); + } + + if (0 < n && n <= max_exp) + { + // dig.its + // len <= max_digits10 + 1 + + JSON_ASSERT(k > n); + + std::memmove(buf + (static_cast(n) + 1), buf + n, static_cast(k) - static_cast(n)); + buf[n] = '.'; + return buf + (static_cast(k) + 1U); + } + + if (min_exp < n && n <= 0) + { + // 0.[000]digits + // len <= 2 + (-min_exp - 1) + max_digits10 + + std::memmove(buf + (2 + static_cast(-n)), buf, static_cast(k)); + buf[0] = '0'; + buf[1] = '.'; + std::memset(buf + 2, '0', static_cast(-n)); + return buf + (2U + static_cast(-n) + static_cast(k)); + } + + if (k == 1) + { + // dE+123 + // len <= 1 + 5 + + buf += 1; + } + else + { + // d.igitsE+123 + // len <= max_digits10 + 1 + 5 + + std::memmove(buf + 2, buf + 1, static_cast(k) - 1); + buf[1] = '.'; + buf += 1 + static_cast(k); + } + + *buf++ = 'e'; + return append_exponent(buf, n - 1); +} + +} // namespace dtoa_impl + +/*! +@brief generates a decimal representation of the floating-point number value in [first, last). + +The format of the resulting decimal representation is similar to printf's %g +format. Returns an iterator pointing past-the-end of the decimal representation. + +@note The input number must be finite, i.e. NaN's and Inf's are not supported. +@note The buffer must be large enough. +@note The result is NOT null-terminated. +*/ +template +JSON_HEDLEY_NON_NULL(1, 2) +JSON_HEDLEY_RETURNS_NON_NULL +char* to_chars(char* first, const char* last, FloatType value) +{ + static_cast(last); // maybe unused - fix warning + JSON_ASSERT(std::isfinite(value)); + + // Use signbit(value) instead of (value < 0) since signbit works for -0. + if (std::signbit(value)) + { + value = -value; + *first++ = '-'; + } + + if (value == 0) // +-0 + { + *first++ = '0'; + // Make it look like a floating-point number (#362, #378) + *first++ = '.'; + *first++ = '0'; + return first; + } + + JSON_ASSERT(last - first >= std::numeric_limits::max_digits10); + + // Compute v = buffer * 10^decimal_exponent. + // The decimal digits are stored in the buffer, which needs to be interpreted + // as an unsigned decimal integer. + // len is the length of the buffer, i.e. the number of decimal digits. + int len = 0; + int decimal_exponent = 0; + dtoa_impl::grisu2(first, len, decimal_exponent, value); + + JSON_ASSERT(len <= std::numeric_limits::max_digits10); + + // Format the buffer like printf("%.*g", prec, value) + constexpr int kMinExp = -4; + // Use digits10 here to increase compatibility with version 2. + constexpr int kMaxExp = std::numeric_limits::digits10; + + JSON_ASSERT(last - first >= kMaxExp + 2); + JSON_ASSERT(last - first >= 2 + (-kMinExp - 1) + std::numeric_limits::max_digits10); + JSON_ASSERT(last - first >= std::numeric_limits::max_digits10 + 6); + + return dtoa_impl::format_buffer(first, len, decimal_exponent, kMinExp, kMaxExp); +} + +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + +// #include + +// #include + +// #include + +// #include + + +namespace nlohmann +{ +namespace detail +{ +/////////////////// +// serialization // +/////////////////// + +/// how to treat decoding errors +enum class error_handler_t +{ + strict, ///< throw a type_error exception in case of invalid UTF-8 + replace, ///< replace invalid UTF-8 sequences with U+FFFD + ignore ///< ignore invalid UTF-8 sequences +}; + +template +class serializer +{ + using string_t = typename BasicJsonType::string_t; + using number_float_t = typename BasicJsonType::number_float_t; + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using binary_char_t = typename BasicJsonType::binary_t::value_type; + static constexpr std::uint8_t UTF8_ACCEPT = 0; + static constexpr std::uint8_t UTF8_REJECT = 1; + + public: + /*! + @param[in] s output stream to serialize to + @param[in] ichar indentation character to use + @param[in] error_handler_ how to react on decoding errors + */ + serializer(output_adapter_t s, const char ichar, + error_handler_t error_handler_ = error_handler_t::strict) + : o(std::move(s)) + , loc(std::localeconv()) + , thousands_sep(loc->thousands_sep == nullptr ? '\0' : std::char_traits::to_char_type(* (loc->thousands_sep))) + , decimal_point(loc->decimal_point == nullptr ? '\0' : std::char_traits::to_char_type(* (loc->decimal_point))) + , indent_char(ichar) + , indent_string(512, indent_char) + , error_handler(error_handler_) + {} + + // delete because of pointer members + serializer(const serializer&) = delete; + serializer& operator=(const serializer&) = delete; + serializer(serializer&&) = delete; + serializer& operator=(serializer&&) = delete; + ~serializer() = default; + + /*! + @brief internal implementation of the serialization function + + This function is called by the public member function dump and organizes + the serialization internally. The indentation level is propagated as + additional parameter. In case of arrays and objects, the function is + called recursively. + + - strings and object keys are escaped using `escape_string()` + - integer numbers are converted implicitly via `operator<<` + - floating-point numbers are converted to a string using `"%g"` format + - binary values are serialized as objects containing the subtype and the + byte array + + @param[in] val value to serialize + @param[in] pretty_print whether the output shall be pretty-printed + @param[in] ensure_ascii If @a ensure_ascii is true, all non-ASCII characters + in the output are escaped with `\uXXXX` sequences, and the result consists + of ASCII characters only. + @param[in] indent_step the indent level + @param[in] current_indent the current indent level (only used internally) + */ + void dump(const BasicJsonType& val, + const bool pretty_print, + const bool ensure_ascii, + const unsigned int indent_step, + const unsigned int current_indent = 0) + { + switch (val.m_type) + { + case value_t::object: + { + if (val.m_value.object->empty()) + { + o->write_characters("{}", 2); + return; + } + + if (pretty_print) + { + o->write_characters("{\n", 2); + + // variable to hold indentation for recursive calls + const auto new_indent = current_indent + indent_step; + if (JSON_HEDLEY_UNLIKELY(indent_string.size() < new_indent)) + { + indent_string.resize(indent_string.size() * 2, ' '); + } + + // first n-1 elements + auto i = val.m_value.object->cbegin(); + for (std::size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) + { + o->write_characters(indent_string.c_str(), new_indent); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\": ", 3); + dump(i->second, true, ensure_ascii, indent_step, new_indent); + o->write_characters(",\n", 2); + } + + // last element + JSON_ASSERT(i != val.m_value.object->cend()); + JSON_ASSERT(std::next(i) == val.m_value.object->cend()); + o->write_characters(indent_string.c_str(), new_indent); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\": ", 3); + dump(i->second, true, ensure_ascii, indent_step, new_indent); + + o->write_character('\n'); + o->write_characters(indent_string.c_str(), current_indent); + o->write_character('}'); + } + else + { + o->write_character('{'); + + // first n-1 elements + auto i = val.m_value.object->cbegin(); + for (std::size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) + { + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\":", 2); + dump(i->second, false, ensure_ascii, indent_step, current_indent); + o->write_character(','); + } + + // last element + JSON_ASSERT(i != val.m_value.object->cend()); + JSON_ASSERT(std::next(i) == val.m_value.object->cend()); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\":", 2); + dump(i->second, false, ensure_ascii, indent_step, current_indent); + + o->write_character('}'); + } + + return; + } + + case value_t::array: + { + if (val.m_value.array->empty()) + { + o->write_characters("[]", 2); + return; + } + + if (pretty_print) + { + o->write_characters("[\n", 2); + + // variable to hold indentation for recursive calls + const auto new_indent = current_indent + indent_step; + if (JSON_HEDLEY_UNLIKELY(indent_string.size() < new_indent)) + { + indent_string.resize(indent_string.size() * 2, ' '); + } + + // first n-1 elements + for (auto i = val.m_value.array->cbegin(); + i != val.m_value.array->cend() - 1; ++i) + { + o->write_characters(indent_string.c_str(), new_indent); + dump(*i, true, ensure_ascii, indent_step, new_indent); + o->write_characters(",\n", 2); + } + + // last element + JSON_ASSERT(!val.m_value.array->empty()); + o->write_characters(indent_string.c_str(), new_indent); + dump(val.m_value.array->back(), true, ensure_ascii, indent_step, new_indent); + + o->write_character('\n'); + o->write_characters(indent_string.c_str(), current_indent); + o->write_character(']'); + } + else + { + o->write_character('['); + + // first n-1 elements + for (auto i = val.m_value.array->cbegin(); + i != val.m_value.array->cend() - 1; ++i) + { + dump(*i, false, ensure_ascii, indent_step, current_indent); + o->write_character(','); + } + + // last element + JSON_ASSERT(!val.m_value.array->empty()); + dump(val.m_value.array->back(), false, ensure_ascii, indent_step, current_indent); + + o->write_character(']'); + } + + return; + } + + case value_t::string: + { + o->write_character('\"'); + dump_escaped(*val.m_value.string, ensure_ascii); + o->write_character('\"'); + return; + } + + case value_t::binary: + { + if (pretty_print) + { + o->write_characters("{\n", 2); + + // variable to hold indentation for recursive calls + const auto new_indent = current_indent + indent_step; + if (JSON_HEDLEY_UNLIKELY(indent_string.size() < new_indent)) + { + indent_string.resize(indent_string.size() * 2, ' '); + } + + o->write_characters(indent_string.c_str(), new_indent); + + o->write_characters("\"bytes\": [", 10); + + if (!val.m_value.binary->empty()) + { + for (auto i = val.m_value.binary->cbegin(); + i != val.m_value.binary->cend() - 1; ++i) + { + dump_integer(*i); + o->write_characters(", ", 2); + } + dump_integer(val.m_value.binary->back()); + } + + o->write_characters("],\n", 3); + o->write_characters(indent_string.c_str(), new_indent); + + o->write_characters("\"subtype\": ", 11); + if (val.m_value.binary->has_subtype()) + { + dump_integer(val.m_value.binary->subtype()); + } + else + { + o->write_characters("null", 4); + } + o->write_character('\n'); + o->write_characters(indent_string.c_str(), current_indent); + o->write_character('}'); + } + else + { + o->write_characters("{\"bytes\":[", 10); + + if (!val.m_value.binary->empty()) + { + for (auto i = val.m_value.binary->cbegin(); + i != val.m_value.binary->cend() - 1; ++i) + { + dump_integer(*i); + o->write_character(','); + } + dump_integer(val.m_value.binary->back()); + } + + o->write_characters("],\"subtype\":", 12); + if (val.m_value.binary->has_subtype()) + { + dump_integer(val.m_value.binary->subtype()); + o->write_character('}'); + } + else + { + o->write_characters("null}", 5); + } + } + return; + } + + case value_t::boolean: + { + if (val.m_value.boolean) + { + o->write_characters("true", 4); + } + else + { + o->write_characters("false", 5); + } + return; + } + + case value_t::number_integer: + { + dump_integer(val.m_value.number_integer); + return; + } + + case value_t::number_unsigned: + { + dump_integer(val.m_value.number_unsigned); + return; + } + + case value_t::number_float: + { + dump_float(val.m_value.number_float); + return; + } + + case value_t::discarded: + { + o->write_characters("", 11); + return; + } + + case value_t::null: + { + o->write_characters("null", 4); + return; + } + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + } + + private: + /*! + @brief dump escaped string + + Escape a string by replacing certain special characters by a sequence of an + escape character (backslash) and another character and other control + characters by a sequence of "\u" followed by a four-digit hex + representation. The escaped string is written to output stream @a o. + + @param[in] s the string to escape + @param[in] ensure_ascii whether to escape non-ASCII characters with + \uXXXX sequences + + @complexity Linear in the length of string @a s. + */ + void dump_escaped(const string_t& s, const bool ensure_ascii) + { + std::uint32_t codepoint; + std::uint8_t state = UTF8_ACCEPT; + std::size_t bytes = 0; // number of bytes written to string_buffer + + // number of bytes written at the point of the last valid byte + std::size_t bytes_after_last_accept = 0; + std::size_t undumped_chars = 0; + + for (std::size_t i = 0; i < s.size(); ++i) + { + const auto byte = static_cast(s[i]); + + switch (decode(state, codepoint, byte)) + { + case UTF8_ACCEPT: // decode found a new code point + { + switch (codepoint) + { + case 0x08: // backspace + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'b'; + break; + } + + case 0x09: // horizontal tab + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 't'; + break; + } + + case 0x0A: // newline + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'n'; + break; + } + + case 0x0C: // formfeed + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'f'; + break; + } + + case 0x0D: // carriage return + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'r'; + break; + } + + case 0x22: // quotation mark + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = '\"'; + break; + } + + case 0x5C: // reverse solidus + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = '\\'; + break; + } + + default: + { + // escape control characters (0x00..0x1F) or, if + // ensure_ascii parameter is used, non-ASCII characters + if ((codepoint <= 0x1F) || (ensure_ascii && (codepoint >= 0x7F))) + { + if (codepoint <= 0xFFFF) + { + (std::snprintf)(string_buffer.data() + bytes, 7, "\\u%04x", + static_cast(codepoint)); + bytes += 6; + } + else + { + (std::snprintf)(string_buffer.data() + bytes, 13, "\\u%04x\\u%04x", + static_cast(0xD7C0u + (codepoint >> 10u)), + static_cast(0xDC00u + (codepoint & 0x3FFu))); + bytes += 12; + } + } + else + { + // copy byte to buffer (all previous bytes + // been copied have in default case above) + string_buffer[bytes++] = s[i]; + } + break; + } + } + + // write buffer and reset index; there must be 13 bytes + // left, as this is the maximal number of bytes to be + // written ("\uxxxx\uxxxx\0") for one code point + if (string_buffer.size() - bytes < 13) + { + o->write_characters(string_buffer.data(), bytes); + bytes = 0; + } + + // remember the byte position of this accept + bytes_after_last_accept = bytes; + undumped_chars = 0; + break; + } + + case UTF8_REJECT: // decode found invalid UTF-8 byte + { + switch (error_handler) + { + case error_handler_t::strict: + { + std::string sn(3, '\0'); + (std::snprintf)(&sn[0], sn.size(), "%.2X", byte); + JSON_THROW(type_error::create(316, "invalid UTF-8 byte at index " + std::to_string(i) + ": 0x" + sn)); + } + + case error_handler_t::ignore: + case error_handler_t::replace: + { + // in case we saw this character the first time, we + // would like to read it again, because the byte + // may be OK for itself, but just not OK for the + // previous sequence + if (undumped_chars > 0) + { + --i; + } + + // reset length buffer to the last accepted index; + // thus removing/ignoring the invalid characters + bytes = bytes_after_last_accept; + + if (error_handler == error_handler_t::replace) + { + // add a replacement character + if (ensure_ascii) + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'u'; + string_buffer[bytes++] = 'f'; + string_buffer[bytes++] = 'f'; + string_buffer[bytes++] = 'f'; + string_buffer[bytes++] = 'd'; + } + else + { + string_buffer[bytes++] = detail::binary_writer::to_char_type('\xEF'); + string_buffer[bytes++] = detail::binary_writer::to_char_type('\xBF'); + string_buffer[bytes++] = detail::binary_writer::to_char_type('\xBD'); + } + + // write buffer and reset index; there must be 13 bytes + // left, as this is the maximal number of bytes to be + // written ("\uxxxx\uxxxx\0") for one code point + if (string_buffer.size() - bytes < 13) + { + o->write_characters(string_buffer.data(), bytes); + bytes = 0; + } + + bytes_after_last_accept = bytes; + } + + undumped_chars = 0; + + // continue processing the string + state = UTF8_ACCEPT; + break; + } + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + break; + } + + default: // decode found yet incomplete multi-byte code point + { + if (!ensure_ascii) + { + // code point will not be escaped - copy byte to buffer + string_buffer[bytes++] = s[i]; + } + ++undumped_chars; + break; + } + } + } + + // we finished processing the string + if (JSON_HEDLEY_LIKELY(state == UTF8_ACCEPT)) + { + // write buffer + if (bytes > 0) + { + o->write_characters(string_buffer.data(), bytes); + } + } + else + { + // we finish reading, but do not accept: string was incomplete + switch (error_handler) + { + case error_handler_t::strict: + { + std::string sn(3, '\0'); + (std::snprintf)(&sn[0], sn.size(), "%.2X", static_cast(s.back())); + JSON_THROW(type_error::create(316, "incomplete UTF-8 string; last byte: 0x" + sn)); + } + + case error_handler_t::ignore: + { + // write all accepted bytes + o->write_characters(string_buffer.data(), bytes_after_last_accept); + break; + } + + case error_handler_t::replace: + { + // write all accepted bytes + o->write_characters(string_buffer.data(), bytes_after_last_accept); + // add a replacement character + if (ensure_ascii) + { + o->write_characters("\\ufffd", 6); + } + else + { + o->write_characters("\xEF\xBF\xBD", 3); + } + break; + } + + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + } + } + + /*! + @brief count digits + + Count the number of decimal (base 10) digits for an input unsigned integer. + + @param[in] x unsigned integer number to count its digits + @return number of decimal digits + */ + inline unsigned int count_digits(number_unsigned_t x) noexcept + { + unsigned int n_digits = 1; + for (;;) + { + if (x < 10) + { + return n_digits; + } + if (x < 100) + { + return n_digits + 1; + } + if (x < 1000) + { + return n_digits + 2; + } + if (x < 10000) + { + return n_digits + 3; + } + x = x / 10000u; + n_digits += 4; + } + } + + /*! + @brief dump an integer + + Dump a given integer to output stream @a o. Works internally with + @a number_buffer. + + @param[in] x integer number (signed or unsigned) to dump + @tparam NumberType either @a number_integer_t or @a number_unsigned_t + */ + template < typename NumberType, detail::enable_if_t < + std::is_same::value || + std::is_same::value || + std::is_same::value, + int > = 0 > + void dump_integer(NumberType x) + { + static constexpr std::array, 100> digits_to_99 + { + { + {{'0', '0'}}, {{'0', '1'}}, {{'0', '2'}}, {{'0', '3'}}, {{'0', '4'}}, {{'0', '5'}}, {{'0', '6'}}, {{'0', '7'}}, {{'0', '8'}}, {{'0', '9'}}, + {{'1', '0'}}, {{'1', '1'}}, {{'1', '2'}}, {{'1', '3'}}, {{'1', '4'}}, {{'1', '5'}}, {{'1', '6'}}, {{'1', '7'}}, {{'1', '8'}}, {{'1', '9'}}, + {{'2', '0'}}, {{'2', '1'}}, {{'2', '2'}}, {{'2', '3'}}, {{'2', '4'}}, {{'2', '5'}}, {{'2', '6'}}, {{'2', '7'}}, {{'2', '8'}}, {{'2', '9'}}, + {{'3', '0'}}, {{'3', '1'}}, {{'3', '2'}}, {{'3', '3'}}, {{'3', '4'}}, {{'3', '5'}}, {{'3', '6'}}, {{'3', '7'}}, {{'3', '8'}}, {{'3', '9'}}, + {{'4', '0'}}, {{'4', '1'}}, {{'4', '2'}}, {{'4', '3'}}, {{'4', '4'}}, {{'4', '5'}}, {{'4', '6'}}, {{'4', '7'}}, {{'4', '8'}}, {{'4', '9'}}, + {{'5', '0'}}, {{'5', '1'}}, {{'5', '2'}}, {{'5', '3'}}, {{'5', '4'}}, {{'5', '5'}}, {{'5', '6'}}, {{'5', '7'}}, {{'5', '8'}}, {{'5', '9'}}, + {{'6', '0'}}, {{'6', '1'}}, {{'6', '2'}}, {{'6', '3'}}, {{'6', '4'}}, {{'6', '5'}}, {{'6', '6'}}, {{'6', '7'}}, {{'6', '8'}}, {{'6', '9'}}, + {{'7', '0'}}, {{'7', '1'}}, {{'7', '2'}}, {{'7', '3'}}, {{'7', '4'}}, {{'7', '5'}}, {{'7', '6'}}, {{'7', '7'}}, {{'7', '8'}}, {{'7', '9'}}, + {{'8', '0'}}, {{'8', '1'}}, {{'8', '2'}}, {{'8', '3'}}, {{'8', '4'}}, {{'8', '5'}}, {{'8', '6'}}, {{'8', '7'}}, {{'8', '8'}}, {{'8', '9'}}, + {{'9', '0'}}, {{'9', '1'}}, {{'9', '2'}}, {{'9', '3'}}, {{'9', '4'}}, {{'9', '5'}}, {{'9', '6'}}, {{'9', '7'}}, {{'9', '8'}}, {{'9', '9'}}, + } + }; + + // special case for "0" + if (x == 0) + { + o->write_character('0'); + return; + } + + // use a pointer to fill the buffer + auto buffer_ptr = number_buffer.begin(); + + const bool is_negative = std::is_same::value && !(x >= 0); // see issue #755 + number_unsigned_t abs_value; + + unsigned int n_chars; + + if (is_negative) + { + *buffer_ptr = '-'; + abs_value = remove_sign(static_cast(x)); + + // account one more byte for the minus sign + n_chars = 1 + count_digits(abs_value); + } + else + { + abs_value = static_cast(x); + n_chars = count_digits(abs_value); + } + + // spare 1 byte for '\0' + JSON_ASSERT(n_chars < number_buffer.size() - 1); + + // jump to the end to generate the string from backward + // so we later avoid reversing the result + buffer_ptr += n_chars; + + // Fast int2ascii implementation inspired by "Fastware" talk by Andrei Alexandrescu + // See: https://www.youtube.com/watch?v=o4-CwDo2zpg + while (abs_value >= 100) + { + const auto digits_index = static_cast((abs_value % 100)); + abs_value /= 100; + *(--buffer_ptr) = digits_to_99[digits_index][1]; + *(--buffer_ptr) = digits_to_99[digits_index][0]; + } + + if (abs_value >= 10) + { + const auto digits_index = static_cast(abs_value); + *(--buffer_ptr) = digits_to_99[digits_index][1]; + *(--buffer_ptr) = digits_to_99[digits_index][0]; + } + else + { + *(--buffer_ptr) = static_cast('0' + abs_value); + } + + o->write_characters(number_buffer.data(), n_chars); + } + + /*! + @brief dump a floating-point number + + Dump a given floating-point number to output stream @a o. Works internally + with @a number_buffer. + + @param[in] x floating-point number to dump + */ + void dump_float(number_float_t x) + { + // NaN / inf + if (!std::isfinite(x)) + { + o->write_characters("null", 4); + return; + } + + // If number_float_t is an IEEE-754 single or double precision number, + // use the Grisu2 algorithm to produce short numbers which are + // guaranteed to round-trip, using strtof and strtod, resp. + // + // NB: The test below works if == . + static constexpr bool is_ieee_single_or_double + = (std::numeric_limits::is_iec559 && std::numeric_limits::digits == 24 && std::numeric_limits::max_exponent == 128) || + (std::numeric_limits::is_iec559 && std::numeric_limits::digits == 53 && std::numeric_limits::max_exponent == 1024); + + dump_float(x, std::integral_constant()); + } + + void dump_float(number_float_t x, std::true_type /*is_ieee_single_or_double*/) + { + char* begin = number_buffer.data(); + char* end = ::nlohmann::detail::to_chars(begin, begin + number_buffer.size(), x); + + o->write_characters(begin, static_cast(end - begin)); + } + + void dump_float(number_float_t x, std::false_type /*is_ieee_single_or_double*/) + { + // get number of digits for a float -> text -> float round-trip + static constexpr auto d = std::numeric_limits::max_digits10; + + // the actual conversion + std::ptrdiff_t len = (std::snprintf)(number_buffer.data(), number_buffer.size(), "%.*g", d, x); + + // negative value indicates an error + JSON_ASSERT(len > 0); + // check if buffer was large enough + JSON_ASSERT(static_cast(len) < number_buffer.size()); + + // erase thousands separator + if (thousands_sep != '\0') + { + const auto end = std::remove(number_buffer.begin(), + number_buffer.begin() + len, thousands_sep); + std::fill(end, number_buffer.end(), '\0'); + JSON_ASSERT((end - number_buffer.begin()) <= len); + len = (end - number_buffer.begin()); + } + + // convert decimal point to '.' + if (decimal_point != '\0' && decimal_point != '.') + { + const auto dec_pos = std::find(number_buffer.begin(), number_buffer.end(), decimal_point); + if (dec_pos != number_buffer.end()) + { + *dec_pos = '.'; + } + } + + o->write_characters(number_buffer.data(), static_cast(len)); + + // determine if need to append ".0" + const bool value_is_int_like = + std::none_of(number_buffer.begin(), number_buffer.begin() + len + 1, + [](char c) + { + return c == '.' || c == 'e'; + }); + + if (value_is_int_like) + { + o->write_characters(".0", 2); + } + } + + /*! + @brief check whether a string is UTF-8 encoded + + The function checks each byte of a string whether it is UTF-8 encoded. The + result of the check is stored in the @a state parameter. The function must + be called initially with state 0 (accept). State 1 means the string must + be rejected, because the current byte is not allowed. If the string is + completely processed, but the state is non-zero, the string ended + prematurely; that is, the last byte indicated more bytes should have + followed. + + @param[in,out] state the state of the decoding + @param[in,out] codep codepoint (valid only if resulting state is UTF8_ACCEPT) + @param[in] byte next byte to decode + @return new state + + @note The function has been edited: a std::array is used. + + @copyright Copyright (c) 2008-2009 Bjoern Hoehrmann + @sa http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ + */ + static std::uint8_t decode(std::uint8_t& state, std::uint32_t& codep, const std::uint8_t byte) noexcept + { + static const std::array utf8d = + { + { + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 00..1F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 20..3F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 40..5F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 60..7F + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, // 80..9F + 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, // A0..BF + 8, 8, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, // C0..DF + 0xA, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x4, 0x3, 0x3, // E0..EF + 0xB, 0x6, 0x6, 0x6, 0x5, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, // F0..FF + 0x0, 0x1, 0x2, 0x3, 0x5, 0x8, 0x7, 0x1, 0x1, 0x1, 0x4, 0x6, 0x1, 0x1, 0x1, 0x1, // s0..s0 + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, // s1..s2 + 1, 2, 1, 1, 1, 1, 1, 2, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, // s3..s4 + 1, 2, 1, 1, 1, 1, 1, 1, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 3, 1, 3, 1, 1, 1, 1, 1, 1, // s5..s6 + 1, 3, 1, 1, 1, 1, 1, 3, 1, 3, 1, 1, 1, 1, 1, 1, 1, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 // s7..s8 + } + }; + + const std::uint8_t type = utf8d[byte]; + + codep = (state != UTF8_ACCEPT) + ? (byte & 0x3fu) | (codep << 6u) + : (0xFFu >> type) & (byte); + + std::size_t index = 256u + static_cast(state) * 16u + static_cast(type); + JSON_ASSERT(index < 400); + state = utf8d[index]; + return state; + } + + /* + * Overload to make the compiler happy while it is instantiating + * dump_integer for number_unsigned_t. + * Must never be called. + */ + number_unsigned_t remove_sign(number_unsigned_t x) + { + JSON_ASSERT(false); // LCOV_EXCL_LINE + return x; // LCOV_EXCL_LINE + } + + /* + * Helper function for dump_integer + * + * This function takes a negative signed integer and returns its absolute + * value as unsigned integer. The plus/minus shuffling is necessary as we can + * not directly remove the sign of an arbitrary signed integer as the + * absolute values of INT_MIN and INT_MAX are usually not the same. See + * #1708 for details. + */ + inline number_unsigned_t remove_sign(number_integer_t x) noexcept + { + JSON_ASSERT(x < 0 && x < (std::numeric_limits::max)()); + return static_cast(-(x + 1)) + 1; + } + + private: + /// the output of the serializer + output_adapter_t o = nullptr; + + /// a (hopefully) large enough character buffer + std::array number_buffer{{}}; + + /// the locale + const std::lconv* loc = nullptr; + /// the locale's thousand separator character + const char thousands_sep = '\0'; + /// the locale's decimal point character + const char decimal_point = '\0'; + + /// string buffer + std::array string_buffer{{}}; + + /// the indentation character + const char indent_char; + /// the indentation string + string_t indent_string; + + /// error_handler how to react on decoding errors + const error_handler_t error_handler; +}; +} // namespace detail +} // namespace nlohmann + +// #include + +// #include + +// #include + + +#include // less +#include // allocator +#include // pair +#include // vector + +namespace nlohmann +{ + +/// ordered_map: a minimal map-like container that preserves insertion order +/// for use within nlohmann::basic_json +template , + class Allocator = std::allocator>> + struct ordered_map : std::vector, Allocator> +{ + using key_type = Key; + using mapped_type = T; + using Container = std::vector, Allocator>; + using typename Container::iterator; + using typename Container::const_iterator; + using typename Container::size_type; + using typename Container::value_type; + + // Explicit constructors instead of `using Container::Container` + // otherwise older compilers choke on it (GCC <= 5.5, xcode <= 9.4) + ordered_map(const Allocator& alloc = Allocator()) : Container{alloc} {} + template + ordered_map(It first, It last, const Allocator& alloc = Allocator()) + : Container{first, last, alloc} {} + ordered_map(std::initializer_list init, const Allocator& alloc = Allocator() ) + : Container{init, alloc} {} + + std::pair emplace(const key_type& key, T&& t) + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return {it, false}; + } + } + Container::emplace_back(key, t); + return {--this->end(), true}; + } + + T& operator[](const Key& key) + { + return emplace(key, T{}).first->second; + } + + const T& operator[](const Key& key) const + { + return at(key); + } + + T& at(const Key& key) + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return it->second; + } + } + + throw std::out_of_range("key not found"); + } + + const T& at(const Key& key) const + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return it->second; + } + } + + throw std::out_of_range("key not found"); + } + + size_type erase(const Key& key) + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + // Since we cannot move const Keys, re-construct them in place + for (auto next = it; ++next != this->end(); ++it) + { + it->~value_type(); // Destroy but keep allocation + new (&*it) value_type{std::move(*next)}; + } + Container::pop_back(); + return 1; + } + } + return 0; + } + + iterator erase(iterator pos) + { + auto it = pos; + + // Since we cannot move const Keys, re-construct them in place + for (auto next = it; ++next != this->end(); ++it) + { + it->~value_type(); // Destroy but keep allocation + new (&*it) value_type{std::move(*next)}; + } + Container::pop_back(); + return pos; + } + + size_type count(const Key& key) const + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return 1; + } + } + return 0; + } + + iterator find(const Key& key) + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return it; + } + } + return Container::end(); + } + + const_iterator find(const Key& key) const + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == key) + { + return it; + } + } + return Container::end(); + } + + std::pair insert( value_type&& value ) + { + return emplace(value.first, std::move(value.second)); + } + + std::pair insert( const value_type& value ) + { + for (auto it = this->begin(); it != this->end(); ++it) + { + if (it->first == value.first) + { + return {it, false}; + } + } + Container::push_back(value); + return {--this->end(), true}; + } +}; + +} // namespace nlohmann + + +/*! +@brief namespace for Niels Lohmann +@see https://github.com/nlohmann +@since version 1.0.0 +*/ +namespace nlohmann +{ + +/*! +@brief a class to store JSON values + +@tparam ObjectType type for JSON objects (`std::map` by default; will be used +in @ref object_t) +@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used +in @ref array_t) +@tparam StringType type for JSON strings and object keys (`std::string` by +default; will be used in @ref string_t) +@tparam BooleanType type for JSON booleans (`bool` by default; will be used +in @ref boolean_t) +@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by +default; will be used in @ref number_integer_t) +@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c +`uint64_t` by default; will be used in @ref number_unsigned_t) +@tparam NumberFloatType type for JSON floating-point numbers (`double` by +default; will be used in @ref number_float_t) +@tparam BinaryType type for packed binary data for compatibility with binary +serialization formats (`std::vector` by default; will be used in +@ref binary_t) +@tparam AllocatorType type of the allocator to use (`std::allocator` by +default) +@tparam JSONSerializer the serializer to resolve internal calls to `to_json()` +and `from_json()` (@ref adl_serializer by default) + +@requirement The class satisfies the following concept requirements: +- Basic + - [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible): + JSON values can be default constructed. The result will be a JSON null + value. + - [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible): + A JSON value can be constructed from an rvalue argument. + - [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible): + A JSON value can be copy-constructed from an lvalue expression. + - [MoveAssignable](https://en.cppreference.com/w/cpp/named_req/MoveAssignable): + A JSON value van be assigned from an rvalue argument. + - [CopyAssignable](https://en.cppreference.com/w/cpp/named_req/CopyAssignable): + A JSON value can be copy-assigned from an lvalue expression. + - [Destructible](https://en.cppreference.com/w/cpp/named_req/Destructible): + JSON values can be destructed. +- Layout + - [StandardLayoutType](https://en.cppreference.com/w/cpp/named_req/StandardLayoutType): + JSON values have + [standard layout](https://en.cppreference.com/w/cpp/language/data_members#Standard_layout): + All non-static data members are private and standard layout types, the + class has no virtual functions or (virtual) base classes. +- Library-wide + - [EqualityComparable](https://en.cppreference.com/w/cpp/named_req/EqualityComparable): + JSON values can be compared with `==`, see @ref + operator==(const_reference,const_reference). + - [LessThanComparable](https://en.cppreference.com/w/cpp/named_req/LessThanComparable): + JSON values can be compared with `<`, see @ref + operator<(const_reference,const_reference). + - [Swappable](https://en.cppreference.com/w/cpp/named_req/Swappable): + Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of + other compatible types, using unqualified function call @ref swap(). + - [NullablePointer](https://en.cppreference.com/w/cpp/named_req/NullablePointer): + JSON values can be compared against `std::nullptr_t` objects which are used + to model the `null` value. +- Container + - [Container](https://en.cppreference.com/w/cpp/named_req/Container): + JSON values can be used like STL containers and provide iterator access. + - [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer); + JSON values can be used like STL containers and provide reverse iterator + access. + +@invariant The member variables @a m_value and @a m_type have the following +relationship: +- If `m_type == value_t::object`, then `m_value.object != nullptr`. +- If `m_type == value_t::array`, then `m_value.array != nullptr`. +- If `m_type == value_t::string`, then `m_value.string != nullptr`. +The invariants are checked by member function assert_invariant(). + +@internal +@note ObjectType trick from https://stackoverflow.com/a/9860911 +@endinternal + +@see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange +Format](http://rfc7159.net/rfc7159) + +@since version 1.0.0 + +@nosubgrouping +*/ +NLOHMANN_BASIC_JSON_TPL_DECLARATION +class basic_json +{ + private: + template friend struct detail::external_constructor; + friend ::nlohmann::json_pointer; + + template + friend class ::nlohmann::detail::parser; + friend ::nlohmann::detail::serializer; + template + friend class ::nlohmann::detail::iter_impl; + template + friend class ::nlohmann::detail::binary_writer; + template + friend class ::nlohmann::detail::binary_reader; + template + friend class ::nlohmann::detail::json_sax_dom_parser; + template + friend class ::nlohmann::detail::json_sax_dom_callback_parser; + + /// workaround type for MSVC + using basic_json_t = NLOHMANN_BASIC_JSON_TPL; + + // convenience aliases for types residing in namespace detail; + using lexer = ::nlohmann::detail::lexer_base; + + template + static ::nlohmann::detail::parser parser( + InputAdapterType adapter, + detail::parser_callback_tcb = nullptr, + const bool allow_exceptions = true, + const bool ignore_comments = false + ) + { + return ::nlohmann::detail::parser(std::move(adapter), + std::move(cb), allow_exceptions, ignore_comments); + } + + using primitive_iterator_t = ::nlohmann::detail::primitive_iterator_t; + template + using internal_iterator = ::nlohmann::detail::internal_iterator; + template + using iter_impl = ::nlohmann::detail::iter_impl; + template + using iteration_proxy = ::nlohmann::detail::iteration_proxy; + template using json_reverse_iterator = ::nlohmann::detail::json_reverse_iterator; + + template + using output_adapter_t = ::nlohmann::detail::output_adapter_t; + + template + using binary_reader = ::nlohmann::detail::binary_reader; + template using binary_writer = ::nlohmann::detail::binary_writer; + + using serializer = ::nlohmann::detail::serializer; + + public: + using value_t = detail::value_t; + /// JSON Pointer, see @ref nlohmann::json_pointer + using json_pointer = ::nlohmann::json_pointer; + template + using json_serializer = JSONSerializer; + /// how to treat decoding errors + using error_handler_t = detail::error_handler_t; + /// how to treat CBOR tags + using cbor_tag_handler_t = detail::cbor_tag_handler_t; + /// helper type for initializer lists of basic_json values + using initializer_list_t = std::initializer_list>; + + using input_format_t = detail::input_format_t; + /// SAX interface type, see @ref nlohmann::json_sax + using json_sax_t = json_sax; + + //////////////// + // exceptions // + //////////////// + + /// @name exceptions + /// Classes to implement user-defined exceptions. + /// @{ + + /// @copydoc detail::exception + using exception = detail::exception; + /// @copydoc detail::parse_error + using parse_error = detail::parse_error; + /// @copydoc detail::invalid_iterator + using invalid_iterator = detail::invalid_iterator; + /// @copydoc detail::type_error + using type_error = detail::type_error; + /// @copydoc detail::out_of_range + using out_of_range = detail::out_of_range; + /// @copydoc detail::other_error + using other_error = detail::other_error; + + /// @} + + + ///////////////////// + // container types // + ///////////////////// + + /// @name container types + /// The canonic container types to use @ref basic_json like any other STL + /// container. + /// @{ + + /// the type of elements in a basic_json container + using value_type = basic_json; + + /// the type of an element reference + using reference = value_type&; + /// the type of an element const reference + using const_reference = const value_type&; + + /// a type to represent differences between iterators + using difference_type = std::ptrdiff_t; + /// a type to represent container sizes + using size_type = std::size_t; + + /// the allocator type + using allocator_type = AllocatorType; + + /// the type of an element pointer + using pointer = typename std::allocator_traits::pointer; + /// the type of an element const pointer + using const_pointer = typename std::allocator_traits::const_pointer; + + /// an iterator for a basic_json container + using iterator = iter_impl; + /// a const iterator for a basic_json container + using const_iterator = iter_impl; + /// a reverse iterator for a basic_json container + using reverse_iterator = json_reverse_iterator; + /// a const reverse iterator for a basic_json container + using const_reverse_iterator = json_reverse_iterator; + + /// @} + + + /*! + @brief returns the allocator associated with the container + */ + static allocator_type get_allocator() + { + return allocator_type(); + } + + /*! + @brief returns version information on the library + + This function returns a JSON object with information about the library, + including the version number and information on the platform and compiler. + + @return JSON object holding version information + key | description + ----------- | --------------- + `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). + `copyright` | The copyright line for the library as string. + `name` | The name of the library as string. + `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. + `url` | The URL of the project as string. + `version` | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string). + + @liveexample{The following code shows an example output of the `meta()` + function.,meta} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @complexity Constant. + + @since 2.1.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json meta() + { + basic_json result; + + result["copyright"] = "(C) 2013-2020 Niels Lohmann"; + result["name"] = "JSON for Modern C++"; + result["url"] = "https://github.com/nlohmann/json"; + result["version"]["string"] = + std::to_string(NLOHMANN_JSON_VERSION_MAJOR) + "." + + std::to_string(NLOHMANN_JSON_VERSION_MINOR) + "." + + std::to_string(NLOHMANN_JSON_VERSION_PATCH); + result["version"]["major"] = NLOHMANN_JSON_VERSION_MAJOR; + result["version"]["minor"] = NLOHMANN_JSON_VERSION_MINOR; + result["version"]["patch"] = NLOHMANN_JSON_VERSION_PATCH; + +#ifdef _WIN32 + result["platform"] = "win32"; +#elif defined __linux__ + result["platform"] = "linux"; +#elif defined __APPLE__ + result["platform"] = "apple"; +#elif defined __unix__ + result["platform"] = "unix"; +#else + result["platform"] = "unknown"; +#endif + +#if defined(__ICC) || defined(__INTEL_COMPILER) + result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}}; +#elif defined(__clang__) + result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}}; +#elif defined(__GNUC__) || defined(__GNUG__) + result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}}; +#elif defined(__HP_cc) || defined(__HP_aCC) + result["compiler"] = "hp" +#elif defined(__IBMCPP__) + result["compiler"] = {{"family", "ilecpp"}, {"version", __IBMCPP__}}; +#elif defined(_MSC_VER) + result["compiler"] = {{"family", "msvc"}, {"version", _MSC_VER}}; +#elif defined(__PGI) + result["compiler"] = {{"family", "pgcpp"}, {"version", __PGI}}; +#elif defined(__SUNPRO_CC) + result["compiler"] = {{"family", "sunpro"}, {"version", __SUNPRO_CC}}; +#else + result["compiler"] = {{"family", "unknown"}, {"version", "unknown"}}; +#endif + +#ifdef __cplusplus + result["compiler"]["c++"] = std::to_string(__cplusplus); +#else + result["compiler"]["c++"] = "unknown"; +#endif + return result; + } + + + /////////////////////////// + // JSON value data types // + /////////////////////////// + + /// @name JSON value data types + /// The data types to store a JSON value. These types are derived from + /// the template arguments passed to class @ref basic_json. + /// @{ + +#if defined(JSON_HAS_CPP_14) + // Use transparent comparator if possible, combined with perfect forwarding + // on find() and count() calls prevents unnecessary string construction. + using object_comparator_t = std::less<>; +#else + using object_comparator_t = std::less; +#endif + + /*! + @brief a type for an object + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON objects as follows: + > An object is an unordered collection of zero or more name/value pairs, + > where a name is a string and a value is a string, number, boolean, null, + > object, or array. + + To store objects in C++, a type is defined by the template parameters + described below. + + @tparam ObjectType the container to store objects (e.g., `std::map` or + `std::unordered_map`) + @tparam StringType the type of the keys or names (e.g., `std::string`). + The comparison function `std::less` is used to order elements + inside the container. + @tparam AllocatorType the allocator to use for objects (e.g., + `std::allocator`) + + #### Default type + + With the default values for @a ObjectType (`std::map`), @a StringType + (`std::string`), and @a AllocatorType (`std::allocator`), the default + value for @a object_t is: + + @code {.cpp} + std::map< + std::string, // key_type + basic_json, // value_type + std::less, // key_compare + std::allocator> // allocator_type + > + @endcode + + #### Behavior + + The choice of @a object_t influences the behavior of the JSON class. With + the default type, objects have the following behavior: + + - When all names are unique, objects will be interoperable in the sense + that all software implementations receiving that object will agree on + the name-value mappings. + - When the names within an object are not unique, it is unspecified which + one of the values for a given key will be chosen. For instance, + `{"key": 2, "key": 1}` could be equal to either `{"key": 1}` or + `{"key": 2}`. + - Internally, name/value pairs are stored in lexicographical order of the + names. Objects will also be serialized (see @ref dump) in this order. + For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored + and serialized as `{"a": 2, "b": 1}`. + - When comparing objects, the order of the name/value pairs is irrelevant. + This makes objects interoperable in the sense that they will not be + affected by these differences. For instance, `{"b": 1, "a": 2}` and + `{"a": 2, "b": 1}` will be treated as equal. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the maximum depth of nesting. + + In this class, the object's limit of nesting is not explicitly constrained. + However, a maximum depth of nesting may be introduced by the compiler or + runtime environment. A theoretical limit can be queried by calling the + @ref max_size function of a JSON object. + + #### Storage + + Objects are stored as pointers in a @ref basic_json type. That is, for any + access to object values, a pointer of type `object_t*` must be + dereferenced. + + @sa @ref array_t -- type for an array value + + @since version 1.0.0 + + @note The order name/value pairs are added to the object is *not* + preserved by the library. Therefore, iterating an object may return + name/value pairs in a different order than they were originally stored. In + fact, keys will be traversed in alphabetical order as `std::map` with + `std::less` is used by default. Please note this behavior conforms to [RFC + 7159](http://rfc7159.net/rfc7159), because any order implements the + specified "unordered" nature of JSON objects. + */ + using object_t = ObjectType>>; + + /*! + @brief a type for an array + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON arrays as follows: + > An array is an ordered sequence of zero or more values. + + To store objects in C++, a type is defined by the template parameters + explained below. + + @tparam ArrayType container type to store arrays (e.g., `std::vector` or + `std::list`) + @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`) + + #### Default type + + With the default values for @a ArrayType (`std::vector`) and @a + AllocatorType (`std::allocator`), the default value for @a array_t is: + + @code {.cpp} + std::vector< + basic_json, // value_type + std::allocator // allocator_type + > + @endcode + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the maximum depth of nesting. + + In this class, the array's limit of nesting is not explicitly constrained. + However, a maximum depth of nesting may be introduced by the compiler or + runtime environment. A theoretical limit can be queried by calling the + @ref max_size function of a JSON array. + + #### Storage + + Arrays are stored as pointers in a @ref basic_json type. That is, for any + access to array values, a pointer of type `array_t*` must be dereferenced. + + @sa @ref object_t -- type for an object value + + @since version 1.0.0 + */ + using array_t = ArrayType>; + + /*! + @brief a type for a string + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON strings as follows: + > A string is a sequence of zero or more Unicode characters. + + To store objects in C++, a type is defined by the template parameter + described below. Unicode values are split by the JSON class into + byte-sized characters during deserialization. + + @tparam StringType the container to store strings (e.g., `std::string`). + Note this container is used for keys/names in objects, see @ref object_t. + + #### Default type + + With the default values for @a StringType (`std::string`), the default + value for @a string_t is: + + @code {.cpp} + std::string + @endcode + + #### Encoding + + Strings are stored in UTF-8 encoding. Therefore, functions like + `std::string::size()` or `std::string::length()` return the number of + bytes in the string rather than the number of characters or glyphs. + + #### String comparison + + [RFC 7159](http://rfc7159.net/rfc7159) states: + > Software implementations are typically required to test names of object + > members for equality. Implementations that transform the textual + > representation into sequences of Unicode code units and then perform the + > comparison numerically, code unit by code unit, are interoperable in the + > sense that implementations will agree in all cases on equality or + > inequality of two strings. For example, implementations that compare + > strings with escaped characters unconverted may incorrectly find that + > `"a\\b"` and `"a\u005Cb"` are not equal. + + This implementation is interoperable as it does compare strings code unit + by code unit. + + #### Storage + + String values are stored as pointers in a @ref basic_json type. That is, + for any access to string values, a pointer of type `string_t*` must be + dereferenced. + + @since version 1.0.0 + */ + using string_t = StringType; + + /*! + @brief a type for a boolean + + [RFC 7159](http://rfc7159.net/rfc7159) implicitly describes a boolean as a + type which differentiates the two literals `true` and `false`. + + To store objects in C++, a type is defined by the template parameter @a + BooleanType which chooses the type to use. + + #### Default type + + With the default values for @a BooleanType (`bool`), the default value for + @a boolean_t is: + + @code {.cpp} + bool + @endcode + + #### Storage + + Boolean values are stored directly inside a @ref basic_json type. + + @since version 1.0.0 + */ + using boolean_t = BooleanType; + + /*! + @brief a type for a number (integer) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store integer numbers in C++, a type is defined by the template + parameter @a NumberIntegerType which chooses the type to use. + + #### Default type + + With the default values for @a NumberIntegerType (`int64_t`), the default + value for @a number_integer_t is: + + @code {.cpp} + int64_t + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in integer literals lead to an interpretation as octal + number. Internally, the value will be stored as decimal number. For + instance, the C++ integer literal `010` will be serialized to `8`. + During deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the range and precision of numbers. + + When the default type is used, the maximal integer number that can be + stored is `9223372036854775807` (INT64_MAX) and the minimal integer number + that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers + that are out of range will yield over/underflow when used in a + constructor. During deserialization, too large or small integer numbers + will be automatically be stored as @ref number_unsigned_t or @ref + number_float_t. + + [RFC 7159](http://rfc7159.net/rfc7159) further states: + > Note that when such software is used, numbers that are integers and are + > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense + > that implementations will agree exactly on their numeric values. + + As this range is a subrange of the exactly supported range [INT64_MIN, + INT64_MAX], this class's integer type is interoperable. + + #### Storage + + Integer number values are stored directly inside a @ref basic_json type. + + @sa @ref number_float_t -- type for number values (floating-point) + + @sa @ref number_unsigned_t -- type for number values (unsigned integer) + + @since version 1.0.0 + */ + using number_integer_t = NumberIntegerType; + + /*! + @brief a type for a number (unsigned) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store unsigned integer numbers in C++, a type is defined by the + template parameter @a NumberUnsignedType which chooses the type to use. + + #### Default type + + With the default values for @a NumberUnsignedType (`uint64_t`), the + default value for @a number_unsigned_t is: + + @code {.cpp} + uint64_t + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in integer literals lead to an interpretation as octal + number. Internally, the value will be stored as decimal number. For + instance, the C++ integer literal `010` will be serialized to `8`. + During deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the range and precision of numbers. + + When the default type is used, the maximal integer number that can be + stored is `18446744073709551615` (UINT64_MAX) and the minimal integer + number that can be stored is `0`. Integer numbers that are out of range + will yield over/underflow when used in a constructor. During + deserialization, too large or small integer numbers will be automatically + be stored as @ref number_integer_t or @ref number_float_t. + + [RFC 7159](http://rfc7159.net/rfc7159) further states: + > Note that when such software is used, numbers that are integers and are + > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense + > that implementations will agree exactly on their numeric values. + + As this range is a subrange (when considered in conjunction with the + number_integer_t type) of the exactly supported range [0, UINT64_MAX], + this class's integer type is interoperable. + + #### Storage + + Integer number values are stored directly inside a @ref basic_json type. + + @sa @ref number_float_t -- type for number values (floating-point) + @sa @ref number_integer_t -- type for number values (integer) + + @since version 2.0.0 + */ + using number_unsigned_t = NumberUnsignedType; + + /*! + @brief a type for a number (floating-point) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store floating-point numbers in C++, a type is defined by the template + parameter @a NumberFloatType which chooses the type to use. + + #### Default type + + With the default values for @a NumberFloatType (`double`), the default + value for @a number_float_t is: + + @code {.cpp} + double + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in floating-point literals will be ignored. Internally, + the value will be stored as decimal number. For instance, the C++ + floating-point literal `01.2` will be serialized to `1.2`. During + deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) states: + > This specification allows implementations to set limits on the range and + > precision of numbers accepted. Since software that implements IEEE + > 754-2008 binary64 (double precision) numbers is generally available and + > widely used, good interoperability can be achieved by implementations + > that expect no more precision or range than these provide, in the sense + > that implementations will approximate JSON numbers within the expected + > precision. + + This implementation does exactly follow this approach, as it uses double + precision floating-point numbers. Note values smaller than + `-1.79769313486232e+308` and values greater than `1.79769313486232e+308` + will be stored as NaN internally and be serialized to `null`. + + #### Storage + + Floating-point number values are stored directly inside a @ref basic_json + type. + + @sa @ref number_integer_t -- type for number values (integer) + + @sa @ref number_unsigned_t -- type for number values (unsigned integer) + + @since version 1.0.0 + */ + using number_float_t = NumberFloatType; + + /*! + @brief a type for a packed binary type + + This type is a type designed to carry binary data that appears in various + serialized formats, such as CBOR's Major Type 2, MessagePack's bin, and + BSON's generic binary subtype. This type is NOT a part of standard JSON and + exists solely for compatibility with these binary types. As such, it is + simply defined as an ordered sequence of zero or more byte values. + + Additionally, as an implementation detail, the subtype of the binary data is + carried around as a `std::uint8_t`, which is compatible with both of the + binary data formats that use binary subtyping, (though the specific + numbering is incompatible with each other, and it is up to the user to + translate between them). + + [CBOR's RFC 7049](https://tools.ietf.org/html/rfc7049) describes this type + as: + > Major type 2: a byte string. The string's length in bytes is represented + > following the rules for positive integers (major type 0). + + [MessagePack's documentation on the bin type + family](https://github.com/msgpack/msgpack/blob/master/spec.md#bin-format-family) + describes this type as: + > Bin format family stores an byte array in 2, 3, or 5 bytes of extra bytes + > in addition to the size of the byte array. + + [BSON's specifications](http://bsonspec.org/spec.html) describe several + binary types; however, this type is intended to represent the generic binary + type which has the description: + > Generic binary subtype - This is the most commonly used binary subtype and + > should be the 'default' for drivers and tools. + + None of these impose any limitations on the internal representation other + than the basic unit of storage be some type of array whose parts are + decomposable into bytes. + + The default representation of this binary format is a + `std::vector`, which is a very common way to represent a byte + array in modern C++. + + #### Default type + + The default values for @a BinaryType is `std::vector` + + #### Storage + + Binary Arrays are stored as pointers in a @ref basic_json type. That is, + for any access to array values, a pointer of the type `binary_t*` must be + dereferenced. + + #### Notes on subtypes + + - CBOR + - Binary values are represented as byte strings. No subtypes are + supported and will be ignored when CBOR is written. + - MessagePack + - If a subtype is given and the binary array contains exactly 1, 2, 4, 8, + or 16 elements, the fixext family (fixext1, fixext2, fixext4, fixext8) + is used. For other sizes, the ext family (ext8, ext16, ext32) is used. + The subtype is then added as singed 8-bit integer. + - If no subtype is given, the bin family (bin8, bin16, bin32) is used. + - BSON + - If a subtype is given, it is used and added as unsigned 8-bit integer. + - If no subtype is given, the generic binary subtype 0x00 is used. + + @sa @ref binary -- create a binary array + + @since version 3.8.0 + */ + using binary_t = nlohmann::byte_container_with_subtype; + /// @} + + private: + + /// helper for exception-safe object creation + template + JSON_HEDLEY_RETURNS_NON_NULL + static T* create(Args&& ... args) + { + AllocatorType alloc; + using AllocatorTraits = std::allocator_traits>; + + auto deleter = [&](T * object) + { + AllocatorTraits::deallocate(alloc, object, 1); + }; + std::unique_ptr object(AllocatorTraits::allocate(alloc, 1), deleter); + AllocatorTraits::construct(alloc, object.get(), std::forward(args)...); + JSON_ASSERT(object != nullptr); + return object.release(); + } + + //////////////////////// + // JSON value storage // + //////////////////////// + + /*! + @brief a JSON value + + The actual storage for a JSON value of the @ref basic_json class. This + union combines the different storage types for the JSON value types + defined in @ref value_t. + + JSON type | value_t type | used type + --------- | --------------- | ------------------------ + object | object | pointer to @ref object_t + array | array | pointer to @ref array_t + string | string | pointer to @ref string_t + boolean | boolean | @ref boolean_t + number | number_integer | @ref number_integer_t + number | number_unsigned | @ref number_unsigned_t + number | number_float | @ref number_float_t + binary | binary | pointer to @ref binary_t + null | null | *no value is stored* + + @note Variable-length types (objects, arrays, and strings) are stored as + pointers. The size of the union should not exceed 64 bits if the default + value types are used. + + @since version 1.0.0 + */ + union json_value + { + /// object (stored with pointer to save storage) + object_t* object; + /// array (stored with pointer to save storage) + array_t* array; + /// string (stored with pointer to save storage) + string_t* string; + /// binary (stored with pointer to save storage) + binary_t* binary; + /// boolean + boolean_t boolean; + /// number (integer) + number_integer_t number_integer; + /// number (unsigned integer) + number_unsigned_t number_unsigned; + /// number (floating-point) + number_float_t number_float; + + /// default constructor (for null values) + json_value() = default; + /// constructor for booleans + json_value(boolean_t v) noexcept : boolean(v) {} + /// constructor for numbers (integer) + json_value(number_integer_t v) noexcept : number_integer(v) {} + /// constructor for numbers (unsigned) + json_value(number_unsigned_t v) noexcept : number_unsigned(v) {} + /// constructor for numbers (floating-point) + json_value(number_float_t v) noexcept : number_float(v) {} + /// constructor for empty values of a given type + json_value(value_t t) + { + switch (t) + { + case value_t::object: + { + object = create(); + break; + } + + case value_t::array: + { + array = create(); + break; + } + + case value_t::string: + { + string = create(""); + break; + } + + case value_t::binary: + { + binary = create(); + break; + } + + case value_t::boolean: + { + boolean = boolean_t(false); + break; + } + + case value_t::number_integer: + { + number_integer = number_integer_t(0); + break; + } + + case value_t::number_unsigned: + { + number_unsigned = number_unsigned_t(0); + break; + } + + case value_t::number_float: + { + number_float = number_float_t(0.0); + break; + } + + case value_t::null: + { + object = nullptr; // silence warning, see #821 + break; + } + + default: + { + object = nullptr; // silence warning, see #821 + if (JSON_HEDLEY_UNLIKELY(t == value_t::null)) + { + JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 3.9.1")); // LCOV_EXCL_LINE + } + break; + } + } + } + + /// constructor for strings + json_value(const string_t& value) + { + string = create(value); + } + + /// constructor for rvalue strings + json_value(string_t&& value) + { + string = create(std::move(value)); + } + + /// constructor for objects + json_value(const object_t& value) + { + object = create(value); + } + + /// constructor for rvalue objects + json_value(object_t&& value) + { + object = create(std::move(value)); + } + + /// constructor for arrays + json_value(const array_t& value) + { + array = create(value); + } + + /// constructor for rvalue arrays + json_value(array_t&& value) + { + array = create(std::move(value)); + } + + /// constructor for binary arrays + json_value(const typename binary_t::container_type& value) + { + binary = create(value); + } + + /// constructor for rvalue binary arrays + json_value(typename binary_t::container_type&& value) + { + binary = create(std::move(value)); + } + + /// constructor for binary arrays (internal type) + json_value(const binary_t& value) + { + binary = create(value); + } + + /// constructor for rvalue binary arrays (internal type) + json_value(binary_t&& value) + { + binary = create(std::move(value)); + } + + void destroy(value_t t) noexcept + { + // flatten the current json_value to a heap-allocated stack + std::vector stack; + + // move the top-level items to stack + if (t == value_t::array) + { + stack.reserve(array->size()); + std::move(array->begin(), array->end(), std::back_inserter(stack)); + } + else if (t == value_t::object) + { + stack.reserve(object->size()); + for (auto&& it : *object) + { + stack.push_back(std::move(it.second)); + } + } + + while (!stack.empty()) + { + // move the last item to local variable to be processed + basic_json current_item(std::move(stack.back())); + stack.pop_back(); + + // if current_item is array/object, move + // its children to the stack to be processed later + if (current_item.is_array()) + { + std::move(current_item.m_value.array->begin(), current_item.m_value.array->end(), + std::back_inserter(stack)); + + current_item.m_value.array->clear(); + } + else if (current_item.is_object()) + { + for (auto&& it : *current_item.m_value.object) + { + stack.push_back(std::move(it.second)); + } + + current_item.m_value.object->clear(); + } + + // it's now safe that current_item get destructed + // since it doesn't have any children + } + + switch (t) + { + case value_t::object: + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, object); + std::allocator_traits::deallocate(alloc, object, 1); + break; + } + + case value_t::array: + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, array); + std::allocator_traits::deallocate(alloc, array, 1); + break; + } + + case value_t::string: + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, string); + std::allocator_traits::deallocate(alloc, string, 1); + break; + } + + case value_t::binary: + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, binary); + std::allocator_traits::deallocate(alloc, binary, 1); + break; + } + + default: + { + break; + } + } + } + }; + + /*! + @brief checks the class invariants + + This function asserts the class invariants. It needs to be called at the + end of every constructor to make sure that created objects respect the + invariant. Furthermore, it has to be called each time the type of a JSON + value is changed, because the invariant expresses a relationship between + @a m_type and @a m_value. + */ + void assert_invariant() const noexcept + { + JSON_ASSERT(m_type != value_t::object || m_value.object != nullptr); + JSON_ASSERT(m_type != value_t::array || m_value.array != nullptr); + JSON_ASSERT(m_type != value_t::string || m_value.string != nullptr); + JSON_ASSERT(m_type != value_t::binary || m_value.binary != nullptr); + } + + public: + ////////////////////////// + // JSON parser callback // + ////////////////////////// + + /*! + @brief parser event types + + The parser callback distinguishes the following events: + - `object_start`: the parser read `{` and started to process a JSON object + - `key`: the parser read a key of a value in an object + - `object_end`: the parser read `}` and finished processing a JSON object + - `array_start`: the parser read `[` and started to process a JSON array + - `array_end`: the parser read `]` and finished processing a JSON array + - `value`: the parser finished reading a JSON value + + @image html callback_events.png "Example when certain parse events are triggered" + + @sa @ref parser_callback_t for more information and examples + */ + using parse_event_t = detail::parse_event_t; + + /*! + @brief per-element parser callback type + + With a parser callback function, the result of parsing a JSON text can be + influenced. When passed to @ref parse, it is called on certain events + (passed as @ref parse_event_t via parameter @a event) with a set recursion + depth @a depth and context JSON value @a parsed. The return value of the + callback function is a boolean indicating whether the element that emitted + the callback shall be kept or not. + + We distinguish six scenarios (determined by the event type) in which the + callback function can be called. The following table describes the values + of the parameters @a depth, @a event, and @a parsed. + + parameter @a event | description | parameter @a depth | parameter @a parsed + ------------------ | ----------- | ------------------ | ------------------- + parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded + parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key + parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object + parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded + parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array + parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value + + @image html callback_events.png "Example when certain parse events are triggered" + + Discarding a value (i.e., returning `false`) has different effects + depending on the context in which function was called: + + - Discarded values in structured types are skipped. That is, the parser + will behave as if the discarded value was never read. + - In case a value outside a structured type is skipped, it is replaced + with `null`. This case happens if the top-level element is skipped. + + @param[in] depth the depth of the recursion during parsing + + @param[in] event an event of type parse_event_t indicating the context in + the callback function has been called + + @param[in,out] parsed the current intermediate parse result; note that + writing to this value has no effect for parse_event_t::key events + + @return Whether the JSON value which called the function during parsing + should be kept (`true`) or not (`false`). In the latter case, it is either + skipped completely or replaced by an empty discarded object. + + @sa @ref parse for examples + + @since version 1.0.0 + */ + using parser_callback_t = detail::parser_callback_t; + + ////////////////// + // constructors // + ////////////////// + + /// @name constructors and destructors + /// Constructors of class @ref basic_json, copy/move constructor, copy + /// assignment, static functions creating objects, and the destructor. + /// @{ + + /*! + @brief create an empty value with a given type + + Create an empty JSON value with a given type. The value will be default + initialized with an empty value which depends on the type: + + Value type | initial value + ----------- | ------------- + null | `null` + boolean | `false` + string | `""` + number | `0` + object | `{}` + array | `[]` + binary | empty array + + @param[in] v the type of the value to create + + @complexity Constant. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows the constructor for different @ref + value_t values,basic_json__value_t} + + @sa @ref clear() -- restores the postcondition of this constructor + + @since version 1.0.0 + */ + basic_json(const value_t v) + : m_type(v), m_value(v) + { + assert_invariant(); + } + + /*! + @brief create a null object + + Create a `null` JSON value. It either takes a null pointer as parameter + (explicitly creating `null`) or no parameter (implicitly creating `null`). + The passed null pointer itself is not read -- it is only used to choose + the right constructor. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this constructor never throws + exceptions. + + @liveexample{The following code shows the constructor with and without a + null pointer parameter.,basic_json__nullptr_t} + + @since version 1.0.0 + */ + basic_json(std::nullptr_t = nullptr) noexcept + : basic_json(value_t::null) + { + assert_invariant(); + } + + /*! + @brief create a JSON value + + This is a "catch all" constructor for all compatible JSON types; that is, + types for which a `to_json()` method exists. The constructor forwards the + parameter @a val to that method (to `json_serializer::to_json` method + with `U = uncvref_t`, to be exact). + + Template type @a CompatibleType includes, but is not limited to, the + following types: + - **arrays**: @ref array_t and all kinds of compatible containers such as + `std::vector`, `std::deque`, `std::list`, `std::forward_list`, + `std::array`, `std::valarray`, `std::set`, `std::unordered_set`, + `std::multiset`, and `std::unordered_multiset` with a `value_type` from + which a @ref basic_json value can be constructed. + - **objects**: @ref object_t and all kinds of compatible associative + containers such as `std::map`, `std::unordered_map`, `std::multimap`, + and `std::unordered_multimap` with a `key_type` compatible to + @ref string_t and a `value_type` from which a @ref basic_json value can + be constructed. + - **strings**: @ref string_t, string literals, and all compatible string + containers can be used. + - **numbers**: @ref number_integer_t, @ref number_unsigned_t, + @ref number_float_t, and all convertible number types such as `int`, + `size_t`, `int64_t`, `float` or `double` can be used. + - **boolean**: @ref boolean_t / `bool` can be used. + - **binary**: @ref binary_t / `std::vector` may be used, + unfortunately because string literals cannot be distinguished from binary + character arrays by the C++ type system, all types compatible with `const + char*` will be directed to the string constructor instead. This is both + for backwards compatibility, and due to the fact that a binary type is not + a standard JSON type. + + See the examples below. + + @tparam CompatibleType a type such that: + - @a CompatibleType is not derived from `std::istream`, + - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move + constructors), + - @a CompatibleType is not a different @ref basic_json type (i.e. with different template arguments) + - @a CompatibleType is not a @ref basic_json nested type (e.g., + @ref json_pointer, @ref iterator, etc ...) + - @ref @ref json_serializer has a + `to_json(basic_json_t&, CompatibleType&&)` method + + @tparam U = `uncvref_t` + + @param[in] val the value to be forwarded to the respective constructor + + @complexity Usually linear in the size of the passed @a val, also + depending on the implementation of the called `to_json()` + method. + + @exceptionsafety Depends on the called constructor. For types directly + supported by the library (i.e., all types for which no `to_json()` function + was provided), strong guarantee holds: if an exception is thrown, there are + no changes to any JSON value. + + @liveexample{The following code shows the constructor with several + compatible types.,basic_json__CompatibleType} + + @since version 2.1.0 + */ + template < typename CompatibleType, + typename U = detail::uncvref_t, + detail::enable_if_t < + !detail::is_basic_json::value && detail::is_compatible_type::value, int > = 0 > + basic_json(CompatibleType && val) noexcept(noexcept( + JSONSerializer::to_json(std::declval(), + std::forward(val)))) + { + JSONSerializer::to_json(*this, std::forward(val)); + assert_invariant(); + } + + /*! + @brief create a JSON value from an existing one + + This is a constructor for existing @ref basic_json types. + It does not hijack copy/move constructors, since the parameter has different + template arguments than the current ones. + + The constructor tries to convert the internal @ref m_value of the parameter. + + @tparam BasicJsonType a type such that: + - @a BasicJsonType is a @ref basic_json type. + - @a BasicJsonType has different template arguments than @ref basic_json_t. + + @param[in] val the @ref basic_json value to be converted. + + @complexity Usually linear in the size of the passed @a val, also + depending on the implementation of the called `to_json()` + method. + + @exceptionsafety Depends on the called constructor. For types directly + supported by the library (i.e., all types for which no `to_json()` function + was provided), strong guarantee holds: if an exception is thrown, there are + no changes to any JSON value. + + @since version 3.2.0 + */ + template < typename BasicJsonType, + detail::enable_if_t < + detail::is_basic_json::value&& !std::is_same::value, int > = 0 > + basic_json(const BasicJsonType& val) + { + using other_boolean_t = typename BasicJsonType::boolean_t; + using other_number_float_t = typename BasicJsonType::number_float_t; + using other_number_integer_t = typename BasicJsonType::number_integer_t; + using other_number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using other_string_t = typename BasicJsonType::string_t; + using other_object_t = typename BasicJsonType::object_t; + using other_array_t = typename BasicJsonType::array_t; + using other_binary_t = typename BasicJsonType::binary_t; + + switch (val.type()) + { + case value_t::boolean: + JSONSerializer::to_json(*this, val.template get()); + break; + case value_t::number_float: + JSONSerializer::to_json(*this, val.template get()); + break; + case value_t::number_integer: + JSONSerializer::to_json(*this, val.template get()); + break; + case value_t::number_unsigned: + JSONSerializer::to_json(*this, val.template get()); + break; + case value_t::string: + JSONSerializer::to_json(*this, val.template get_ref()); + break; + case value_t::object: + JSONSerializer::to_json(*this, val.template get_ref()); + break; + case value_t::array: + JSONSerializer::to_json(*this, val.template get_ref()); + break; + case value_t::binary: + JSONSerializer::to_json(*this, val.template get_ref()); + break; + case value_t::null: + *this = nullptr; + break; + case value_t::discarded: + m_type = value_t::discarded; + break; + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + assert_invariant(); + } + + /*! + @brief create a container (array or object) from an initializer list + + Creates a JSON value of type array or object from the passed initializer + list @a init. In case @a type_deduction is `true` (default), the type of + the JSON value to be created is deducted from the initializer list @a init + according to the following rules: + + 1. If the list is empty, an empty JSON object value `{}` is created. + 2. If the list consists of pairs whose first element is a string, a JSON + object value is created where the first elements of the pairs are + treated as keys and the second elements are as values. + 3. In all other cases, an array is created. + + The rules aim to create the best fit between a C++ initializer list and + JSON values. The rationale is as follows: + + 1. The empty initializer list is written as `{}` which is exactly an empty + JSON object. + 2. C++ has no way of describing mapped types other than to list a list of + pairs. As JSON requires that keys must be of type string, rule 2 is the + weakest constraint one can pose on initializer lists to interpret them + as an object. + 3. In all other cases, the initializer list could not be interpreted as + JSON object type, so interpreting it as JSON array type is safe. + + With the rules described above, the following JSON values cannot be + expressed by an initializer list: + + - the empty array (`[]`): use @ref array(initializer_list_t) + with an empty initializer list in this case + - arrays whose elements satisfy rule 2: use @ref + array(initializer_list_t) with the same initializer list + in this case + + @note When used without parentheses around an empty initializer list, @ref + basic_json() is called instead of this function, yielding the JSON null + value. + + @param[in] init initializer list with JSON values + + @param[in] type_deduction internal parameter; when set to `true`, the type + of the JSON value is deducted from the initializer list @a init; when set + to `false`, the type provided via @a manual_type is forced. This mode is + used by the functions @ref array(initializer_list_t) and + @ref object(initializer_list_t). + + @param[in] manual_type internal parameter; when @a type_deduction is set + to `false`, the created JSON value will use the provided type (only @ref + value_t::array and @ref value_t::object are valid); when @a type_deduction + is set to `true`, this parameter has no effect + + @throw type_error.301 if @a type_deduction is `false`, @a manual_type is + `value_t::object`, but @a init contains an element which is not a pair + whose first element is a string. In this case, the constructor could not + create an object. If @a type_deduction would have be `true`, an array + would have been created. See @ref object(initializer_list_t) + for an example. + + @complexity Linear in the size of the initializer list @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The example below shows how JSON values are created from + initializer lists.,basic_json__list_init_t} + + @sa @ref array(initializer_list_t) -- create a JSON array + value from an initializer list + @sa @ref object(initializer_list_t) -- create a JSON object + value from an initializer list + + @since version 1.0.0 + */ + basic_json(initializer_list_t init, + bool type_deduction = true, + value_t manual_type = value_t::array) + { + // check if each element is an array with two elements whose first + // element is a string + bool is_an_object = std::all_of(init.begin(), init.end(), + [](const detail::json_ref& element_ref) + { + return element_ref->is_array() && element_ref->size() == 2 && (*element_ref)[0].is_string(); + }); + + // adjust type if type deduction is not wanted + if (!type_deduction) + { + // if array is wanted, do not create an object though possible + if (manual_type == value_t::array) + { + is_an_object = false; + } + + // if object is wanted but impossible, throw an exception + if (JSON_HEDLEY_UNLIKELY(manual_type == value_t::object && !is_an_object)) + { + JSON_THROW(type_error::create(301, "cannot create object from initializer list")); + } + } + + if (is_an_object) + { + // the initializer list is a list of pairs -> create object + m_type = value_t::object; + m_value = value_t::object; + + std::for_each(init.begin(), init.end(), [this](const detail::json_ref& element_ref) + { + auto element = element_ref.moved_or_copied(); + m_value.object->emplace( + std::move(*((*element.m_value.array)[0].m_value.string)), + std::move((*element.m_value.array)[1])); + }); + } + else + { + // the initializer list describes an array -> create array + m_type = value_t::array; + m_value.array = create(init.begin(), init.end()); + } + + assert_invariant(); + } + + /*! + @brief explicitly create a binary array (without subtype) + + Creates a JSON binary array value from a given binary container. Binary + values are part of various binary formats, such as CBOR, MessagePack, and + BSON. This constructor is used to create a value for serialization to those + formats. + + @note Note, this function exists because of the difficulty in correctly + specifying the correct template overload in the standard value ctor, as both + JSON arrays and JSON binary arrays are backed with some form of a + `std::vector`. Because JSON binary arrays are a non-standard extension it + was decided that it would be best to prevent automatic initialization of a + binary array type, for backwards compatibility and so it does not happen on + accident. + + @param[in] init container containing bytes to use as binary type + + @return JSON binary array value + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @since version 3.8.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json binary(const typename binary_t::container_type& init) + { + auto res = basic_json(); + res.m_type = value_t::binary; + res.m_value = init; + return res; + } + + /*! + @brief explicitly create a binary array (with subtype) + + Creates a JSON binary array value from a given binary container. Binary + values are part of various binary formats, such as CBOR, MessagePack, and + BSON. This constructor is used to create a value for serialization to those + formats. + + @note Note, this function exists because of the difficulty in correctly + specifying the correct template overload in the standard value ctor, as both + JSON arrays and JSON binary arrays are backed with some form of a + `std::vector`. Because JSON binary arrays are a non-standard extension it + was decided that it would be best to prevent automatic initialization of a + binary array type, for backwards compatibility and so it does not happen on + accident. + + @param[in] init container containing bytes to use as binary type + @param[in] subtype subtype to use in MessagePack and BSON + + @return JSON binary array value + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @since version 3.8.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json binary(const typename binary_t::container_type& init, std::uint8_t subtype) + { + auto res = basic_json(); + res.m_type = value_t::binary; + res.m_value = binary_t(init, subtype); + return res; + } + + /// @copydoc binary(const typename binary_t::container_type&) + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json binary(typename binary_t::container_type&& init) + { + auto res = basic_json(); + res.m_type = value_t::binary; + res.m_value = std::move(init); + return res; + } + + /// @copydoc binary(const typename binary_t::container_type&, std::uint8_t) + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json binary(typename binary_t::container_type&& init, std::uint8_t subtype) + { + auto res = basic_json(); + res.m_type = value_t::binary; + res.m_value = binary_t(std::move(init), subtype); + return res; + } + + /*! + @brief explicitly create an array from an initializer list + + Creates a JSON array value from a given initializer list. That is, given a + list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the + initializer list is empty, the empty array `[]` is created. + + @note This function is only needed to express two edge cases that cannot + be realized with the initializer list constructor (@ref + basic_json(initializer_list_t, bool, value_t)). These cases + are: + 1. creating an array whose elements are all pairs whose first element is a + string -- in this case, the initializer list constructor would create an + object, taking the first elements as keys + 2. creating an empty array -- passing the empty initializer list to the + initializer list constructor yields an empty object + + @param[in] init initializer list with JSON values to create an array from + (optional) + + @return JSON array value + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows an example for the `array` + function.,array} + + @sa @ref basic_json(initializer_list_t, bool, value_t) -- + create a JSON value from an initializer list + @sa @ref object(initializer_list_t) -- create a JSON object + value from an initializer list + + @since version 1.0.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json array(initializer_list_t init = {}) + { + return basic_json(init, false, value_t::array); + } + + /*! + @brief explicitly create an object from an initializer list + + Creates a JSON object value from a given initializer list. The initializer + lists elements must be pairs, and their first elements must be strings. If + the initializer list is empty, the empty object `{}` is created. + + @note This function is only added for symmetry reasons. In contrast to the + related function @ref array(initializer_list_t), there are + no cases which can only be expressed by this function. That is, any + initializer list @a init can also be passed to the initializer list + constructor @ref basic_json(initializer_list_t, bool, value_t). + + @param[in] init initializer list to create an object from (optional) + + @return JSON object value + + @throw type_error.301 if @a init is not a list of pairs whose first + elements are strings. In this case, no object can be created. When such a + value is passed to @ref basic_json(initializer_list_t, bool, value_t), + an array would have been created from the passed initializer list @a init. + See example below. + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows an example for the `object` + function.,object} + + @sa @ref basic_json(initializer_list_t, bool, value_t) -- + create a JSON value from an initializer list + @sa @ref array(initializer_list_t) -- create a JSON array + value from an initializer list + + @since version 1.0.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json object(initializer_list_t init = {}) + { + return basic_json(init, false, value_t::object); + } + + /*! + @brief construct an array with count copies of given value + + Constructs a JSON array value by creating @a cnt copies of a passed value. + In case @a cnt is `0`, an empty array is created. + + @param[in] cnt the number of JSON copies of @a val to create + @param[in] val the JSON value to copy + + @post `std::distance(begin(),end()) == cnt` holds. + + @complexity Linear in @a cnt. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows examples for the @ref + basic_json(size_type\, const basic_json&) + constructor.,basic_json__size_type_basic_json} + + @since version 1.0.0 + */ + basic_json(size_type cnt, const basic_json& val) + : m_type(value_t::array) + { + m_value.array = create(cnt, val); + assert_invariant(); + } + + /*! + @brief construct a JSON container given an iterator range + + Constructs the JSON value with the contents of the range `[first, last)`. + The semantics depends on the different types a JSON value can have: + - In case of a null type, invalid_iterator.206 is thrown. + - In case of other primitive types (number, boolean, or string), @a first + must be `begin()` and @a last must be `end()`. In this case, the value is + copied. Otherwise, invalid_iterator.204 is thrown. + - In case of structured types (array, object), the constructor behaves as + similar versions for `std::vector` or `std::map`; that is, a JSON array + or object is constructed from the values in the range. + + @tparam InputIT an input iterator type (@ref iterator or @ref + const_iterator) + + @param[in] first begin of the range to copy from (included) + @param[in] last end of the range to copy from (excluded) + + @pre Iterators @a first and @a last must be initialized. **This + precondition is enforced with an assertion (see warning).** If + assertions are switched off, a violation of this precondition yields + undefined behavior. + + @pre Range `[first, last)` is valid. Usually, this precondition cannot be + checked efficiently. Only certain edge cases are detected; see the + description of the exceptions below. A violation of this precondition + yields undefined behavior. + + @warning A precondition is enforced with a runtime assertion that will + result in calling `std::abort` if this precondition is not met. + Assertions can be disabled by defining `NDEBUG` at compile time. + See https://en.cppreference.com/w/cpp/error/assert for more + information. + + @throw invalid_iterator.201 if iterators @a first and @a last are not + compatible (i.e., do not belong to the same JSON value). In this case, + the range `[first, last)` is undefined. + @throw invalid_iterator.204 if iterators @a first and @a last belong to a + primitive type (number, boolean, or string), but @a first does not point + to the first element any more. In this case, the range `[first, last)` is + undefined. See example code below. + @throw invalid_iterator.206 if iterators @a first and @a last belong to a + null value. In this case, the range `[first, last)` is undefined. + + @complexity Linear in distance between @a first and @a last. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The example below shows several ways to create JSON values by + specifying a subrange with iterators.,basic_json__InputIt_InputIt} + + @since version 1.0.0 + */ + template < class InputIT, typename std::enable_if < + std::is_same::value || + std::is_same::value, int >::type = 0 > + basic_json(InputIT first, InputIT last) + { + JSON_ASSERT(first.m_object != nullptr); + JSON_ASSERT(last.m_object != nullptr); + + // make sure iterator fits the current value + if (JSON_HEDLEY_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(201, "iterators are not compatible")); + } + + // copy type from first iterator + m_type = first.m_object->m_type; + + // check if iterator range is complete for primitive values + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + { + if (JSON_HEDLEY_UNLIKELY(!first.m_it.primitive_iterator.is_begin() + || !last.m_it.primitive_iterator.is_end())) + { + JSON_THROW(invalid_iterator::create(204, "iterators out of range")); + } + break; + } + + default: + break; + } + + switch (m_type) + { + case value_t::number_integer: + { + m_value.number_integer = first.m_object->m_value.number_integer; + break; + } + + case value_t::number_unsigned: + { + m_value.number_unsigned = first.m_object->m_value.number_unsigned; + break; + } + + case value_t::number_float: + { + m_value.number_float = first.m_object->m_value.number_float; + break; + } + + case value_t::boolean: + { + m_value.boolean = first.m_object->m_value.boolean; + break; + } + + case value_t::string: + { + m_value = *first.m_object->m_value.string; + break; + } + + case value_t::object: + { + m_value.object = create(first.m_it.object_iterator, + last.m_it.object_iterator); + break; + } + + case value_t::array: + { + m_value.array = create(first.m_it.array_iterator, + last.m_it.array_iterator); + break; + } + + case value_t::binary: + { + m_value = *first.m_object->m_value.binary; + break; + } + + default: + JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " + + std::string(first.m_object->type_name()))); + } + + assert_invariant(); + } + + + /////////////////////////////////////// + // other constructors and destructor // + /////////////////////////////////////// + + template, + std::is_same>::value, int> = 0 > + basic_json(const JsonRef& ref) : basic_json(ref.moved_or_copied()) {} + + /*! + @brief copy constructor + + Creates a copy of a given JSON value. + + @param[in] other the JSON value to copy + + @post `*this == other` + + @complexity Linear in the size of @a other. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + - As postcondition, it holds: `other == basic_json(other)`. + + @liveexample{The following code shows an example for the copy + constructor.,basic_json__basic_json} + + @since version 1.0.0 + */ + basic_json(const basic_json& other) + : m_type(other.m_type) + { + // check of passed value is valid + other.assert_invariant(); + + switch (m_type) + { + case value_t::object: + { + m_value = *other.m_value.object; + break; + } + + case value_t::array: + { + m_value = *other.m_value.array; + break; + } + + case value_t::string: + { + m_value = *other.m_value.string; + break; + } + + case value_t::boolean: + { + m_value = other.m_value.boolean; + break; + } + + case value_t::number_integer: + { + m_value = other.m_value.number_integer; + break; + } + + case value_t::number_unsigned: + { + m_value = other.m_value.number_unsigned; + break; + } + + case value_t::number_float: + { + m_value = other.m_value.number_float; + break; + } + + case value_t::binary: + { + m_value = *other.m_value.binary; + break; + } + + default: + break; + } + + assert_invariant(); + } + + /*! + @brief move constructor + + Move constructor. Constructs a JSON value with the contents of the given + value @a other using move semantics. It "steals" the resources from @a + other and leaves it as JSON null value. + + @param[in,out] other value to move to this object + + @post `*this` has the same value as @a other before the call. + @post @a other is a JSON null value. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this constructor never throws + exceptions. + + @requirement This function helps `basic_json` satisfying the + [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible) + requirements. + + @liveexample{The code below shows the move constructor explicitly called + via std::move.,basic_json__moveconstructor} + + @since version 1.0.0 + */ + basic_json(basic_json&& other) noexcept + : m_type(std::move(other.m_type)), + m_value(std::move(other.m_value)) + { + // check that passed value is valid + other.assert_invariant(); + + // invalidate payload + other.m_type = value_t::null; + other.m_value = {}; + + assert_invariant(); + } + + /*! + @brief copy assignment + + Copy assignment operator. Copies a JSON value via the "copy and swap" + strategy: It is expressed in terms of the copy constructor, destructor, + and the `swap()` member function. + + @param[in] other value to copy from + + @complexity Linear. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + + @liveexample{The code below shows and example for the copy assignment. It + creates a copy of value `a` which is then swapped with `b`. Finally\, the + copy of `a` (which is the null value after the swap) is + destroyed.,basic_json__copyassignment} + + @since version 1.0.0 + */ + basic_json& operator=(basic_json other) noexcept ( + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value&& + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value + ) + { + // check that passed value is valid + other.assert_invariant(); + + using std::swap; + swap(m_type, other.m_type); + swap(m_value, other.m_value); + + assert_invariant(); + return *this; + } + + /*! + @brief destructor + + Destroys the JSON value and frees all allocated memory. + + @complexity Linear. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + - All stored elements are destroyed and all memory is freed. + + @since version 1.0.0 + */ + ~basic_json() noexcept + { + assert_invariant(); + m_value.destroy(m_type); + } + + /// @} + + public: + /////////////////////// + // object inspection // + /////////////////////// + + /// @name object inspection + /// Functions to inspect the type of a JSON value. + /// @{ + + /*! + @brief serialization + + Serialization function for JSON values. The function tries to mimic + Python's `json.dumps()` function, and currently supports its @a indent + and @a ensure_ascii parameters. + + @param[in] indent If indent is nonnegative, then array elements and object + members will be pretty-printed with that indent level. An indent level of + `0` will only insert newlines. `-1` (the default) selects the most compact + representation. + @param[in] indent_char The character to use for indentation if @a indent is + greater than `0`. The default is ` ` (space). + @param[in] ensure_ascii If @a ensure_ascii is true, all non-ASCII characters + in the output are escaped with `\uXXXX` sequences, and the result consists + of ASCII characters only. + @param[in] error_handler how to react on decoding errors; there are three + possible values: `strict` (throws and exception in case a decoding error + occurs; default), `replace` (replace invalid UTF-8 sequences with U+FFFD), + and `ignore` (ignore invalid UTF-8 sequences during serialization; all + bytes are copied to the output unchanged). + + @return string containing the serialization of the JSON value + + @throw type_error.316 if a string stored inside the JSON value is not + UTF-8 encoded and @a error_handler is set to strict + + @note Binary values are serialized as object containing two keys: + - "bytes": an array of bytes as integers + - "subtype": the subtype as integer or "null" if the binary has no subtype + + @complexity Linear. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @liveexample{The following example shows the effect of different @a indent\, + @a indent_char\, and @a ensure_ascii parameters to the result of the + serialization.,dump} + + @see https://docs.python.org/2/library/json.html#json.dump + + @since version 1.0.0; indentation character @a indent_char, option + @a ensure_ascii and exceptions added in version 3.0.0; error + handlers added in version 3.4.0; serialization of binary values added + in version 3.8.0. + */ + string_t dump(const int indent = -1, + const char indent_char = ' ', + const bool ensure_ascii = false, + const error_handler_t error_handler = error_handler_t::strict) const + { + string_t result; + serializer s(detail::output_adapter(result), indent_char, error_handler); + + if (indent >= 0) + { + s.dump(*this, true, ensure_ascii, static_cast(indent)); + } + else + { + s.dump(*this, false, ensure_ascii, 0); + } + + return result; + } + + /*! + @brief return the type of the JSON value (explicit) + + Return the type of the JSON value as a value from the @ref value_t + enumeration. + + @return the type of the JSON value + Value type | return value + ------------------------- | ------------------------- + null | value_t::null + boolean | value_t::boolean + string | value_t::string + number (integer) | value_t::number_integer + number (unsigned integer) | value_t::number_unsigned + number (floating-point) | value_t::number_float + object | value_t::object + array | value_t::array + binary | value_t::binary + discarded | value_t::discarded + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `type()` for all JSON + types.,type} + + @sa @ref operator value_t() -- return the type of the JSON value (implicit) + @sa @ref type_name() -- return the type as string + + @since version 1.0.0 + */ + constexpr value_t type() const noexcept + { + return m_type; + } + + /*! + @brief return whether type is primitive + + This function returns true if and only if the JSON type is primitive + (string, number, boolean, or null). + + @return `true` if type is primitive (string, number, boolean, or null), + `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_primitive()` for all JSON + types.,is_primitive} + + @sa @ref is_structured() -- returns whether JSON value is structured + @sa @ref is_null() -- returns whether JSON value is `null` + @sa @ref is_string() -- returns whether JSON value is a string + @sa @ref is_boolean() -- returns whether JSON value is a boolean + @sa @ref is_number() -- returns whether JSON value is a number + @sa @ref is_binary() -- returns whether JSON value is a binary array + + @since version 1.0.0 + */ + constexpr bool is_primitive() const noexcept + { + return is_null() || is_string() || is_boolean() || is_number() || is_binary(); + } + + /*! + @brief return whether type is structured + + This function returns true if and only if the JSON type is structured + (array or object). + + @return `true` if type is structured (array or object), `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_structured()` for all JSON + types.,is_structured} + + @sa @ref is_primitive() -- returns whether value is primitive + @sa @ref is_array() -- returns whether value is an array + @sa @ref is_object() -- returns whether value is an object + + @since version 1.0.0 + */ + constexpr bool is_structured() const noexcept + { + return is_array() || is_object(); + } + + /*! + @brief return whether value is null + + This function returns true if and only if the JSON value is null. + + @return `true` if type is null, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_null()` for all JSON + types.,is_null} + + @since version 1.0.0 + */ + constexpr bool is_null() const noexcept + { + return m_type == value_t::null; + } + + /*! + @brief return whether value is a boolean + + This function returns true if and only if the JSON value is a boolean. + + @return `true` if type is boolean, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_boolean()` for all JSON + types.,is_boolean} + + @since version 1.0.0 + */ + constexpr bool is_boolean() const noexcept + { + return m_type == value_t::boolean; + } + + /*! + @brief return whether value is a number + + This function returns true if and only if the JSON value is a number. This + includes both integer (signed and unsigned) and floating-point values. + + @return `true` if type is number (regardless whether integer, unsigned + integer or floating-type), `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number()` for all JSON + types.,is_number} + + @sa @ref is_number_integer() -- check if value is an integer or unsigned + integer number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 1.0.0 + */ + constexpr bool is_number() const noexcept + { + return is_number_integer() || is_number_float(); + } + + /*! + @brief return whether value is an integer number + + This function returns true if and only if the JSON value is a signed or + unsigned integer number. This excludes floating-point values. + + @return `true` if type is an integer or unsigned integer number, `false` + otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_integer()` for all + JSON types.,is_number_integer} + + @sa @ref is_number() -- check if value is a number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 1.0.0 + */ + constexpr bool is_number_integer() const noexcept + { + return m_type == value_t::number_integer || m_type == value_t::number_unsigned; + } + + /*! + @brief return whether value is an unsigned integer number + + This function returns true if and only if the JSON value is an unsigned + integer number. This excludes floating-point and signed integer values. + + @return `true` if type is an unsigned integer number, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_unsigned()` for all + JSON types.,is_number_unsigned} + + @sa @ref is_number() -- check if value is a number + @sa @ref is_number_integer() -- check if value is an integer or unsigned + integer number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 2.0.0 + */ + constexpr bool is_number_unsigned() const noexcept + { + return m_type == value_t::number_unsigned; + } + + /*! + @brief return whether value is a floating-point number + + This function returns true if and only if the JSON value is a + floating-point number. This excludes signed and unsigned integer values. + + @return `true` if type is a floating-point number, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_float()` for all + JSON types.,is_number_float} + + @sa @ref is_number() -- check if value is number + @sa @ref is_number_integer() -- check if value is an integer number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + + @since version 1.0.0 + */ + constexpr bool is_number_float() const noexcept + { + return m_type == value_t::number_float; + } + + /*! + @brief return whether value is an object + + This function returns true if and only if the JSON value is an object. + + @return `true` if type is object, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_object()` for all JSON + types.,is_object} + + @since version 1.0.0 + */ + constexpr bool is_object() const noexcept + { + return m_type == value_t::object; + } + + /*! + @brief return whether value is an array + + This function returns true if and only if the JSON value is an array. + + @return `true` if type is array, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_array()` for all JSON + types.,is_array} + + @since version 1.0.0 + */ + constexpr bool is_array() const noexcept + { + return m_type == value_t::array; + } + + /*! + @brief return whether value is a string + + This function returns true if and only if the JSON value is a string. + + @return `true` if type is string, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_string()` for all JSON + types.,is_string} + + @since version 1.0.0 + */ + constexpr bool is_string() const noexcept + { + return m_type == value_t::string; + } + + /*! + @brief return whether value is a binary array + + This function returns true if and only if the JSON value is a binary array. + + @return `true` if type is binary array, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_binary()` for all JSON + types.,is_binary} + + @since version 3.8.0 + */ + constexpr bool is_binary() const noexcept + { + return m_type == value_t::binary; + } + + /*! + @brief return whether value is discarded + + This function returns true if and only if the JSON value was discarded + during parsing with a callback function (see @ref parser_callback_t). + + @note This function will always be `false` for JSON values after parsing. + That is, discarded values can only occur during parsing, but will be + removed when inside a structured value or replaced by null in other cases. + + @return `true` if type is discarded, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_discarded()` for all JSON + types.,is_discarded} + + @since version 1.0.0 + */ + constexpr bool is_discarded() const noexcept + { + return m_type == value_t::discarded; + } + + /*! + @brief return the type of the JSON value (implicit) + + Implicitly return the type of the JSON value as a value from the @ref + value_t enumeration. + + @return the type of the JSON value + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies the @ref value_t operator for + all JSON types.,operator__value_t} + + @sa @ref type() -- return the type of the JSON value (explicit) + @sa @ref type_name() -- return the type as string + + @since version 1.0.0 + */ + constexpr operator value_t() const noexcept + { + return m_type; + } + + /// @} + + private: + ////////////////// + // value access // + ////////////////// + + /// get a boolean (explicit) + boolean_t get_impl(boolean_t* /*unused*/) const + { + if (JSON_HEDLEY_LIKELY(is_boolean())) + { + return m_value.boolean; + } + + JSON_THROW(type_error::create(302, "type must be boolean, but is " + std::string(type_name()))); + } + + /// get a pointer to the value (object) + object_t* get_impl_ptr(object_t* /*unused*/) noexcept + { + return is_object() ? m_value.object : nullptr; + } + + /// get a pointer to the value (object) + constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept + { + return is_object() ? m_value.object : nullptr; + } + + /// get a pointer to the value (array) + array_t* get_impl_ptr(array_t* /*unused*/) noexcept + { + return is_array() ? m_value.array : nullptr; + } + + /// get a pointer to the value (array) + constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept + { + return is_array() ? m_value.array : nullptr; + } + + /// get a pointer to the value (string) + string_t* get_impl_ptr(string_t* /*unused*/) noexcept + { + return is_string() ? m_value.string : nullptr; + } + + /// get a pointer to the value (string) + constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept + { + return is_string() ? m_value.string : nullptr; + } + + /// get a pointer to the value (boolean) + boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept + { + return is_boolean() ? &m_value.boolean : nullptr; + } + + /// get a pointer to the value (boolean) + constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept + { + return is_boolean() ? &m_value.boolean : nullptr; + } + + /// get a pointer to the value (integer number) + number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept + { + return is_number_integer() ? &m_value.number_integer : nullptr; + } + + /// get a pointer to the value (integer number) + constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept + { + return is_number_integer() ? &m_value.number_integer : nullptr; + } + + /// get a pointer to the value (unsigned number) + number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept + { + return is_number_unsigned() ? &m_value.number_unsigned : nullptr; + } + + /// get a pointer to the value (unsigned number) + constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept + { + return is_number_unsigned() ? &m_value.number_unsigned : nullptr; + } + + /// get a pointer to the value (floating-point number) + number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept + { + return is_number_float() ? &m_value.number_float : nullptr; + } + + /// get a pointer to the value (floating-point number) + constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept + { + return is_number_float() ? &m_value.number_float : nullptr; + } + + /// get a pointer to the value (binary) + binary_t* get_impl_ptr(binary_t* /*unused*/) noexcept + { + return is_binary() ? m_value.binary : nullptr; + } + + /// get a pointer to the value (binary) + constexpr const binary_t* get_impl_ptr(const binary_t* /*unused*/) const noexcept + { + return is_binary() ? m_value.binary : nullptr; + } + + /*! + @brief helper function to implement get_ref() + + This function helps to implement get_ref() without code duplication for + const and non-const overloads + + @tparam ThisType will be deduced as `basic_json` or `const basic_json` + + @throw type_error.303 if ReferenceType does not match underlying value + type of the current JSON + */ + template + static ReferenceType get_ref_impl(ThisType& obj) + { + // delegate the call to get_ptr<>() + auto ptr = obj.template get_ptr::type>(); + + if (JSON_HEDLEY_LIKELY(ptr != nullptr)) + { + return *ptr; + } + + JSON_THROW(type_error::create(303, "incompatible ReferenceType for get_ref, actual type is " + std::string(obj.type_name()))); + } + + public: + /// @name value access + /// Direct access to the stored value of a JSON value. + /// @{ + + /*! + @brief get special-case overload + + This overloads avoids a lot of template boilerplate, it can be seen as the + identity method + + @tparam BasicJsonType == @ref basic_json + + @return a copy of *this + + @complexity Constant. + + @since version 2.1.0 + */ + template::type, basic_json_t>::value, + int> = 0> + basic_json get() const + { + return *this; + } + + /*! + @brief get special-case overload + + This overloads converts the current @ref basic_json in a different + @ref basic_json type + + @tparam BasicJsonType == @ref basic_json + + @return a copy of *this, converted into @tparam BasicJsonType + + @complexity Depending on the implementation of the called `from_json()` + method. + + @since version 3.2.0 + */ + template < typename BasicJsonType, detail::enable_if_t < + !std::is_same::value&& + detail::is_basic_json::value, int > = 0 > + BasicJsonType get() const + { + return *this; + } + + /*! + @brief get a value (explicit) + + Explicit type conversion between the JSON value and a compatible value + which is [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible) + and [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). + The value is converted by calling the @ref json_serializer + `from_json()` method. + + The function is equivalent to executing + @code {.cpp} + ValueType ret; + JSONSerializer::from_json(*this, ret); + return ret; + @endcode + + This overloads is chosen if: + - @a ValueType is not @ref basic_json, + - @ref json_serializer has a `from_json()` method of the form + `void from_json(const basic_json&, ValueType&)`, and + - @ref json_serializer does not have a `from_json()` method of + the form `ValueType from_json(const basic_json&)` + + @tparam ValueTypeCV the provided value type + @tparam ValueType the returned value type + + @return copy of the JSON value, converted to @a ValueType + + @throw what @ref json_serializer `from_json()` method throws + + @liveexample{The example below shows several conversions from JSON values + to other types. There a few things to note: (1) Floating-point numbers can + be converted to integers\, (2) A JSON array can be converted to a standard + `std::vector`\, (3) A JSON object can be converted to C++ + associative containers such as `std::unordered_map`.,get__ValueType_const} + + @since version 2.1.0 + */ + template < typename ValueTypeCV, typename ValueType = detail::uncvref_t, + detail::enable_if_t < + !detail::is_basic_json::value && + detail::has_from_json::value && + !detail::has_non_default_from_json::value, + int > = 0 > + ValueType get() const noexcept(noexcept( + JSONSerializer::from_json(std::declval(), std::declval()))) + { + // we cannot static_assert on ValueTypeCV being non-const, because + // there is support for get(), which is why we + // still need the uncvref + static_assert(!std::is_reference::value, + "get() cannot be used with reference types, you might want to use get_ref()"); + static_assert(std::is_default_constructible::value, + "types must be DefaultConstructible when used with get()"); + + ValueType ret; + JSONSerializer::from_json(*this, ret); + return ret; + } + + /*! + @brief get a value (explicit); special case + + Explicit type conversion between the JSON value and a compatible value + which is **not** [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible) + and **not** [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). + The value is converted by calling the @ref json_serializer + `from_json()` method. + + The function is equivalent to executing + @code {.cpp} + return JSONSerializer::from_json(*this); + @endcode + + This overloads is chosen if: + - @a ValueType is not @ref basic_json and + - @ref json_serializer has a `from_json()` method of the form + `ValueType from_json(const basic_json&)` + + @note If @ref json_serializer has both overloads of + `from_json()`, this one is chosen. + + @tparam ValueTypeCV the provided value type + @tparam ValueType the returned value type + + @return copy of the JSON value, converted to @a ValueType + + @throw what @ref json_serializer `from_json()` method throws + + @since version 2.1.0 + */ + template < typename ValueTypeCV, typename ValueType = detail::uncvref_t, + detail::enable_if_t < !std::is_same::value && + detail::has_non_default_from_json::value, + int > = 0 > + ValueType get() const noexcept(noexcept( + JSONSerializer::from_json(std::declval()))) + { + static_assert(!std::is_reference::value, + "get() cannot be used with reference types, you might want to use get_ref()"); + return JSONSerializer::from_json(*this); + } + + /*! + @brief get a value (explicit) + + Explicit type conversion between the JSON value and a compatible value. + The value is filled into the input parameter by calling the @ref json_serializer + `from_json()` method. + + The function is equivalent to executing + @code {.cpp} + ValueType v; + JSONSerializer::from_json(*this, v); + @endcode + + This overloads is chosen if: + - @a ValueType is not @ref basic_json, + - @ref json_serializer has a `from_json()` method of the form + `void from_json(const basic_json&, ValueType&)`, and + + @tparam ValueType the input parameter type. + + @return the input parameter, allowing chaining calls. + + @throw what @ref json_serializer `from_json()` method throws + + @liveexample{The example below shows several conversions from JSON values + to other types. There a few things to note: (1) Floating-point numbers can + be converted to integers\, (2) A JSON array can be converted to a standard + `std::vector`\, (3) A JSON object can be converted to C++ + associative containers such as `std::unordered_map`.,get_to} + + @since version 3.3.0 + */ + template < typename ValueType, + detail::enable_if_t < + !detail::is_basic_json::value&& + detail::has_from_json::value, + int > = 0 > + ValueType & get_to(ValueType& v) const noexcept(noexcept( + JSONSerializer::from_json(std::declval(), v))) + { + JSONSerializer::from_json(*this, v); + return v; + } + + // specialization to allow to call get_to with a basic_json value + // see https://github.com/nlohmann/json/issues/2175 + template::value, + int> = 0> + ValueType & get_to(ValueType& v) const + { + v = *this; + return v; + } + + template < + typename T, std::size_t N, + typename Array = T (&)[N], + detail::enable_if_t < + detail::has_from_json::value, int > = 0 > + Array get_to(T (&v)[N]) const + noexcept(noexcept(JSONSerializer::from_json( + std::declval(), v))) + { + JSONSerializer::from_json(*this, v); + return v; + } + + + /*! + @brief get a pointer value (implicit) + + Implicit pointer access to the internally stored JSON value. No copies are + made. + + @warning Writing data to the pointee of the result yields an undefined + state. + + @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref + object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, + @ref number_unsigned_t, or @ref number_float_t. Enforced by a static + assertion. + + @return pointer to the internally stored JSON value if the requested + pointer type @a PointerType fits to the JSON value; `nullptr` otherwise + + @complexity Constant. + + @liveexample{The example below shows how pointers to internal values of a + JSON value can be requested. Note that no type conversions are made and a + `nullptr` is returned if the value and the requested pointer type does not + match.,get_ptr} + + @since version 1.0.0 + */ + template::value, int>::type = 0> + auto get_ptr() noexcept -> decltype(std::declval().get_impl_ptr(std::declval())) + { + // delegate the call to get_impl_ptr<>() + return get_impl_ptr(static_cast(nullptr)); + } + + /*! + @brief get a pointer value (implicit) + @copydoc get_ptr() + */ + template < typename PointerType, typename std::enable_if < + std::is_pointer::value&& + std::is_const::type>::value, int >::type = 0 > + constexpr auto get_ptr() const noexcept -> decltype(std::declval().get_impl_ptr(std::declval())) + { + // delegate the call to get_impl_ptr<>() const + return get_impl_ptr(static_cast(nullptr)); + } + + /*! + @brief get a pointer value (explicit) + + Explicit pointer access to the internally stored JSON value. No copies are + made. + + @warning The pointer becomes invalid if the underlying JSON object + changes. + + @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref + object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, + @ref number_unsigned_t, or @ref number_float_t. + + @return pointer to the internally stored JSON value if the requested + pointer type @a PointerType fits to the JSON value; `nullptr` otherwise + + @complexity Constant. + + @liveexample{The example below shows how pointers to internal values of a + JSON value can be requested. Note that no type conversions are made and a + `nullptr` is returned if the value and the requested pointer type does not + match.,get__PointerType} + + @sa @ref get_ptr() for explicit pointer-member access + + @since version 1.0.0 + */ + template::value, int>::type = 0> + auto get() noexcept -> decltype(std::declval().template get_ptr()) + { + // delegate the call to get_ptr + return get_ptr(); + } + + /*! + @brief get a pointer value (explicit) + @copydoc get() + */ + template::value, int>::type = 0> + constexpr auto get() const noexcept -> decltype(std::declval().template get_ptr()) + { + // delegate the call to get_ptr + return get_ptr(); + } + + /*! + @brief get a reference value (implicit) + + Implicit reference access to the internally stored JSON value. No copies + are made. + + @warning Writing data to the referee of the result yields an undefined + state. + + @tparam ReferenceType reference type; must be a reference to @ref array_t, + @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or + @ref number_float_t. Enforced by static assertion. + + @return reference to the internally stored JSON value if the requested + reference type @a ReferenceType fits to the JSON value; throws + type_error.303 otherwise + + @throw type_error.303 in case passed type @a ReferenceType is incompatible + with the stored JSON value; see example below + + @complexity Constant. + + @liveexample{The example shows several calls to `get_ref()`.,get_ref} + + @since version 1.1.0 + */ + template::value, int>::type = 0> + ReferenceType get_ref() + { + // delegate call to get_ref_impl + return get_ref_impl(*this); + } + + /*! + @brief get a reference value (implicit) + @copydoc get_ref() + */ + template < typename ReferenceType, typename std::enable_if < + std::is_reference::value&& + std::is_const::type>::value, int >::type = 0 > + ReferenceType get_ref() const + { + // delegate call to get_ref_impl + return get_ref_impl(*this); + } + + /*! + @brief get a value (implicit) + + Implicit type conversion between the JSON value and a compatible value. + The call is realized by calling @ref get() const. + + @tparam ValueType non-pointer type compatible to the JSON value, for + instance `int` for JSON integer numbers, `bool` for JSON booleans, or + `std::vector` types for JSON arrays. The character type of @ref string_t + as well as an initializer list of this type is excluded to avoid + ambiguities as these types implicitly convert to `std::string`. + + @return copy of the JSON value, converted to type @a ValueType + + @throw type_error.302 in case passed type @a ValueType is incompatible + to the JSON value type (e.g., the JSON value is of type boolean, but a + string is requested); see example below + + @complexity Linear in the size of the JSON value. + + @liveexample{The example below shows several conversions from JSON values + to other types. There a few things to note: (1) Floating-point numbers can + be converted to integers\, (2) A JSON array can be converted to a standard + `std::vector`\, (3) A JSON object can be converted to C++ + associative containers such as `std::unordered_map`.,operator__ValueType} + + @since version 1.0.0 + */ + template < typename ValueType, typename std::enable_if < + !std::is_pointer::value&& + !std::is_same>::value&& + !std::is_same::value&& + !detail::is_basic_json::value + && !std::is_same>::value +#if defined(JSON_HAS_CPP_17) && (defined(__GNUC__) || (defined(_MSC_VER) && _MSC_VER >= 1910 && _MSC_VER <= 1914)) + && !std::is_same::value +#endif + && detail::is_detected::value + , int >::type = 0 > + JSON_EXPLICIT operator ValueType() const + { + // delegate the call to get<>() const + return get(); + } + + /*! + @return reference to the binary value + + @throw type_error.302 if the value is not binary + + @sa @ref is_binary() to check if the value is binary + + @since version 3.8.0 + */ + binary_t& get_binary() + { + if (!is_binary()) + { + JSON_THROW(type_error::create(302, "type must be binary, but is " + std::string(type_name()))); + } + + return *get_ptr(); + } + + /// @copydoc get_binary() + const binary_t& get_binary() const + { + if (!is_binary()) + { + JSON_THROW(type_error::create(302, "type must be binary, but is " + std::string(type_name()))); + } + + return *get_ptr(); + } + + /// @} + + + //////////////////// + // element access // + //////////////////// + + /// @name element access + /// Access to the JSON value. + /// @{ + + /*! + @brief access specified array element with bounds checking + + Returns a reference to the element at specified location @a idx, with + bounds checking. + + @param[in] idx index of the element to access + + @return reference to the element at index @a idx + + @throw type_error.304 if the JSON value is not an array; in this case, + calling `at` with an index makes no sense. See example below. + @throw out_of_range.401 if the index @a idx is out of range of the array; + that is, `idx >= size()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 1.0.0 + + @liveexample{The example below shows how array elements can be read and + written using `at()`. It also demonstrates the different exceptions that + can be thrown.,at__size_type} + */ + reference at(size_type idx) + { + // at only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + JSON_TRY + { + return m_value.array->at(idx); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified array element with bounds checking + + Returns a const reference to the element at specified location @a idx, + with bounds checking. + + @param[in] idx index of the element to access + + @return const reference to the element at index @a idx + + @throw type_error.304 if the JSON value is not an array; in this case, + calling `at` with an index makes no sense. See example below. + @throw out_of_range.401 if the index @a idx is out of range of the array; + that is, `idx >= size()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 1.0.0 + + @liveexample{The example below shows how array elements can be read using + `at()`. It also demonstrates the different exceptions that can be thrown., + at__size_type_const} + */ + const_reference at(size_type idx) const + { + // at only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + JSON_TRY + { + return m_value.array->at(idx); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified object element with bounds checking + + Returns a reference to the element at with specified key @a key, with + bounds checking. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.304 if the JSON value is not an object; in this case, + calling `at` with a key makes no sense. See example below. + @throw out_of_range.403 if the key @a key is is not stored in the object; + that is, `find(key) == end()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Logarithmic in the size of the container. + + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + + @liveexample{The example below shows how object elements can be read and + written using `at()`. It also demonstrates the different exceptions that + can be thrown.,at__object_t_key_type} + */ + reference at(const typename object_t::key_type& key) + { + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + JSON_TRY + { + return m_value.object->at(key); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified object element with bounds checking + + Returns a const reference to the element at with specified key @a key, + with bounds checking. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @throw type_error.304 if the JSON value is not an object; in this case, + calling `at` with a key makes no sense. See example below. + @throw out_of_range.403 if the key @a key is is not stored in the object; + that is, `find(key) == end()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Logarithmic in the size of the container. + + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + + @liveexample{The example below shows how object elements can be read using + `at()`. It also demonstrates the different exceptions that can be thrown., + at__object_t_key_type_const} + */ + const_reference at(const typename object_t::key_type& key) const + { + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + JSON_TRY + { + return m_value.object->at(key); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified array element + + Returns a reference to the element at specified location @a idx. + + @note If @a idx is beyond the range of the array (i.e., `idx >= size()`), + then the array is silently filled up with `null` values to make `idx` a + valid reference to the last stored element. + + @param[in] idx index of the element to access + + @return reference to the element at index @a idx + + @throw type_error.305 if the JSON value is not an array or null; in that + cases, using the [] operator with an index makes no sense. + + @complexity Constant if @a idx is in the range of the array. Otherwise + linear in `idx - size()`. + + @liveexample{The example below shows how array elements can be read and + written using `[]` operator. Note the addition of `null` + values.,operatorarray__size_type} + + @since version 1.0.0 + */ + reference operator[](size_type idx) + { + // implicitly convert null value to an empty array + if (is_null()) + { + m_type = value_t::array; + m_value.array = create(); + assert_invariant(); + } + + // operator[] only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + // fill up array with null values if given idx is outside range + if (idx >= m_value.array->size()) + { + m_value.array->insert(m_value.array->end(), + idx - m_value.array->size() + 1, + basic_json()); + } + + return m_value.array->operator[](idx); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a numeric argument with " + std::string(type_name()))); + } + + /*! + @brief access specified array element + + Returns a const reference to the element at specified location @a idx. + + @param[in] idx index of the element to access + + @return const reference to the element at index @a idx + + @throw type_error.305 if the JSON value is not an array; in that case, + using the [] operator with an index makes no sense. + + @complexity Constant. + + @liveexample{The example below shows how array elements can be read using + the `[]` operator.,operatorarray__size_type_const} + + @since version 1.0.0 + */ + const_reference operator[](size_type idx) const + { + // const operator[] only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + return m_value.array->operator[](idx); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a numeric argument with " + std::string(type_name()))); + } + + /*! + @brief access specified object element + + Returns a reference to the element at with specified key @a key. + + @note If @a key is not found in the object, then it is silently added to + the object and filled with a `null` value to make `key` a valid reference. + In case the value was `null` before, it is converted to an object. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.305 if the JSON value is not an object or null; in that + cases, using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read and + written using the `[]` operator.,operatorarray__key_type} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + */ + reference operator[](const typename object_t::key_type& key) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create(); + assert_invariant(); + } + + // operator[] only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + return m_value.object->operator[](key); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()))); + } + + /*! + @brief read-only access specified object element + + Returns a const reference to the element at with specified key @a key. No + bounds checking is performed. + + @warning If the element with key @a key does not exist, the behavior is + undefined. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @pre The element with key @a key must exist. **This precondition is + enforced with an assertion.** + + @throw type_error.305 if the JSON value is not an object; in that case, + using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read using + the `[]` operator.,operatorarray__key_type_const} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + */ + const_reference operator[](const typename object_t::key_type& key) const + { + // const operator[] only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + JSON_ASSERT(m_value.object->find(key) != m_value.object->end()); + return m_value.object->find(key)->second; + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()))); + } + + /*! + @brief access specified object element + + Returns a reference to the element at with specified key @a key. + + @note If @a key is not found in the object, then it is silently added to + the object and filled with a `null` value to make `key` a valid reference. + In case the value was `null` before, it is converted to an object. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.305 if the JSON value is not an object or null; in that + cases, using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read and + written using the `[]` operator.,operatorarray__key_type} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.1.0 + */ + template + JSON_HEDLEY_NON_NULL(2) + reference operator[](T* key) + { + // implicitly convert null to object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + return m_value.object->operator[](key); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()))); + } + + /*! + @brief read-only access specified object element + + Returns a const reference to the element at with specified key @a key. No + bounds checking is performed. + + @warning If the element with key @a key does not exist, the behavior is + undefined. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @pre The element with key @a key must exist. **This precondition is + enforced with an assertion.** + + @throw type_error.305 if the JSON value is not an object; in that case, + using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read using + the `[]` operator.,operatorarray__key_type_const} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.1.0 + */ + template + JSON_HEDLEY_NON_NULL(2) + const_reference operator[](T* key) const + { + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + JSON_ASSERT(m_value.object->find(key) != m_value.object->end()); + return m_value.object->find(key)->second; + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()))); + } + + /*! + @brief access specified object element with default value + + Returns either a copy of an object's element at the specified key @a key + or a given default value if no element with key @a key exists. + + The function is basically equivalent to executing + @code {.cpp} + try { + return at(key); + } catch(out_of_range) { + return default_value; + } + @endcode + + @note Unlike @ref at(const typename object_t::key_type&), this function + does not throw if the given key @a key was not found. + + @note Unlike @ref operator[](const typename object_t::key_type& key), this + function does not implicitly add an element to the position defined by @a + key. This function is furthermore also applicable to const objects. + + @param[in] key key of the element to access + @param[in] default_value the value to return if @a key is not found + + @tparam ValueType type compatible to JSON values, for instance `int` for + JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for + JSON arrays. Note the type of the expected value at @a key and the default + value @a default_value must be compatible. + + @return copy of the element at key @a key or @a default_value if @a key + is not found + + @throw type_error.302 if @a default_value does not match the type of the + value at @a key + @throw type_error.306 if the JSON value is not an object; in that case, + using `value()` with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be queried + with a default value.,basic_json__value} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + + @since version 1.0.0 + */ + // using std::is_convertible in a std::enable_if will fail when using explicit conversions + template < class ValueType, typename std::enable_if < + detail::is_getable::value + && !std::is_same::value, int >::type = 0 > + ValueType value(const typename object_t::key_type& key, const ValueType& default_value) const + { + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + // if key is found, return value and given default value otherwise + const auto it = find(key); + if (it != end()) + { + return it->template get(); + } + + return default_value; + } + + JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()))); + } + + /*! + @brief overload for a default value of type const char* + @copydoc basic_json::value(const typename object_t::key_type&, const ValueType&) const + */ + string_t value(const typename object_t::key_type& key, const char* default_value) const + { + return value(key, string_t(default_value)); + } + + /*! + @brief access specified object element via JSON Pointer with default value + + Returns either a copy of an object's element at the specified key @a key + or a given default value if no element with key @a key exists. + + The function is basically equivalent to executing + @code {.cpp} + try { + return at(ptr); + } catch(out_of_range) { + return default_value; + } + @endcode + + @note Unlike @ref at(const json_pointer&), this function does not throw + if the given key @a key was not found. + + @param[in] ptr a JSON pointer to the element to access + @param[in] default_value the value to return if @a ptr found no value + + @tparam ValueType type compatible to JSON values, for instance `int` for + JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for + JSON arrays. Note the type of the expected value at @a key and the default + value @a default_value must be compatible. + + @return copy of the element at key @a key or @a default_value if @a key + is not found + + @throw type_error.302 if @a default_value does not match the type of the + value at @a ptr + @throw type_error.306 if the JSON value is not an object; in that case, + using `value()` with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be queried + with a default value.,basic_json__value_ptr} + + @sa @ref operator[](const json_pointer&) for unchecked access by reference + + @since version 2.0.2 + */ + template::value, int>::type = 0> + ValueType value(const json_pointer& ptr, const ValueType& default_value) const + { + // at only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + // if pointer resolves a value, return it or use default value + JSON_TRY + { + return ptr.get_checked(this).template get(); + } + JSON_INTERNAL_CATCH (out_of_range&) + { + return default_value; + } + } + + JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()))); + } + + /*! + @brief overload for a default value of type const char* + @copydoc basic_json::value(const json_pointer&, ValueType) const + */ + JSON_HEDLEY_NON_NULL(3) + string_t value(const json_pointer& ptr, const char* default_value) const + { + return value(ptr, string_t(default_value)); + } + + /*! + @brief access the first element + + Returns a reference to the first element in the container. For a JSON + container `c`, the expression `c.front()` is equivalent to `*c.begin()`. + + @return In case of a structured type (array or object), a reference to the + first element is returned. In case of number, string, boolean, or binary + values, a reference to the value is returned. + + @complexity Constant. + + @pre The JSON value must not be `null` (would throw `std::out_of_range`) + or an empty array or object (undefined behavior, **guarded by + assertions**). + @post The JSON value remains unchanged. + + @throw invalid_iterator.214 when called on `null` value + + @liveexample{The following code shows an example for `front()`.,front} + + @sa @ref back() -- access the last element + + @since version 1.0.0 + */ + reference front() + { + return *begin(); + } + + /*! + @copydoc basic_json::front() + */ + const_reference front() const + { + return *cbegin(); + } + + /*! + @brief access the last element + + Returns a reference to the last element in the container. For a JSON + container `c`, the expression `c.back()` is equivalent to + @code {.cpp} + auto tmp = c.end(); + --tmp; + return *tmp; + @endcode + + @return In case of a structured type (array or object), a reference to the + last element is returned. In case of number, string, boolean, or binary + values, a reference to the value is returned. + + @complexity Constant. + + @pre The JSON value must not be `null` (would throw `std::out_of_range`) + or an empty array or object (undefined behavior, **guarded by + assertions**). + @post The JSON value remains unchanged. + + @throw invalid_iterator.214 when called on a `null` value. See example + below. + + @liveexample{The following code shows an example for `back()`.,back} + + @sa @ref front() -- access the first element + + @since version 1.0.0 + */ + reference back() + { + auto tmp = end(); + --tmp; + return *tmp; + } + + /*! + @copydoc basic_json::back() + */ + const_reference back() const + { + auto tmp = cend(); + --tmp; + return *tmp; + } + + /*! + @brief remove element given an iterator + + Removes the element specified by iterator @a pos. The iterator @a pos must + be valid and dereferenceable. Thus the `end()` iterator (which is valid, + but is not dereferenceable) cannot be used as a value for @a pos. + + If called on a primitive type other than `null`, the resulting JSON value + will be `null`. + + @param[in] pos iterator to the element to remove + @return Iterator following the last removed element. If the iterator @a + pos refers to the last element, the `end()` iterator is returned. + + @tparam IteratorType an @ref iterator or @ref const_iterator + + @post Invalidates iterators and references at or after the point of the + erase, including the `end()` iterator. + + @throw type_error.307 if called on a `null` value; example: `"cannot use + erase() with null"` + @throw invalid_iterator.202 if called on an iterator which does not belong + to the current JSON value; example: `"iterator does not fit current + value"` + @throw invalid_iterator.205 if called on a primitive type with invalid + iterator (i.e., any iterator which is not `begin()`); example: `"iterator + out of range"` + + @complexity The complexity depends on the type: + - objects: amortized constant + - arrays: linear in distance between @a pos and the end of the container + - strings and binary: linear in the length of the member + - other types: constant + + @liveexample{The example shows the result of `erase()` for different JSON + types.,erase__IteratorType} + + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + template < class IteratorType, typename std::enable_if < + std::is_same::value || + std::is_same::value, int >::type + = 0 > + IteratorType erase(IteratorType pos) + { + // make sure iterator fits the current value + if (JSON_HEDLEY_UNLIKELY(this != pos.m_object)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + IteratorType result = end(); + + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + case value_t::binary: + { + if (JSON_HEDLEY_UNLIKELY(!pos.m_it.primitive_iterator.is_begin())) + { + JSON_THROW(invalid_iterator::create(205, "iterator out of range")); + } + + if (is_string()) + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, m_value.string); + std::allocator_traits::deallocate(alloc, m_value.string, 1); + m_value.string = nullptr; + } + else if (is_binary()) + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, m_value.binary); + std::allocator_traits::deallocate(alloc, m_value.binary, 1); + m_value.binary = nullptr; + } + + m_type = value_t::null; + assert_invariant(); + break; + } + + case value_t::object: + { + result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator); + break; + } + + case value_t::array: + { + result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator); + break; + } + + default: + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + return result; + } + + /*! + @brief remove elements given an iterator range + + Removes the element specified by the range `[first; last)`. The iterator + @a first does not need to be dereferenceable if `first == last`: erasing + an empty range is a no-op. + + If called on a primitive type other than `null`, the resulting JSON value + will be `null`. + + @param[in] first iterator to the beginning of the range to remove + @param[in] last iterator past the end of the range to remove + @return Iterator following the last removed element. If the iterator @a + second refers to the last element, the `end()` iterator is returned. + + @tparam IteratorType an @ref iterator or @ref const_iterator + + @post Invalidates iterators and references at or after the point of the + erase, including the `end()` iterator. + + @throw type_error.307 if called on a `null` value; example: `"cannot use + erase() with null"` + @throw invalid_iterator.203 if called on iterators which does not belong + to the current JSON value; example: `"iterators do not fit current value"` + @throw invalid_iterator.204 if called on a primitive type with invalid + iterators (i.e., if `first != begin()` and `last != end()`); example: + `"iterators out of range"` + + @complexity The complexity depends on the type: + - objects: `log(size()) + std::distance(first, last)` + - arrays: linear in the distance between @a first and @a last, plus linear + in the distance between @a last and end of the container + - strings and binary: linear in the length of the member + - other types: constant + + @liveexample{The example shows the result of `erase()` for different JSON + types.,erase__IteratorType_IteratorType} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + template < class IteratorType, typename std::enable_if < + std::is_same::value || + std::is_same::value, int >::type + = 0 > + IteratorType erase(IteratorType first, IteratorType last) + { + // make sure iterator fits the current value + if (JSON_HEDLEY_UNLIKELY(this != first.m_object || this != last.m_object)) + { + JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value")); + } + + IteratorType result = end(); + + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + case value_t::binary: + { + if (JSON_HEDLEY_LIKELY(!first.m_it.primitive_iterator.is_begin() + || !last.m_it.primitive_iterator.is_end())) + { + JSON_THROW(invalid_iterator::create(204, "iterators out of range")); + } + + if (is_string()) + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, m_value.string); + std::allocator_traits::deallocate(alloc, m_value.string, 1); + m_value.string = nullptr; + } + else if (is_binary()) + { + AllocatorType alloc; + std::allocator_traits::destroy(alloc, m_value.binary); + std::allocator_traits::deallocate(alloc, m_value.binary, 1); + m_value.binary = nullptr; + } + + m_type = value_t::null; + assert_invariant(); + break; + } + + case value_t::object: + { + result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator, + last.m_it.object_iterator); + break; + } + + case value_t::array: + { + result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator, + last.m_it.array_iterator); + break; + } + + default: + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + return result; + } + + /*! + @brief remove element from a JSON object given a key + + Removes elements from a JSON object with the key value @a key. + + @param[in] key value of the elements to remove + + @return Number of elements removed. If @a ObjectType is the default + `std::map` type, the return value will always be `0` (@a key was not + found) or `1` (@a key was found). + + @post References and iterators to the erased elements are invalidated. + Other references and iterators are not affected. + + @throw type_error.307 when called on a type other than JSON object; + example: `"cannot use erase() with null"` + + @complexity `log(size()) + count(key)` + + @liveexample{The example shows the effect of `erase()`.,erase__key_type} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + size_type erase(const typename object_t::key_type& key) + { + // this erase only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + return m_value.object->erase(key); + } + + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + /*! + @brief remove element from a JSON array given an index + + Removes element from a JSON array at the index @a idx. + + @param[in] idx index of the element to remove + + @throw type_error.307 when called on a type other than JSON object; + example: `"cannot use erase() with null"` + @throw out_of_range.401 when `idx >= size()`; example: `"array index 17 + is out of range"` + + @complexity Linear in distance between @a idx and the end of the container. + + @liveexample{The example shows the effect of `erase()`.,erase__size_type} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + + @since version 1.0.0 + */ + void erase(const size_type idx) + { + // this erase only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + if (JSON_HEDLEY_UNLIKELY(idx >= size())) + { + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + + m_value.array->erase(m_value.array->begin() + static_cast(idx)); + } + else + { + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + } + + /// @} + + + //////////// + // lookup // + //////////// + + /// @name lookup + /// @{ + + /*! + @brief find an element in a JSON object + + Finds an element in a JSON object with key equivalent to @a key. If the + element is not found or the JSON value is not an object, end() is + returned. + + @note This method always returns @ref end() when executed on a JSON type + that is not an object. + + @param[in] key key value of the element to search for. + + @return Iterator to an element with key equivalent to @a key. If no such + element is found or the JSON value is not an object, past-the-end (see + @ref end()) iterator is returned. + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The example shows how `find()` is used.,find__key_type} + + @sa @ref contains(KeyT&&) const -- checks whether a key exists + + @since version 1.0.0 + */ + template + iterator find(KeyT&& key) + { + auto result = end(); + + if (is_object()) + { + result.m_it.object_iterator = m_value.object->find(std::forward(key)); + } + + return result; + } + + /*! + @brief find an element in a JSON object + @copydoc find(KeyT&&) + */ + template + const_iterator find(KeyT&& key) const + { + auto result = cend(); + + if (is_object()) + { + result.m_it.object_iterator = m_value.object->find(std::forward(key)); + } + + return result; + } + + /*! + @brief returns the number of occurrences of a key in a JSON object + + Returns the number of elements with key @a key. If ObjectType is the + default `std::map` type, the return value will always be `0` (@a key was + not found) or `1` (@a key was found). + + @note This method always returns `0` when executed on a JSON type that is + not an object. + + @param[in] key key value of the element to count + + @return Number of elements with key @a key. If the JSON value is not an + object, the return value will be `0`. + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The example shows how `count()` is used.,count} + + @since version 1.0.0 + */ + template + size_type count(KeyT&& key) const + { + // return 0 for all nonobject types + return is_object() ? m_value.object->count(std::forward(key)) : 0; + } + + /*! + @brief check the existence of an element in a JSON object + + Check whether an element exists in a JSON object with key equivalent to + @a key. If the element is not found or the JSON value is not an object, + false is returned. + + @note This method always returns false when executed on a JSON type + that is not an object. + + @param[in] key key value to check its existence. + + @return true if an element with specified @a key exists. If no such + element with such key is found or the JSON value is not an object, + false is returned. + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The following code shows an example for `contains()`.,contains} + + @sa @ref find(KeyT&&) -- returns an iterator to an object element + @sa @ref contains(const json_pointer&) const -- checks the existence for a JSON pointer + + @since version 3.6.0 + */ + template < typename KeyT, typename std::enable_if < + !std::is_same::type, json_pointer>::value, int >::type = 0 > + bool contains(KeyT && key) const + { + return is_object() && m_value.object->find(std::forward(key)) != m_value.object->end(); + } + + /*! + @brief check the existence of an element in a JSON object given a JSON pointer + + Check whether the given JSON pointer @a ptr can be resolved in the current + JSON value. + + @note This method can be executed on any JSON value type. + + @param[in] ptr JSON pointer to check its existence. + + @return true if the JSON pointer can be resolved to a stored value, false + otherwise. + + @post If `j.contains(ptr)` returns true, it is safe to call `j[ptr]`. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The following code shows an example for `contains()`.,contains_json_pointer} + + @sa @ref contains(KeyT &&) const -- checks the existence of a key + + @since version 3.7.0 + */ + bool contains(const json_pointer& ptr) const + { + return ptr.contains(this); + } + + /// @} + + + /////////////// + // iterators // + /////////////// + + /// @name iterators + /// @{ + + /*! + @brief returns an iterator to the first element + + Returns an iterator to the first element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return iterator to the first element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + + @liveexample{The following code shows an example for `begin()`.,begin} + + @sa @ref cbegin() -- returns a const iterator to the beginning + @sa @ref end() -- returns an iterator to the end + @sa @ref cend() -- returns a const iterator to the end + + @since version 1.0.0 + */ + iterator begin() noexcept + { + iterator result(this); + result.set_begin(); + return result; + } + + /*! + @copydoc basic_json::cbegin() + */ + const_iterator begin() const noexcept + { + return cbegin(); + } + + /*! + @brief returns a const iterator to the first element + + Returns a const iterator to the first element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return const iterator to the first element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast(*this).begin()`. + + @liveexample{The following code shows an example for `cbegin()`.,cbegin} + + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref end() -- returns an iterator to the end + @sa @ref cend() -- returns a const iterator to the end + + @since version 1.0.0 + */ + const_iterator cbegin() const noexcept + { + const_iterator result(this); + result.set_begin(); + return result; + } + + /*! + @brief returns an iterator to one past the last element + + Returns an iterator to one past the last element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return iterator one past the last element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + + @liveexample{The following code shows an example for `end()`.,end} + + @sa @ref cend() -- returns a const iterator to the end + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref cbegin() -- returns a const iterator to the beginning + + @since version 1.0.0 + */ + iterator end() noexcept + { + iterator result(this); + result.set_end(); + return result; + } + + /*! + @copydoc basic_json::cend() + */ + const_iterator end() const noexcept + { + return cend(); + } + + /*! + @brief returns a const iterator to one past the last element + + Returns a const iterator to one past the last element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return const iterator one past the last element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast(*this).end()`. + + @liveexample{The following code shows an example for `cend()`.,cend} + + @sa @ref end() -- returns an iterator to the end + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref cbegin() -- returns a const iterator to the beginning + + @since version 1.0.0 + */ + const_iterator cend() const noexcept + { + const_iterator result(this); + result.set_end(); + return result; + } + + /*! + @brief returns an iterator to the reverse-beginning + + Returns an iterator to the reverse-beginning; that is, the last element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `reverse_iterator(end())`. + + @liveexample{The following code shows an example for `rbegin()`.,rbegin} + + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref crend() -- returns a const reverse iterator to the end + + @since version 1.0.0 + */ + reverse_iterator rbegin() noexcept + { + return reverse_iterator(end()); + } + + /*! + @copydoc basic_json::crbegin() + */ + const_reverse_iterator rbegin() const noexcept + { + return crbegin(); + } + + /*! + @brief returns an iterator to the reverse-end + + Returns an iterator to the reverse-end; that is, one before the first + element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `reverse_iterator(begin())`. + + @liveexample{The following code shows an example for `rend()`.,rend} + + @sa @ref crend() -- returns a const reverse iterator to the end + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + + @since version 1.0.0 + */ + reverse_iterator rend() noexcept + { + return reverse_iterator(begin()); + } + + /*! + @copydoc basic_json::crend() + */ + const_reverse_iterator rend() const noexcept + { + return crend(); + } + + /*! + @brief returns a const reverse iterator to the last element + + Returns a const iterator to the reverse-beginning; that is, the last + element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast(*this).rbegin()`. + + @liveexample{The following code shows an example for `crbegin()`.,crbegin} + + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref crend() -- returns a const reverse iterator to the end + + @since version 1.0.0 + */ + const_reverse_iterator crbegin() const noexcept + { + return const_reverse_iterator(cend()); + } + + /*! + @brief returns a const reverse iterator to one before the first + + Returns a const reverse iterator to the reverse-end; that is, one before + the first element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast(*this).rend()`. + + @liveexample{The following code shows an example for `crend()`.,crend} + + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + + @since version 1.0.0 + */ + const_reverse_iterator crend() const noexcept + { + return const_reverse_iterator(cbegin()); + } + + public: + /*! + @brief wrapper to access iterator member functions in range-based for + + This function allows to access @ref iterator::key() and @ref + iterator::value() during range-based for loops. In these loops, a + reference to the JSON values is returned, so there is no access to the + underlying iterator. + + For loop without iterator_wrapper: + + @code{cpp} + for (auto it = j_object.begin(); it != j_object.end(); ++it) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + Range-based for loop without iterator proxy: + + @code{cpp} + for (auto it : j_object) + { + // "it" is of type json::reference and has no key() member + std::cout << "value: " << it << '\n'; + } + @endcode + + Range-based for loop with iterator proxy: + + @code{cpp} + for (auto it : json::iterator_wrapper(j_object)) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + @note When iterating over an array, `key()` will return the index of the + element as string (see example). + + @param[in] ref reference to a JSON value + @return iteration proxy object wrapping @a ref with an interface to use in + range-based for loops + + @liveexample{The following code shows how the wrapper is used,iterator_wrapper} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @note The name of this function is not yet final and may change in the + future. + + @deprecated This stream operator is deprecated and will be removed in + future 4.0.0 of the library. Please use @ref items() instead; + that is, replace `json::iterator_wrapper(j)` with `j.items()`. + */ + JSON_HEDLEY_DEPRECATED_FOR(3.1.0, items()) + static iteration_proxy iterator_wrapper(reference ref) noexcept + { + return ref.items(); + } + + /*! + @copydoc iterator_wrapper(reference) + */ + JSON_HEDLEY_DEPRECATED_FOR(3.1.0, items()) + static iteration_proxy iterator_wrapper(const_reference ref) noexcept + { + return ref.items(); + } + + /*! + @brief helper to access iterator member functions in range-based for + + This function allows to access @ref iterator::key() and @ref + iterator::value() during range-based for loops. In these loops, a + reference to the JSON values is returned, so there is no access to the + underlying iterator. + + For loop without `items()` function: + + @code{cpp} + for (auto it = j_object.begin(); it != j_object.end(); ++it) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + Range-based for loop without `items()` function: + + @code{cpp} + for (auto it : j_object) + { + // "it" is of type json::reference and has no key() member + std::cout << "value: " << it << '\n'; + } + @endcode + + Range-based for loop with `items()` function: + + @code{cpp} + for (auto& el : j_object.items()) + { + std::cout << "key: " << el.key() << ", value:" << el.value() << '\n'; + } + @endcode + + The `items()` function also allows to use + [structured bindings](https://en.cppreference.com/w/cpp/language/structured_binding) + (C++17): + + @code{cpp} + for (auto& [key, val] : j_object.items()) + { + std::cout << "key: " << key << ", value:" << val << '\n'; + } + @endcode + + @note When iterating over an array, `key()` will return the index of the + element as string (see example). For primitive types (e.g., numbers), + `key()` returns an empty string. + + @warning Using `items()` on temporary objects is dangerous. Make sure the + object's lifetime exeeds the iteration. See + for more + information. + + @return iteration proxy object wrapping @a ref with an interface to use in + range-based for loops + + @liveexample{The following code shows how the function is used.,items} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 3.1.0, structured bindings support since 3.5.0. + */ + iteration_proxy items() noexcept + { + return iteration_proxy(*this); + } + + /*! + @copydoc items() + */ + iteration_proxy items() const noexcept + { + return iteration_proxy(*this); + } + + /// @} + + + ////////////// + // capacity // + ////////////// + + /// @name capacity + /// @{ + + /*! + @brief checks whether the container is empty. + + Checks if a JSON value has no elements (i.e. whether its @ref size is `0`). + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `true` + boolean | `false` + string | `false` + number | `false` + binary | `false` + object | result of function `object_t::empty()` + array | result of function `array_t::empty()` + + @liveexample{The following code uses `empty()` to check if a JSON + object contains any elements.,empty} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their `empty()` functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @note This function does not return whether a string stored as JSON value + is empty - it returns whether the JSON container itself is empty which is + false in the case of a string. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `begin() == end()`. + + @sa @ref size() -- returns the number of elements + + @since version 1.0.0 + */ + bool empty() const noexcept + { + switch (m_type) + { + case value_t::null: + { + // null values are empty + return true; + } + + case value_t::array: + { + // delegate call to array_t::empty() + return m_value.array->empty(); + } + + case value_t::object: + { + // delegate call to object_t::empty() + return m_value.object->empty(); + } + + default: + { + // all other types are nonempty + return false; + } + } + } + + /*! + @brief returns the number of elements + + Returns the number of elements in a JSON value. + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `0` + boolean | `1` + string | `1` + number | `1` + binary | `1` + object | result of function object_t::size() + array | result of function array_t::size() + + @liveexample{The following code calls `size()` on the different value + types.,size} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their size() functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @note This function does not return the length of a string stored as JSON + value - it returns the number of elements in the JSON value which is 1 in + the case of a string. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `std::distance(begin(), end())`. + + @sa @ref empty() -- checks whether the container is empty + @sa @ref max_size() -- returns the maximal number of elements + + @since version 1.0.0 + */ + size_type size() const noexcept + { + switch (m_type) + { + case value_t::null: + { + // null values are empty + return 0; + } + + case value_t::array: + { + // delegate call to array_t::size() + return m_value.array->size(); + } + + case value_t::object: + { + // delegate call to object_t::size() + return m_value.object->size(); + } + + default: + { + // all other types have size 1 + return 1; + } + } + } + + /*! + @brief returns the maximum possible number of elements + + Returns the maximum number of elements a JSON value is able to hold due to + system or library implementation limitations, i.e. `std::distance(begin(), + end())` for the JSON value. + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `0` (same as `size()`) + boolean | `1` (same as `size()`) + string | `1` (same as `size()`) + number | `1` (same as `size()`) + binary | `1` (same as `size()`) + object | result of function `object_t::max_size()` + array | result of function `array_t::max_size()` + + @liveexample{The following code calls `max_size()` on the different value + types. Note the output is implementation specific.,max_size} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their `max_size()` functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of returning `b.size()` where `b` is the largest + possible JSON value. + + @sa @ref size() -- returns the number of elements + + @since version 1.0.0 + */ + size_type max_size() const noexcept + { + switch (m_type) + { + case value_t::array: + { + // delegate call to array_t::max_size() + return m_value.array->max_size(); + } + + case value_t::object: + { + // delegate call to object_t::max_size() + return m_value.object->max_size(); + } + + default: + { + // all other types have max_size() == size() + return size(); + } + } + } + + /// @} + + + /////////////// + // modifiers // + /////////////// + + /// @name modifiers + /// @{ + + /*! + @brief clears the contents + + Clears the content of a JSON value and resets it to the default value as + if @ref basic_json(value_t) would have been called with the current value + type from @ref type(): + + Value type | initial value + ----------- | ------------- + null | `null` + boolean | `false` + string | `""` + number | `0` + binary | An empty byte vector + object | `{}` + array | `[]` + + @post Has the same effect as calling + @code {.cpp} + *this = basic_json(type()); + @endcode + + @liveexample{The example below shows the effect of `clear()` to different + JSON types.,clear} + + @complexity Linear in the size of the JSON value. + + @iterators All iterators, pointers and references related to this container + are invalidated. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @sa @ref basic_json(value_t) -- constructor that creates an object with the + same value than calling `clear()` + + @since version 1.0.0 + */ + void clear() noexcept + { + switch (m_type) + { + case value_t::number_integer: + { + m_value.number_integer = 0; + break; + } + + case value_t::number_unsigned: + { + m_value.number_unsigned = 0; + break; + } + + case value_t::number_float: + { + m_value.number_float = 0.0; + break; + } + + case value_t::boolean: + { + m_value.boolean = false; + break; + } + + case value_t::string: + { + m_value.string->clear(); + break; + } + + case value_t::binary: + { + m_value.binary->clear(); + break; + } + + case value_t::array: + { + m_value.array->clear(); + break; + } + + case value_t::object: + { + m_value.object->clear(); + break; + } + + default: + break; + } + } + + /*! + @brief add an object to an array + + Appends the given element @a val to the end of the JSON value. If the + function is called on a JSON null value, an empty array is created before + appending @a val. + + @param[in] val the value to add to the JSON array + + @throw type_error.308 when called on a type other than JSON array or + null; example: `"cannot use push_back() with number"` + + @complexity Amortized constant. + + @liveexample{The example shows how `push_back()` and `+=` can be used to + add elements to a JSON array. Note how the `null` value was silently + converted to a JSON array.,push_back} + + @since version 1.0.0 + */ + void push_back(basic_json&& val) + { + // push_back only works for null objects or arrays + if (JSON_HEDLEY_UNLIKELY(!(is_null() || is_array()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array (move semantics) + m_value.array->push_back(std::move(val)); + // if val is moved from, basic_json move constructor marks it null so we do not call the destructor + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + reference operator+=(basic_json&& val) + { + push_back(std::move(val)); + return *this; + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + void push_back(const basic_json& val) + { + // push_back only works for null objects or arrays + if (JSON_HEDLEY_UNLIKELY(!(is_null() || is_array()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array + m_value.array->push_back(val); + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + reference operator+=(const basic_json& val) + { + push_back(val); + return *this; + } + + /*! + @brief add an object to an object + + Inserts the given element @a val to the JSON object. If the function is + called on a JSON null value, an empty object is created before inserting + @a val. + + @param[in] val the value to add to the JSON object + + @throw type_error.308 when called on a type other than JSON object or + null; example: `"cannot use push_back() with number"` + + @complexity Logarithmic in the size of the container, O(log(`size()`)). + + @liveexample{The example shows how `push_back()` and `+=` can be used to + add elements to a JSON object. Note how the `null` value was silently + converted to a JSON object.,push_back__object_t__value} + + @since version 1.0.0 + */ + void push_back(const typename object_t::value_type& val) + { + // push_back only works for null objects or objects + if (JSON_HEDLEY_UNLIKELY(!(is_null() || is_object()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // add element to array + m_value.object->insert(val); + } + + /*! + @brief add an object to an object + @copydoc push_back(const typename object_t::value_type&) + */ + reference operator+=(const typename object_t::value_type& val) + { + push_back(val); + return *this; + } + + /*! + @brief add an object to an object + + This function allows to use `push_back` with an initializer list. In case + + 1. the current value is an object, + 2. the initializer list @a init contains only two elements, and + 3. the first element of @a init is a string, + + @a init is converted into an object element and added using + @ref push_back(const typename object_t::value_type&). Otherwise, @a init + is converted to a JSON value and added using @ref push_back(basic_json&&). + + @param[in] init an initializer list + + @complexity Linear in the size of the initializer list @a init. + + @note This function is required to resolve an ambiguous overload error, + because pairs like `{"key", "value"}` can be both interpreted as + `object_t::value_type` or `std::initializer_list`, see + https://github.com/nlohmann/json/issues/235 for more information. + + @liveexample{The example shows how initializer lists are treated as + objects when possible.,push_back__initializer_list} + */ + void push_back(initializer_list_t init) + { + if (is_object() && init.size() == 2 && (*init.begin())->is_string()) + { + basic_json&& key = init.begin()->moved_or_copied(); + push_back(typename object_t::value_type( + std::move(key.get_ref()), (init.begin() + 1)->moved_or_copied())); + } + else + { + push_back(basic_json(init)); + } + } + + /*! + @brief add an object to an object + @copydoc push_back(initializer_list_t) + */ + reference operator+=(initializer_list_t init) + { + push_back(init); + return *this; + } + + /*! + @brief add an object to an array + + Creates a JSON value from the passed parameters @a args to the end of the + JSON value. If the function is called on a JSON null value, an empty array + is created before appending the value created from @a args. + + @param[in] args arguments to forward to a constructor of @ref basic_json + @tparam Args compatible types to create a @ref basic_json object + + @return reference to the inserted element + + @throw type_error.311 when called on a type other than JSON array or + null; example: `"cannot use emplace_back() with number"` + + @complexity Amortized constant. + + @liveexample{The example shows how `push_back()` can be used to add + elements to a JSON array. Note how the `null` value was silently converted + to a JSON array.,emplace_back} + + @since version 2.0.8, returns reference since 3.7.0 + */ + template + reference emplace_back(Args&& ... args) + { + // emplace_back only works for null objects or arrays + if (JSON_HEDLEY_UNLIKELY(!(is_null() || is_array()))) + { + JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array (perfect forwarding) +#ifdef JSON_HAS_CPP_17 + return m_value.array->emplace_back(std::forward(args)...); +#else + m_value.array->emplace_back(std::forward(args)...); + return m_value.array->back(); +#endif + } + + /*! + @brief add an object to an object if key does not exist + + Inserts a new element into a JSON object constructed in-place with the + given @a args if there is no element with the key in the container. If the + function is called on a JSON null value, an empty object is created before + appending the value created from @a args. + + @param[in] args arguments to forward to a constructor of @ref basic_json + @tparam Args compatible types to create a @ref basic_json object + + @return a pair consisting of an iterator to the inserted element, or the + already-existing element if no insertion happened, and a bool + denoting whether the insertion took place. + + @throw type_error.311 when called on a type other than JSON object or + null; example: `"cannot use emplace() with number"` + + @complexity Logarithmic in the size of the container, O(log(`size()`)). + + @liveexample{The example shows how `emplace()` can be used to add elements + to a JSON object. Note how the `null` value was silently converted to a + JSON object. Further note how no value is added if there was already one + value stored with the same key.,emplace} + + @since version 2.0.8 + */ + template + std::pair emplace(Args&& ... args) + { + // emplace only works for null objects or arrays + if (JSON_HEDLEY_UNLIKELY(!(is_null() || is_object()))) + { + JSON_THROW(type_error::create(311, "cannot use emplace() with " + std::string(type_name()))); + } + + // transform null object into an object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // add element to array (perfect forwarding) + auto res = m_value.object->emplace(std::forward(args)...); + // create result iterator and set iterator to the result of emplace + auto it = begin(); + it.m_it.object_iterator = res.first; + + // return pair of iterator and boolean + return {it, res.second}; + } + + /// Helper for insertion of an iterator + /// @note: This uses std::distance to support GCC 4.8, + /// see https://github.com/nlohmann/json/pull/1257 + template + iterator insert_iterator(const_iterator pos, Args&& ... args) + { + iterator result(this); + JSON_ASSERT(m_value.array != nullptr); + + auto insert_pos = std::distance(m_value.array->begin(), pos.m_it.array_iterator); + m_value.array->insert(pos.m_it.array_iterator, std::forward(args)...); + result.m_it.array_iterator = m_value.array->begin() + insert_pos; + + // This could have been written as: + // result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val); + // but the return value of insert is missing in GCC 4.8, so it is written this way instead. + + return result; + } + + /*! + @brief inserts element + + Inserts element @a val before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] val element to insert + @return iterator pointing to the inserted @a val. + + @throw type_error.309 if called on JSON values other than arrays; + example: `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @complexity Constant plus linear in the distance between @a pos and end of + the container. + + @liveexample{The example shows how `insert()` is used.,insert} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, const basic_json& val) + { + // insert only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + // check if iterator pos fits to this JSON value + if (JSON_HEDLEY_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + return insert_iterator(pos, val); + } + + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + /*! + @brief inserts element + @copydoc insert(const_iterator, const basic_json&) + */ + iterator insert(const_iterator pos, basic_json&& val) + { + return insert(pos, val); + } + + /*! + @brief inserts elements + + Inserts @a cnt copies of @a val before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] cnt number of copies of @a val to insert + @param[in] val element to insert + @return iterator pointing to the first element inserted, or @a pos if + `cnt==0` + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @complexity Linear in @a cnt plus linear in the distance between @a pos + and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__count} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, size_type cnt, const basic_json& val) + { + // insert only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + // check if iterator pos fits to this JSON value + if (JSON_HEDLEY_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + return insert_iterator(pos, cnt, val); + } + + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + /*! + @brief inserts elements + + Inserts elements from range `[first, last)` before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + @throw invalid_iterator.211 if @a first or @a last are iterators into + container for which insert is called; example: `"passed iterators may not + belong to container"` + + @return iterator pointing to the first element inserted, or @a pos if + `first==last` + + @complexity Linear in `std::distance(first, last)` plus linear in the + distance between @a pos and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__range} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, const_iterator first, const_iterator last) + { + // insert only works for arrays + if (JSON_HEDLEY_UNLIKELY(!is_array())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if iterator pos fits to this JSON value + if (JSON_HEDLEY_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // check if range iterators belong to the same JSON object + if (JSON_HEDLEY_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + if (JSON_HEDLEY_UNLIKELY(first.m_object == this)) + { + JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container")); + } + + // insert to array and return iterator + return insert_iterator(pos, first.m_it.array_iterator, last.m_it.array_iterator); + } + + /*! + @brief inserts elements + + Inserts elements from initializer list @a ilist before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] ilist initializer list to insert the values from + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @return iterator pointing to the first element inserted, or @a pos if + `ilist` is empty + + @complexity Linear in `ilist.size()` plus linear in the distance between + @a pos and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__ilist} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, initializer_list_t ilist) + { + // insert only works for arrays + if (JSON_HEDLEY_UNLIKELY(!is_array())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if iterator pos fits to this JSON value + if (JSON_HEDLEY_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + return insert_iterator(pos, ilist.begin(), ilist.end()); + } + + /*! + @brief inserts elements + + Inserts elements from range `[first, last)`. + + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.309 if called on JSON values other than objects; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if iterator @a first or @a last does does not + point to an object; example: `"iterators first and last must point to + objects"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + + @complexity Logarithmic: `O(N*log(size() + N))`, where `N` is the number + of elements to insert. + + @liveexample{The example shows how `insert()` is used.,insert__range_object} + + @since version 3.0.0 + */ + void insert(const_iterator first, const_iterator last) + { + // insert only works for objects + if (JSON_HEDLEY_UNLIKELY(!is_object())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if range iterators belong to the same JSON object + if (JSON_HEDLEY_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + // passed iterators must belong to objects + if (JSON_HEDLEY_UNLIKELY(!first.m_object->is_object())) + { + JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects")); + } + + m_value.object->insert(first.m_it.object_iterator, last.m_it.object_iterator); + } + + /*! + @brief updates a JSON object from another object, overwriting existing keys + + Inserts all values from JSON object @a j and overwrites existing keys. + + @param[in] j JSON object to read values from + + @throw type_error.312 if called on JSON values other than objects; example: + `"cannot use update() with string"` + + @complexity O(N*log(size() + N)), where N is the number of elements to + insert. + + @liveexample{The example shows how `update()` is used.,update} + + @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update + + @since version 3.0.0 + */ + void update(const_reference j) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create(); + assert_invariant(); + } + + if (JSON_HEDLEY_UNLIKELY(!is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(type_name()))); + } + if (JSON_HEDLEY_UNLIKELY(!j.is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(j.type_name()))); + } + + for (auto it = j.cbegin(); it != j.cend(); ++it) + { + m_value.object->operator[](it.key()) = it.value(); + } + } + + /*! + @brief updates a JSON object from another object, overwriting existing keys + + Inserts all values from from range `[first, last)` and overwrites existing + keys. + + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.312 if called on JSON values other than objects; example: + `"cannot use update() with string"` + @throw invalid_iterator.202 if iterator @a first or @a last does does not + point to an object; example: `"iterators first and last must point to + objects"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + + @complexity O(N*log(size() + N)), where N is the number of elements to + insert. + + @liveexample{The example shows how `update()` is used__range.,update} + + @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update + + @since version 3.0.0 + */ + void update(const_iterator first, const_iterator last) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create(); + assert_invariant(); + } + + if (JSON_HEDLEY_UNLIKELY(!is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(type_name()))); + } + + // check if range iterators belong to the same JSON object + if (JSON_HEDLEY_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + // passed iterators must belong to objects + if (JSON_HEDLEY_UNLIKELY(!first.m_object->is_object() + || !last.m_object->is_object())) + { + JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects")); + } + + for (auto it = first; it != last; ++it) + { + m_value.object->operator[](it.key()) = it.value(); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of the JSON value with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other JSON value to exchange the contents with + + @complexity Constant. + + @liveexample{The example below shows how JSON values can be swapped with + `swap()`.,swap__reference} + + @since version 1.0.0 + */ + void swap(reference other) noexcept ( + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value&& + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value + ) + { + std::swap(m_type, other.m_type); + std::swap(m_value, other.m_value); + assert_invariant(); + } + + /*! + @brief exchanges the values + + Exchanges the contents of the JSON value from @a left with those of @a right. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. implemented as a friend function callable via ADL. + + @param[in,out] left JSON value to exchange the contents with + @param[in,out] right JSON value to exchange the contents with + + @complexity Constant. + + @liveexample{The example below shows how JSON values can be swapped with + `swap()`.,swap__reference} + + @since version 1.0.0 + */ + friend void swap(reference left, reference right) noexcept ( + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value&& + std::is_nothrow_move_constructible::value&& + std::is_nothrow_move_assignable::value + ) + { + left.swap(right); + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON array with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other array to exchange the contents with + + @throw type_error.310 when JSON value is not an array; example: `"cannot + use swap() with string"` + + @complexity Constant. + + @liveexample{The example below shows how arrays can be swapped with + `swap()`.,swap__array_t} + + @since version 1.0.0 + */ + void swap(array_t& other) + { + // swap only works for arrays + if (JSON_HEDLEY_LIKELY(is_array())) + { + std::swap(*(m_value.array), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON object with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other object to exchange the contents with + + @throw type_error.310 when JSON value is not an object; example: + `"cannot use swap() with string"` + + @complexity Constant. + + @liveexample{The example below shows how objects can be swapped with + `swap()`.,swap__object_t} + + @since version 1.0.0 + */ + void swap(object_t& other) + { + // swap only works for objects + if (JSON_HEDLEY_LIKELY(is_object())) + { + std::swap(*(m_value.object), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON string with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other string to exchange the contents with + + @throw type_error.310 when JSON value is not a string; example: `"cannot + use swap() with boolean"` + + @complexity Constant. + + @liveexample{The example below shows how strings can be swapped with + `swap()`.,swap__string_t} + + @since version 1.0.0 + */ + void swap(string_t& other) + { + // swap only works for strings + if (JSON_HEDLEY_LIKELY(is_string())) + { + std::swap(*(m_value.string), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON string with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other binary to exchange the contents with + + @throw type_error.310 when JSON value is not a string; example: `"cannot + use swap() with boolean"` + + @complexity Constant. + + @liveexample{The example below shows how strings can be swapped with + `swap()`.,swap__binary_t} + + @since version 3.8.0 + */ + void swap(binary_t& other) + { + // swap only works for strings + if (JSON_HEDLEY_LIKELY(is_binary())) + { + std::swap(*(m_value.binary), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /// @copydoc swap(binary_t) + void swap(typename binary_t::container_type& other) + { + // swap only works for strings + if (JSON_HEDLEY_LIKELY(is_binary())) + { + std::swap(*(m_value.binary), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /// @} + + public: + ////////////////////////////////////////// + // lexicographical comparison operators // + ////////////////////////////////////////// + + /// @name lexicographical comparison operators + /// @{ + + /*! + @brief comparison: equal + + Compares two JSON values for equality according to the following rules: + - Two JSON values are equal if (1) they are from the same type and (2) + their stored values are the same according to their respective + `operator==`. + - Integer and floating-point numbers are automatically converted before + comparison. Note that two NaN values are always treated as unequal. + - Two JSON null values are equal. + + @note Floating-point inside JSON values numbers are compared with + `json::number_float_t::operator==` which is `double::operator==` by + default. To compare floating-point while respecting an epsilon, an alternative + [comparison function](https://github.com/mariokonrad/marnav/blob/master/include/marnav/math/floatingpoint.hpp#L34-#L39) + could be used, for instance + @code {.cpp} + template::value, T>::type> + inline bool is_same(T a, T b, T epsilon = std::numeric_limits::epsilon()) noexcept + { + return std::abs(a - b) <= epsilon; + } + @endcode + Or you can self-defined operator equal function like this: + @code {.cpp} + bool my_equal(const_reference lhs, const_reference rhs) { + const auto lhs_type lhs.type(); + const auto rhs_type rhs.type(); + if (lhs_type == rhs_type) { + switch(lhs_type) + // self_defined case + case value_t::number_float: + return std::abs(lhs - rhs) <= std::numeric_limits::epsilon(); + // other cases remain the same with the original + ... + } + ... + } + @endcode + + @note NaN values never compare equal to themselves or to other NaN values. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether the values @a lhs and @a rhs are equal + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @complexity Linear. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__equal} + + @since version 1.0.0 + */ + friend bool operator==(const_reference lhs, const_reference rhs) noexcept + { + const auto lhs_type = lhs.type(); + const auto rhs_type = rhs.type(); + + if (lhs_type == rhs_type) + { + switch (lhs_type) + { + case value_t::array: + return *lhs.m_value.array == *rhs.m_value.array; + + case value_t::object: + return *lhs.m_value.object == *rhs.m_value.object; + + case value_t::null: + return true; + + case value_t::string: + return *lhs.m_value.string == *rhs.m_value.string; + + case value_t::boolean: + return lhs.m_value.boolean == rhs.m_value.boolean; + + case value_t::number_integer: + return lhs.m_value.number_integer == rhs.m_value.number_integer; + + case value_t::number_unsigned: + return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned; + + case value_t::number_float: + return lhs.m_value.number_float == rhs.m_value.number_float; + + case value_t::binary: + return *lhs.m_value.binary == *rhs.m_value.binary; + + default: + return false; + } + } + else if (lhs_type == value_t::number_integer && rhs_type == value_t::number_float) + { + return static_cast(lhs.m_value.number_integer) == rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float && rhs_type == value_t::number_integer) + { + return lhs.m_value.number_float == static_cast(rhs.m_value.number_integer); + } + else if (lhs_type == value_t::number_unsigned && rhs_type == value_t::number_float) + { + return static_cast(lhs.m_value.number_unsigned) == rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float && rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_float == static_cast(rhs.m_value.number_unsigned); + } + else if (lhs_type == value_t::number_unsigned && rhs_type == value_t::number_integer) + { + return static_cast(lhs.m_value.number_unsigned) == rhs.m_value.number_integer; + } + else if (lhs_type == value_t::number_integer && rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_integer == static_cast(rhs.m_value.number_unsigned); + } + + return false; + } + + /*! + @brief comparison: equal + @copydoc operator==(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs == basic_json(rhs); + } + + /*! + @brief comparison: equal + @copydoc operator==(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) == rhs; + } + + /*! + @brief comparison: not equal + + Compares two JSON values for inequality by calculating `not (lhs == rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether the values @a lhs and @a rhs are not equal + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__notequal} + + @since version 1.0.0 + */ + friend bool operator!=(const_reference lhs, const_reference rhs) noexcept + { + return !(lhs == rhs); + } + + /*! + @brief comparison: not equal + @copydoc operator!=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs != basic_json(rhs); + } + + /*! + @brief comparison: not equal + @copydoc operator!=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) != rhs; + } + + /*! + @brief comparison: less than + + Compares whether one JSON value @a lhs is less than another JSON value @a + rhs according to the following rules: + - If @a lhs and @a rhs have the same type, the values are compared using + the default `<` operator. + - Integer and floating-point numbers are automatically converted before + comparison + - In case @a lhs and @a rhs have different types, the values are ignored + and the order of the types is considered, see + @ref operator<(const value_t, const value_t). + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is less than @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__less} + + @since version 1.0.0 + */ + friend bool operator<(const_reference lhs, const_reference rhs) noexcept + { + const auto lhs_type = lhs.type(); + const auto rhs_type = rhs.type(); + + if (lhs_type == rhs_type) + { + switch (lhs_type) + { + case value_t::array: + // note parentheses are necessary, see + // https://github.com/nlohmann/json/issues/1530 + return (*lhs.m_value.array) < (*rhs.m_value.array); + + case value_t::object: + return (*lhs.m_value.object) < (*rhs.m_value.object); + + case value_t::null: + return false; + + case value_t::string: + return (*lhs.m_value.string) < (*rhs.m_value.string); + + case value_t::boolean: + return (lhs.m_value.boolean) < (rhs.m_value.boolean); + + case value_t::number_integer: + return (lhs.m_value.number_integer) < (rhs.m_value.number_integer); + + case value_t::number_unsigned: + return (lhs.m_value.number_unsigned) < (rhs.m_value.number_unsigned); + + case value_t::number_float: + return (lhs.m_value.number_float) < (rhs.m_value.number_float); + + case value_t::binary: + return (*lhs.m_value.binary) < (*rhs.m_value.binary); + + default: + return false; + } + } + else if (lhs_type == value_t::number_integer && rhs_type == value_t::number_float) + { + return static_cast(lhs.m_value.number_integer) < rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float && rhs_type == value_t::number_integer) + { + return lhs.m_value.number_float < static_cast(rhs.m_value.number_integer); + } + else if (lhs_type == value_t::number_unsigned && rhs_type == value_t::number_float) + { + return static_cast(lhs.m_value.number_unsigned) < rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float && rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_float < static_cast(rhs.m_value.number_unsigned); + } + else if (lhs_type == value_t::number_integer && rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_integer < static_cast(rhs.m_value.number_unsigned); + } + else if (lhs_type == value_t::number_unsigned && rhs_type == value_t::number_integer) + { + return static_cast(lhs.m_value.number_unsigned) < rhs.m_value.number_integer; + } + + // We only reach this line if we cannot compare values. In that case, + // we compare types. Note we have to call the operator explicitly, + // because MSVC has problems otherwise. + return operator<(lhs_type, rhs_type); + } + + /*! + @brief comparison: less than + @copydoc operator<(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator<(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs < basic_json(rhs); + } + + /*! + @brief comparison: less than + @copydoc operator<(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator<(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) < rhs; + } + + /*! + @brief comparison: less than or equal + + Compares whether one JSON value @a lhs is less than or equal to another + JSON value by calculating `not (rhs < lhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is less than or equal to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__greater} + + @since version 1.0.0 + */ + friend bool operator<=(const_reference lhs, const_reference rhs) noexcept + { + return !(rhs < lhs); + } + + /*! + @brief comparison: less than or equal + @copydoc operator<=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator<=(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs <= basic_json(rhs); + } + + /*! + @brief comparison: less than or equal + @copydoc operator<=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator<=(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) <= rhs; + } + + /*! + @brief comparison: greater than + + Compares whether one JSON value @a lhs is greater than another + JSON value by calculating `not (lhs <= rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is greater than to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__lessequal} + + @since version 1.0.0 + */ + friend bool operator>(const_reference lhs, const_reference rhs) noexcept + { + return !(lhs <= rhs); + } + + /*! + @brief comparison: greater than + @copydoc operator>(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator>(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs > basic_json(rhs); + } + + /*! + @brief comparison: greater than + @copydoc operator>(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator>(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) > rhs; + } + + /*! + @brief comparison: greater than or equal + + Compares whether one JSON value @a lhs is greater than or equal to another + JSON value by calculating `not (lhs < rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is greater than or equal to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__greaterequal} + + @since version 1.0.0 + */ + friend bool operator>=(const_reference lhs, const_reference rhs) noexcept + { + return !(lhs < rhs); + } + + /*! + @brief comparison: greater than or equal + @copydoc operator>=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator>=(const_reference lhs, const ScalarType rhs) noexcept + { + return lhs >= basic_json(rhs); + } + + /*! + @brief comparison: greater than or equal + @copydoc operator>=(const_reference, const_reference) + */ + template::value, int>::type = 0> + friend bool operator>=(const ScalarType lhs, const_reference rhs) noexcept + { + return basic_json(lhs) >= rhs; + } + + /// @} + + /////////////////// + // serialization // + /////////////////// + + /// @name serialization + /// @{ + + /*! + @brief serialize to stream + + Serialize the given JSON value @a j to the output stream @a o. The JSON + value will be serialized using the @ref dump member function. + + - The indentation of the output can be controlled with the member variable + `width` of the output stream @a o. For instance, using the manipulator + `std::setw(4)` on @a o sets the indentation level to `4` and the + serialization result is the same as calling `dump(4)`. + + - The indentation character can be controlled with the member variable + `fill` of the output stream @a o. For instance, the manipulator + `std::setfill('\\t')` sets indentation to use a tab character rather than + the default space character. + + @param[in,out] o stream to serialize to + @param[in] j JSON value to serialize + + @return the stream @a o + + @throw type_error.316 if a string stored inside the JSON value is not + UTF-8 encoded + + @complexity Linear. + + @liveexample{The example below shows the serialization with different + parameters to `width` to adjust the indentation level.,operator_serialize} + + @since version 1.0.0; indentation character added in version 3.0.0 + */ + friend std::ostream& operator<<(std::ostream& o, const basic_json& j) + { + // read width member and use it as indentation parameter if nonzero + const bool pretty_print = o.width() > 0; + const auto indentation = pretty_print ? o.width() : 0; + + // reset width to 0 for subsequent calls to this stream + o.width(0); + + // do the actual serialization + serializer s(detail::output_adapter(o), o.fill()); + s.dump(j, pretty_print, false, static_cast(indentation)); + return o; + } + + /*! + @brief serialize to stream + @deprecated This stream operator is deprecated and will be removed in + future 4.0.0 of the library. Please use + @ref operator<<(std::ostream&, const basic_json&) + instead; that is, replace calls like `j >> o;` with `o << j;`. + @since version 1.0.0; deprecated since version 3.0.0 + */ + JSON_HEDLEY_DEPRECATED_FOR(3.0.0, operator<<(std::ostream&, const basic_json&)) + friend std::ostream& operator>>(const basic_json& j, std::ostream& o) + { + return o << j; + } + + /// @} + + + ///////////////////// + // deserialization // + ///////////////////// + + /// @name deserialization + /// @{ + + /*! + @brief deserialize from a compatible input + + @tparam InputType A compatible input, for instance + - an std::istream object + - a FILE pointer + - a C-style array of characters + - a pointer to a null-terminated string of single byte characters + - an object obj for which begin(obj) and end(obj) produces a valid pair of + iterators. + + @param[in] i input to read from + @param[in] cb a parser callback function of type @ref parser_callback_t + which is used to control the deserialization by filtering unwanted values + (optional) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + @param[in] ignore_comments whether comments should be ignored and treated + like whitespace (true) or yield a parse error (true); (optional, false by + default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.101 if a parse error occurs; example: `""unexpected end + of input; expected string literal""` + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. The complexity can be higher if the parser callback function + @a cb or reading from the input @a i has a super-linear complexity. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below demonstrates the `parse()` function reading + from an array.,parse__array__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function with + and without callback function.,parse__string__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function with + and without callback function.,parse__istream__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function reading + from a contiguous container.,parse__contiguouscontainer__parser_callback_t} + + @since version 2.0.3 (contiguous containers); version 3.9.0 allowed to + ignore comments. + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json parse(InputType&& i, + const parser_callback_t cb = nullptr, + const bool allow_exceptions = true, + const bool ignore_comments = false) + { + basic_json result; + parser(detail::input_adapter(std::forward(i)), cb, allow_exceptions, ignore_comments).parse(true, result); + return result; + } + + /*! + @brief deserialize from a pair of character iterators + + The value_type of the iterator must be a integral type with size of 1, 2 or + 4 bytes, which will be interpreted respectively as UTF-8, UTF-16 and UTF-32. + + @param[in] first iterator to start of character range + @param[in] last iterator to end of character range + @param[in] cb a parser callback function of type @ref parser_callback_t + which is used to control the deserialization by filtering unwanted values + (optional) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + @param[in] ignore_comments whether comments should be ignored and treated + like whitespace (true) or yield a parse error (true); (optional, false by + default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.101 if a parse error occurs; example: `""unexpected end + of input; expected string literal""` + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json parse(IteratorType first, + IteratorType last, + const parser_callback_t cb = nullptr, + const bool allow_exceptions = true, + const bool ignore_comments = false) + { + basic_json result; + parser(detail::input_adapter(std::move(first), std::move(last)), cb, allow_exceptions, ignore_comments).parse(true, result); + return result; + } + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, parse(ptr, ptr + len)) + static basic_json parse(detail::span_input_adapter&& i, + const parser_callback_t cb = nullptr, + const bool allow_exceptions = true, + const bool ignore_comments = false) + { + basic_json result; + parser(i.get(), cb, allow_exceptions, ignore_comments).parse(true, result); + return result; + } + + /*! + @brief check if the input is valid JSON + + Unlike the @ref parse(InputType&&, const parser_callback_t,const bool) + function, this function neither throws an exception in case of invalid JSON + input (i.e., a parse error) nor creates diagnostic information. + + @tparam InputType A compatible input, for instance + - an std::istream object + - a FILE pointer + - a C-style array of characters + - a pointer to a null-terminated string of single byte characters + - an object obj for which begin(obj) and end(obj) produces a valid pair of + iterators. + + @param[in] i input to read from + @param[in] ignore_comments whether comments should be ignored and treated + like whitespace (true) or yield a parse error (true); (optional, false by + default) + + @return Whether the input read from @a i is valid JSON. + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below demonstrates the `accept()` function reading + from a string.,accept__string} + */ + template + static bool accept(InputType&& i, + const bool ignore_comments = false) + { + return parser(detail::input_adapter(std::forward(i)), nullptr, false, ignore_comments).accept(true); + } + + template + static bool accept(IteratorType first, IteratorType last, + const bool ignore_comments = false) + { + return parser(detail::input_adapter(std::move(first), std::move(last)), nullptr, false, ignore_comments).accept(true); + } + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, accept(ptr, ptr + len)) + static bool accept(detail::span_input_adapter&& i, + const bool ignore_comments = false) + { + return parser(i.get(), nullptr, false, ignore_comments).accept(true); + } + + /*! + @brief generate SAX events + + The SAX event lister must follow the interface of @ref json_sax. + + This function reads from a compatible input. Examples are: + - an std::istream object + - a FILE pointer + - a C-style array of characters + - a pointer to a null-terminated string of single byte characters + - an object obj for which begin(obj) and end(obj) produces a valid pair of + iterators. + + @param[in] i input to read from + @param[in,out] sax SAX event listener + @param[in] format the format to parse (JSON, CBOR, MessagePack, or UBJSON) + @param[in] strict whether the input has to be consumed completely + @param[in] ignore_comments whether comments should be ignored and treated + like whitespace (true) or yield a parse error (true); (optional, false by + default); only applies to the JSON file format. + + @return return value of the last processed SAX event + + @throw parse_error.101 if a parse error occurs; example: `""unexpected end + of input; expected string literal""` + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. The complexity can be higher if the SAX consumer @a sax has + a super-linear complexity. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below demonstrates the `sax_parse()` function + reading from string and processing the events with a user-defined SAX + event consumer.,sax_parse} + + @since version 3.2.0 + */ + template + JSON_HEDLEY_NON_NULL(2) + static bool sax_parse(InputType&& i, SAX* sax, + input_format_t format = input_format_t::json, + const bool strict = true, + const bool ignore_comments = false) + { + auto ia = detail::input_adapter(std::forward(i)); + return format == input_format_t::json + ? parser(std::move(ia), nullptr, true, ignore_comments).sax_parse(sax, strict) + : detail::binary_reader(std::move(ia)).sax_parse(format, sax, strict); + } + + template + JSON_HEDLEY_NON_NULL(3) + static bool sax_parse(IteratorType first, IteratorType last, SAX* sax, + input_format_t format = input_format_t::json, + const bool strict = true, + const bool ignore_comments = false) + { + auto ia = detail::input_adapter(std::move(first), std::move(last)); + return format == input_format_t::json + ? parser(std::move(ia), nullptr, true, ignore_comments).sax_parse(sax, strict) + : detail::binary_reader(std::move(ia)).sax_parse(format, sax, strict); + } + + template + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, sax_parse(ptr, ptr + len, ...)) + JSON_HEDLEY_NON_NULL(2) + static bool sax_parse(detail::span_input_adapter&& i, SAX* sax, + input_format_t format = input_format_t::json, + const bool strict = true, + const bool ignore_comments = false) + { + auto ia = i.get(); + return format == input_format_t::json + ? parser(std::move(ia), nullptr, true, ignore_comments).sax_parse(sax, strict) + : detail::binary_reader(std::move(ia)).sax_parse(format, sax, strict); + } + + /*! + @brief deserialize from stream + @deprecated This stream operator is deprecated and will be removed in + version 4.0.0 of the library. Please use + @ref operator>>(std::istream&, basic_json&) + instead; that is, replace calls like `j << i;` with `i >> j;`. + @since version 1.0.0; deprecated since version 3.0.0 + */ + JSON_HEDLEY_DEPRECATED_FOR(3.0.0, operator>>(std::istream&, basic_json&)) + friend std::istream& operator<<(basic_json& j, std::istream& i) + { + return operator>>(i, j); + } + + /*! + @brief deserialize from stream + + Deserializes an input stream to a JSON value. + + @param[in,out] i input stream to read a serialized JSON value from + @param[in,out] j JSON value to write the deserialized input to + + @throw parse_error.101 in case of an unexpected token + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below shows how a JSON value is constructed by + reading a serialization from a stream.,operator_deserialize} + + @sa parse(std::istream&, const parser_callback_t) for a variant with a + parser callback function to filter values while parsing + + @since version 1.0.0 + */ + friend std::istream& operator>>(std::istream& i, basic_json& j) + { + parser(detail::input_adapter(i)).parse(false, j); + return i; + } + + /// @} + + /////////////////////////// + // convenience functions // + /////////////////////////// + + /*! + @brief return the type as string + + Returns the type name as string to be used in error messages - usually to + indicate that a function was called on a wrong JSON type. + + @return a string representation of a the @a m_type member: + Value type | return value + ----------- | ------------- + null | `"null"` + boolean | `"boolean"` + string | `"string"` + number | `"number"` (for all number types) + object | `"object"` + array | `"array"` + binary | `"binary"` + discarded | `"discarded"` + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @complexity Constant. + + @liveexample{The following code exemplifies `type_name()` for all JSON + types.,type_name} + + @sa @ref type() -- return the type of the JSON value + @sa @ref operator value_t() -- return the type of the JSON value (implicit) + + @since version 1.0.0, public since 2.1.0, `const char*` and `noexcept` + since 3.0.0 + */ + JSON_HEDLEY_RETURNS_NON_NULL + const char* type_name() const noexcept + { + { + switch (m_type) + { + case value_t::null: + return "null"; + case value_t::object: + return "object"; + case value_t::array: + return "array"; + case value_t::string: + return "string"; + case value_t::boolean: + return "boolean"; + case value_t::binary: + return "binary"; + case value_t::discarded: + return "discarded"; + default: + return "number"; + } + } + } + + + private: + ////////////////////// + // member variables // + ////////////////////// + + /// the type of the current element + value_t m_type = value_t::null; + + /// the value of the current element + json_value m_value = {}; + + ////////////////////////////////////////// + // binary serialization/deserialization // + ////////////////////////////////////////// + + /// @name binary serialization/deserialization support + /// @{ + + public: + /*! + @brief create a CBOR serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the CBOR (Concise + Binary Object Representation) serialization format. CBOR is a binary + serialization format which aims to be more compact than JSON itself, yet + more efficient to parse. + + The library uses the following mapping from JSON values types to + CBOR types according to the CBOR specification (RFC 7049): + + JSON value type | value/range | CBOR type | first byte + --------------- | ------------------------------------------ | ---------------------------------- | --------------- + null | `null` | Null | 0xF6 + boolean | `true` | True | 0xF5 + boolean | `false` | False | 0xF4 + number_integer | -9223372036854775808..-2147483649 | Negative integer (8 bytes follow) | 0x3B + number_integer | -2147483648..-32769 | Negative integer (4 bytes follow) | 0x3A + number_integer | -32768..-129 | Negative integer (2 bytes follow) | 0x39 + number_integer | -128..-25 | Negative integer (1 byte follow) | 0x38 + number_integer | -24..-1 | Negative integer | 0x20..0x37 + number_integer | 0..23 | Integer | 0x00..0x17 + number_integer | 24..255 | Unsigned integer (1 byte follow) | 0x18 + number_integer | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 + number_integer | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A + number_integer | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B + number_unsigned | 0..23 | Integer | 0x00..0x17 + number_unsigned | 24..255 | Unsigned integer (1 byte follow) | 0x18 + number_unsigned | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 + number_unsigned | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A + number_unsigned | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B + number_float | *any value representable by a float* | Single-Precision Float | 0xFA + number_float | *any value NOT representable by a float* | Double-Precision Float | 0xFB + string | *length*: 0..23 | UTF-8 string | 0x60..0x77 + string | *length*: 23..255 | UTF-8 string (1 byte follow) | 0x78 + string | *length*: 256..65535 | UTF-8 string (2 bytes follow) | 0x79 + string | *length*: 65536..4294967295 | UTF-8 string (4 bytes follow) | 0x7A + string | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow) | 0x7B + array | *size*: 0..23 | array | 0x80..0x97 + array | *size*: 23..255 | array (1 byte follow) | 0x98 + array | *size*: 256..65535 | array (2 bytes follow) | 0x99 + array | *size*: 65536..4294967295 | array (4 bytes follow) | 0x9A + array | *size*: 4294967296..18446744073709551615 | array (8 bytes follow) | 0x9B + object | *size*: 0..23 | map | 0xA0..0xB7 + object | *size*: 23..255 | map (1 byte follow) | 0xB8 + object | *size*: 256..65535 | map (2 bytes follow) | 0xB9 + object | *size*: 65536..4294967295 | map (4 bytes follow) | 0xBA + object | *size*: 4294967296..18446744073709551615 | map (8 bytes follow) | 0xBB + binary | *size*: 0..23 | byte string | 0x40..0x57 + binary | *size*: 23..255 | byte string (1 byte follow) | 0x58 + binary | *size*: 256..65535 | byte string (2 bytes follow) | 0x59 + binary | *size*: 65536..4294967295 | byte string (4 bytes follow) | 0x5A + binary | *size*: 4294967296..18446744073709551615 | byte string (8 bytes follow) | 0x5B + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a CBOR value. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @note The following CBOR types are not used in the conversion: + - UTF-8 strings terminated by "break" (0x7F) + - arrays terminated by "break" (0x9F) + - maps terminated by "break" (0xBF) + - byte strings terminated by "break" (0x5F) + - date/time (0xC0..0xC1) + - bignum (0xC2..0xC3) + - decimal fraction (0xC4) + - bigfloat (0xC5) + - expected conversions (0xD5..0xD7) + - simple values (0xE0..0xF3, 0xF8) + - undefined (0xF7) + - half-precision floats (0xF9) + - break (0xFF) + + @param[in] j JSON value to serialize + @return CBOR serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in CBOR format.,to_cbor} + + @sa http://cbor.io + @sa @ref from_cbor(detail::input_adapter&&, const bool, const bool, const cbor_tag_handler_t) for the + analogous deserialization + @sa @ref to_msgpack(const basic_json&) for the related MessagePack format + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9; compact representation of floating-point numbers + since version 3.8.0 + */ + static std::vector to_cbor(const basic_json& j) + { + std::vector result; + to_cbor(j, result); + return result; + } + + static void to_cbor(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_cbor(j); + } + + static void to_cbor(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_cbor(j); + } + + /*! + @brief create a MessagePack serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the MessagePack + serialization format. MessagePack is a binary serialization format which + aims to be more compact than JSON itself, yet more efficient to parse. + + The library uses the following mapping from JSON values types to + MessagePack types according to the MessagePack specification: + + JSON value type | value/range | MessagePack type | first byte + --------------- | --------------------------------- | ---------------- | ---------- + null | `null` | nil | 0xC0 + boolean | `true` | true | 0xC3 + boolean | `false` | false | 0xC2 + number_integer | -9223372036854775808..-2147483649 | int64 | 0xD3 + number_integer | -2147483648..-32769 | int32 | 0xD2 + number_integer | -32768..-129 | int16 | 0xD1 + number_integer | -128..-33 | int8 | 0xD0 + number_integer | -32..-1 | negative fixint | 0xE0..0xFF + number_integer | 0..127 | positive fixint | 0x00..0x7F + number_integer | 128..255 | uint 8 | 0xCC + number_integer | 256..65535 | uint 16 | 0xCD + number_integer | 65536..4294967295 | uint 32 | 0xCE + number_integer | 4294967296..18446744073709551615 | uint 64 | 0xCF + number_unsigned | 0..127 | positive fixint | 0x00..0x7F + number_unsigned | 128..255 | uint 8 | 0xCC + number_unsigned | 256..65535 | uint 16 | 0xCD + number_unsigned | 65536..4294967295 | uint 32 | 0xCE + number_unsigned | 4294967296..18446744073709551615 | uint 64 | 0xCF + number_float | *any value representable by a float* | float 32 | 0xCA + number_float | *any value NOT representable by a float* | float 64 | 0xCB + string | *length*: 0..31 | fixstr | 0xA0..0xBF + string | *length*: 32..255 | str 8 | 0xD9 + string | *length*: 256..65535 | str 16 | 0xDA + string | *length*: 65536..4294967295 | str 32 | 0xDB + array | *size*: 0..15 | fixarray | 0x90..0x9F + array | *size*: 16..65535 | array 16 | 0xDC + array | *size*: 65536..4294967295 | array 32 | 0xDD + object | *size*: 0..15 | fix map | 0x80..0x8F + object | *size*: 16..65535 | map 16 | 0xDE + object | *size*: 65536..4294967295 | map 32 | 0xDF + binary | *size*: 0..255 | bin 8 | 0xC4 + binary | *size*: 256..65535 | bin 16 | 0xC5 + binary | *size*: 65536..4294967295 | bin 32 | 0xC6 + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a MessagePack value. + + @note The following values can **not** be converted to a MessagePack value: + - strings with more than 4294967295 bytes + - byte strings with more than 4294967295 bytes + - arrays with more than 4294967295 elements + - objects with more than 4294967295 elements + + @note Any MessagePack output created @ref to_msgpack can be successfully + parsed by @ref from_msgpack. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @param[in] j JSON value to serialize + @return MessagePack serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in MessagePack format.,to_msgpack} + + @sa http://msgpack.org + @sa @ref from_msgpack for the analogous deserialization + @sa @ref to_cbor(const basic_json& for the related CBOR format + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9 + */ + static std::vector to_msgpack(const basic_json& j) + { + std::vector result; + to_msgpack(j, result); + return result; + } + + static void to_msgpack(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_msgpack(j); + } + + static void to_msgpack(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_msgpack(j); + } + + /*! + @brief create a UBJSON serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the UBJSON + (Universal Binary JSON) serialization format. UBJSON aims to be more compact + than JSON itself, yet more efficient to parse. + + The library uses the following mapping from JSON values types to + UBJSON types according to the UBJSON specification: + + JSON value type | value/range | UBJSON type | marker + --------------- | --------------------------------- | ----------- | ------ + null | `null` | null | `Z` + boolean | `true` | true | `T` + boolean | `false` | false | `F` + number_integer | -9223372036854775808..-2147483649 | int64 | `L` + number_integer | -2147483648..-32769 | int32 | `l` + number_integer | -32768..-129 | int16 | `I` + number_integer | -128..127 | int8 | `i` + number_integer | 128..255 | uint8 | `U` + number_integer | 256..32767 | int16 | `I` + number_integer | 32768..2147483647 | int32 | `l` + number_integer | 2147483648..9223372036854775807 | int64 | `L` + number_unsigned | 0..127 | int8 | `i` + number_unsigned | 128..255 | uint8 | `U` + number_unsigned | 256..32767 | int16 | `I` + number_unsigned | 32768..2147483647 | int32 | `l` + number_unsigned | 2147483648..9223372036854775807 | int64 | `L` + number_unsigned | 2147483649..18446744073709551615 | high-precision | `H` + number_float | *any value* | float64 | `D` + string | *with shortest length indicator* | string | `S` + array | *see notes on optimized format* | array | `[` + object | *see notes on optimized format* | map | `{` + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a UBJSON value. + + @note The following values can **not** be converted to a UBJSON value: + - strings with more than 9223372036854775807 bytes (theoretical) + + @note The following markers are not used in the conversion: + - `Z`: no-op values are not created. + - `C`: single-byte strings are serialized with `S` markers. + + @note Any UBJSON output created @ref to_ubjson can be successfully parsed + by @ref from_ubjson. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @note The optimized formats for containers are supported: Parameter + @a use_size adds size information to the beginning of a container and + removes the closing marker. Parameter @a use_type further checks + whether all elements of a container have the same type and adds the + type marker to the beginning of the container. The @a use_type + parameter must only be used together with @a use_size = true. Note + that @a use_size = true alone may result in larger representations - + the benefit of this parameter is that the receiving side is + immediately informed on the number of elements of the container. + + @note If the JSON data contains the binary type, the value stored is a list + of integers, as suggested by the UBJSON documentation. In particular, + this means that serialization and the deserialization of a JSON + containing binary values into UBJSON and back will result in a + different JSON object. + + @param[in] j JSON value to serialize + @param[in] use_size whether to add size annotations to container types + @param[in] use_type whether to add type annotations to container types + (must be combined with @a use_size = true) + @return UBJSON serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in UBJSON format.,to_ubjson} + + @sa http://ubjson.org + @sa @ref from_ubjson(detail::input_adapter&&, const bool, const bool) for the + analogous deserialization + @sa @ref to_cbor(const basic_json& for the related CBOR format + @sa @ref to_msgpack(const basic_json&) for the related MessagePack format + + @since version 3.1.0 + */ + static std::vector to_ubjson(const basic_json& j, + const bool use_size = false, + const bool use_type = false) + { + std::vector result; + to_ubjson(j, result, use_size, use_type); + return result; + } + + static void to_ubjson(const basic_json& j, detail::output_adapter o, + const bool use_size = false, const bool use_type = false) + { + binary_writer(o).write_ubjson(j, use_size, use_type); + } + + static void to_ubjson(const basic_json& j, detail::output_adapter o, + const bool use_size = false, const bool use_type = false) + { + binary_writer(o).write_ubjson(j, use_size, use_type); + } + + + /*! + @brief Serializes the given JSON object `j` to BSON and returns a vector + containing the corresponding BSON-representation. + + BSON (Binary JSON) is a binary format in which zero or more ordered key/value pairs are + stored as a single entity (a so-called document). + + The library uses the following mapping from JSON values types to BSON types: + + JSON value type | value/range | BSON type | marker + --------------- | --------------------------------- | ----------- | ------ + null | `null` | null | 0x0A + boolean | `true`, `false` | boolean | 0x08 + number_integer | -9223372036854775808..-2147483649 | int64 | 0x12 + number_integer | -2147483648..2147483647 | int32 | 0x10 + number_integer | 2147483648..9223372036854775807 | int64 | 0x12 + number_unsigned | 0..2147483647 | int32 | 0x10 + number_unsigned | 2147483648..9223372036854775807 | int64 | 0x12 + number_unsigned | 9223372036854775808..18446744073709551615| -- | -- + number_float | *any value* | double | 0x01 + string | *any value* | string | 0x02 + array | *any value* | document | 0x04 + object | *any value* | document | 0x03 + binary | *any value* | binary | 0x05 + + @warning The mapping is **incomplete**, since only JSON-objects (and things + contained therein) can be serialized to BSON. + Also, integers larger than 9223372036854775807 cannot be serialized to BSON, + and the keys may not contain U+0000, since they are serialized a + zero-terminated c-strings. + + @throw out_of_range.407 if `j.is_number_unsigned() && j.get() > 9223372036854775807` + @throw out_of_range.409 if a key in `j` contains a NULL (U+0000) + @throw type_error.317 if `!j.is_object()` + + @pre The input `j` is required to be an object: `j.is_object() == true`. + + @note Any BSON output created via @ref to_bson can be successfully parsed + by @ref from_bson. + + @param[in] j JSON value to serialize + @return BSON serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in BSON format.,to_bson} + + @sa http://bsonspec.org/spec.html + @sa @ref from_bson(detail::input_adapter&&, const bool strict) for the + analogous deserialization + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + related UBJSON format + @sa @ref to_cbor(const basic_json&) for the related CBOR format + @sa @ref to_msgpack(const basic_json&) for the related MessagePack format + */ + static std::vector to_bson(const basic_json& j) + { + std::vector result; + to_bson(j, result); + return result; + } + + /*! + @brief Serializes the given JSON object `j` to BSON and forwards the + corresponding BSON-representation to the given output_adapter `o`. + @param j The JSON object to convert to BSON. + @param o The output adapter that receives the binary BSON representation. + @pre The input `j` shall be an object: `j.is_object() == true` + @sa @ref to_bson(const basic_json&) + */ + static void to_bson(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_bson(j); + } + + /*! + @copydoc to_bson(const basic_json&, detail::output_adapter) + */ + static void to_bson(const basic_json& j, detail::output_adapter o) + { + binary_writer(o).write_bson(j); + } + + + /*! + @brief create a JSON value from an input in CBOR format + + Deserializes a given input @a i to a JSON value using the CBOR (Concise + Binary Object Representation) serialization format. + + The library maps CBOR types to JSON value types as follows: + + CBOR type | JSON value type | first byte + ---------------------- | --------------- | ---------- + Integer | number_unsigned | 0x00..0x17 + Unsigned integer | number_unsigned | 0x18 + Unsigned integer | number_unsigned | 0x19 + Unsigned integer | number_unsigned | 0x1A + Unsigned integer | number_unsigned | 0x1B + Negative integer | number_integer | 0x20..0x37 + Negative integer | number_integer | 0x38 + Negative integer | number_integer | 0x39 + Negative integer | number_integer | 0x3A + Negative integer | number_integer | 0x3B + Byte string | binary | 0x40..0x57 + Byte string | binary | 0x58 + Byte string | binary | 0x59 + Byte string | binary | 0x5A + Byte string | binary | 0x5B + UTF-8 string | string | 0x60..0x77 + UTF-8 string | string | 0x78 + UTF-8 string | string | 0x79 + UTF-8 string | string | 0x7A + UTF-8 string | string | 0x7B + UTF-8 string | string | 0x7F + array | array | 0x80..0x97 + array | array | 0x98 + array | array | 0x99 + array | array | 0x9A + array | array | 0x9B + array | array | 0x9F + map | object | 0xA0..0xB7 + map | object | 0xB8 + map | object | 0xB9 + map | object | 0xBA + map | object | 0xBB + map | object | 0xBF + False | `false` | 0xF4 + True | `true` | 0xF5 + Null | `null` | 0xF6 + Half-Precision Float | number_float | 0xF9 + Single-Precision Float | number_float | 0xFA + Double-Precision Float | number_float | 0xFB + + @warning The mapping is **incomplete** in the sense that not all CBOR + types can be converted to a JSON value. The following CBOR types + are not supported and will yield parse errors (parse_error.112): + - date/time (0xC0..0xC1) + - bignum (0xC2..0xC3) + - decimal fraction (0xC4) + - bigfloat (0xC5) + - expected conversions (0xD5..0xD7) + - simple values (0xE0..0xF3, 0xF8) + - undefined (0xF7) + + @warning CBOR allows map keys of any type, whereas JSON only allows + strings as keys in object values. Therefore, CBOR maps with keys + other than UTF-8 strings are rejected (parse_error.113). + + @note Any CBOR output created @ref to_cbor can be successfully parsed by + @ref from_cbor. + + @param[in] i an input in CBOR format convertible to an input adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + @param[in] tag_handler how to treat CBOR tags (optional, error by default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if unsupported features from CBOR were + used in the given input @a v or if the input is not valid CBOR + @throw parse_error.113 if a string was expected as map key, but not found + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in CBOR + format to a JSON value.,from_cbor} + + @sa http://cbor.io + @sa @ref to_cbor(const basic_json&) for the analogous serialization + @sa @ref from_msgpack(detail::input_adapter&&, const bool, const bool) for the + related MessagePack format + @sa @ref from_ubjson(detail::input_adapter&&, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9; parameter @a start_index since 2.1.1; changed to + consume input adapters, removed start_index parameter, and added + @a strict parameter since 3.0.0; added @a allow_exceptions parameter + since 3.2.0; added @a tag_handler parameter since 3.9.0. + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_cbor(InputType&& i, + const bool strict = true, + const bool allow_exceptions = true, + const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::forward(i)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::cbor, &sdp, strict, tag_handler); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_cbor(detail::input_adapter&&, const bool, const bool, const cbor_tag_handler_t) + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_cbor(IteratorType first, IteratorType last, + const bool strict = true, + const bool allow_exceptions = true, + const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::move(first), std::move(last)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::cbor, &sdp, strict, tag_handler); + return res ? result : basic_json(value_t::discarded); + } + + template + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_cbor(ptr, ptr + len)) + static basic_json from_cbor(const T* ptr, std::size_t len, + const bool strict = true, + const bool allow_exceptions = true, + const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error) + { + return from_cbor(ptr, ptr + len, strict, allow_exceptions, tag_handler); + } + + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_cbor(ptr, ptr + len)) + static basic_json from_cbor(detail::span_input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true, + const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = i.get(); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::cbor, &sdp, strict, tag_handler); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @brief create a JSON value from an input in MessagePack format + + Deserializes a given input @a i to a JSON value using the MessagePack + serialization format. + + The library maps MessagePack types to JSON value types as follows: + + MessagePack type | JSON value type | first byte + ---------------- | --------------- | ---------- + positive fixint | number_unsigned | 0x00..0x7F + fixmap | object | 0x80..0x8F + fixarray | array | 0x90..0x9F + fixstr | string | 0xA0..0xBF + nil | `null` | 0xC0 + false | `false` | 0xC2 + true | `true` | 0xC3 + float 32 | number_float | 0xCA + float 64 | number_float | 0xCB + uint 8 | number_unsigned | 0xCC + uint 16 | number_unsigned | 0xCD + uint 32 | number_unsigned | 0xCE + uint 64 | number_unsigned | 0xCF + int 8 | number_integer | 0xD0 + int 16 | number_integer | 0xD1 + int 32 | number_integer | 0xD2 + int 64 | number_integer | 0xD3 + str 8 | string | 0xD9 + str 16 | string | 0xDA + str 32 | string | 0xDB + array 16 | array | 0xDC + array 32 | array | 0xDD + map 16 | object | 0xDE + map 32 | object | 0xDF + bin 8 | binary | 0xC4 + bin 16 | binary | 0xC5 + bin 32 | binary | 0xC6 + ext 8 | binary | 0xC7 + ext 16 | binary | 0xC8 + ext 32 | binary | 0xC9 + fixext 1 | binary | 0xD4 + fixext 2 | binary | 0xD5 + fixext 4 | binary | 0xD6 + fixext 8 | binary | 0xD7 + fixext 16 | binary | 0xD8 + negative fixint | number_integer | 0xE0-0xFF + + @note Any MessagePack output created @ref to_msgpack can be successfully + parsed by @ref from_msgpack. + + @param[in] i an input in MessagePack format convertible to an input + adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if unsupported features from MessagePack were + used in the given input @a i or if the input is not valid MessagePack + @throw parse_error.113 if a string was expected as map key, but not found + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in + MessagePack format to a JSON value.,from_msgpack} + + @sa http://msgpack.org + @sa @ref to_msgpack(const basic_json&) for the analogous serialization + @sa @ref from_cbor(detail::input_adapter&&, const bool, const bool, const cbor_tag_handler_t) for the + related CBOR format + @sa @ref from_ubjson(detail::input_adapter&&, const bool, const bool) for + the related UBJSON format + @sa @ref from_bson(detail::input_adapter&&, const bool, const bool) for + the related BSON format + + @since version 2.0.9; parameter @a start_index since 2.1.1; changed to + consume input adapters, removed start_index parameter, and added + @a strict parameter since 3.0.0; added @a allow_exceptions parameter + since 3.2.0 + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_msgpack(InputType&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::forward(i)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::msgpack, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_msgpack(detail::input_adapter&&, const bool, const bool) + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_msgpack(IteratorType first, IteratorType last, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::move(first), std::move(last)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::msgpack, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + + template + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_msgpack(ptr, ptr + len)) + static basic_json from_msgpack(const T* ptr, std::size_t len, + const bool strict = true, + const bool allow_exceptions = true) + { + return from_msgpack(ptr, ptr + len, strict, allow_exceptions); + } + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_msgpack(ptr, ptr + len)) + static basic_json from_msgpack(detail::span_input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = i.get(); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::msgpack, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + + /*! + @brief create a JSON value from an input in UBJSON format + + Deserializes a given input @a i to a JSON value using the UBJSON (Universal + Binary JSON) serialization format. + + The library maps UBJSON types to JSON value types as follows: + + UBJSON type | JSON value type | marker + ----------- | --------------------------------------- | ------ + no-op | *no value, next value is read* | `N` + null | `null` | `Z` + false | `false` | `F` + true | `true` | `T` + float32 | number_float | `d` + float64 | number_float | `D` + uint8 | number_unsigned | `U` + int8 | number_integer | `i` + int16 | number_integer | `I` + int32 | number_integer | `l` + int64 | number_integer | `L` + high-precision number | number_integer, number_unsigned, or number_float - depends on number string | 'H' + string | string | `S` + char | string | `C` + array | array (optimized values are supported) | `[` + object | object (optimized values are supported) | `{` + + @note The mapping is **complete** in the sense that any UBJSON value can + be converted to a JSON value. + + @param[in] i an input in UBJSON format convertible to an input adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if a parse error occurs + @throw parse_error.113 if a string could not be parsed successfully + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in + UBJSON format to a JSON value.,from_ubjson} + + @sa http://ubjson.org + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + analogous serialization + @sa @ref from_cbor(detail::input_adapter&&, const bool, const bool, const cbor_tag_handler_t) for the + related CBOR format + @sa @ref from_msgpack(detail::input_adapter&&, const bool, const bool) for + the related MessagePack format + @sa @ref from_bson(detail::input_adapter&&, const bool, const bool) for + the related BSON format + + @since version 3.1.0; added @a allow_exceptions parameter since 3.2.0 + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_ubjson(InputType&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::forward(i)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::ubjson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_ubjson(detail::input_adapter&&, const bool, const bool) + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_ubjson(IteratorType first, IteratorType last, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::move(first), std::move(last)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::ubjson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + template + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_ubjson(ptr, ptr + len)) + static basic_json from_ubjson(const T* ptr, std::size_t len, + const bool strict = true, + const bool allow_exceptions = true) + { + return from_ubjson(ptr, ptr + len, strict, allow_exceptions); + } + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_ubjson(ptr, ptr + len)) + static basic_json from_ubjson(detail::span_input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = i.get(); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::ubjson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + + /*! + @brief Create a JSON value from an input in BSON format + + Deserializes a given input @a i to a JSON value using the BSON (Binary JSON) + serialization format. + + The library maps BSON record types to JSON value types as follows: + + BSON type | BSON marker byte | JSON value type + --------------- | ---------------- | --------------------------- + double | 0x01 | number_float + string | 0x02 | string + document | 0x03 | object + array | 0x04 | array + binary | 0x05 | still unsupported + undefined | 0x06 | still unsupported + ObjectId | 0x07 | still unsupported + boolean | 0x08 | boolean + UTC Date-Time | 0x09 | still unsupported + null | 0x0A | null + Regular Expr. | 0x0B | still unsupported + DB Pointer | 0x0C | still unsupported + JavaScript Code | 0x0D | still unsupported + Symbol | 0x0E | still unsupported + JavaScript Code | 0x0F | still unsupported + int32 | 0x10 | number_integer + Timestamp | 0x11 | still unsupported + 128-bit decimal float | 0x13 | still unsupported + Max Key | 0x7F | still unsupported + Min Key | 0xFF | still unsupported + + @warning The mapping is **incomplete**. The unsupported mappings + are indicated in the table above. + + @param[in] i an input in BSON format convertible to an input adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value; in case of a parse error and + @a allow_exceptions set to `false`, the return value will be + value_t::discarded. + + @throw parse_error.114 if an unsupported BSON record type is encountered + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in + BSON format to a JSON value.,from_bson} + + @sa http://bsonspec.org/spec.html + @sa @ref to_bson(const basic_json&) for the analogous serialization + @sa @ref from_cbor(detail::input_adapter&&, const bool, const bool, const cbor_tag_handler_t) for the + related CBOR format + @sa @ref from_msgpack(detail::input_adapter&&, const bool, const bool) for + the related MessagePack format + @sa @ref from_ubjson(detail::input_adapter&&, const bool, const bool) for the + related UBJSON format + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_bson(InputType&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::forward(i)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::bson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_bson(detail::input_adapter&&, const bool, const bool) + */ + template + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json from_bson(IteratorType first, IteratorType last, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = detail::input_adapter(std::move(first), std::move(last)); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::bson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + template + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_bson(ptr, ptr + len)) + static basic_json from_bson(const T* ptr, std::size_t len, + const bool strict = true, + const bool allow_exceptions = true) + { + return from_bson(ptr, ptr + len, strict, allow_exceptions); + } + + JSON_HEDLEY_WARN_UNUSED_RESULT + JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_bson(ptr, ptr + len)) + static basic_json from_bson(detail::span_input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser sdp(result, allow_exceptions); + auto ia = i.get(); + const bool res = binary_reader(std::move(ia)).sax_parse(input_format_t::bson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + /// @} + + ////////////////////////// + // JSON Pointer support // + ////////////////////////// + + /// @name JSON Pointer functions + /// @{ + + /*! + @brief access specified element via JSON Pointer + + Uses a JSON pointer to retrieve a reference to the respective JSON value. + No bound checking is performed. Similar to @ref operator[](const typename + object_t::key_type&), `null` values are created in arrays and objects if + necessary. + + In particular: + - If the JSON pointer points to an object key that does not exist, it + is created an filled with a `null` value before a reference to it + is returned. + - If the JSON pointer points to an array index that does not exist, it + is created an filled with a `null` value before a reference to it + is returned. All indices between the current maximum and the given + index are also filled with `null`. + - The special value `-` is treated as a synonym for the index past the + end. + + @param[in] ptr a JSON pointer + + @return reference to the element pointed to by @a ptr + + @complexity Constant. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.404 if the JSON pointer can not be resolved + + @liveexample{The behavior is shown in the example.,operatorjson_pointer} + + @since version 2.0.0 + */ + reference operator[](const json_pointer& ptr) + { + return ptr.get_unchecked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Uses a JSON pointer to retrieve a reference to the respective JSON value. + No bound checking is performed. The function does not change the JSON + value; no `null` values are created. In particular, the special value + `-` yields an exception. + + @param[in] ptr JSON pointer to the desired element + + @return const reference to the element pointed to by @a ptr + + @complexity Constant. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + + @liveexample{The behavior is shown in the example.,operatorjson_pointer_const} + + @since version 2.0.0 + */ + const_reference operator[](const json_pointer& ptr) const + { + return ptr.get_unchecked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Returns a reference to the element at with specified JSON pointer @a ptr, + with bounds checking. + + @param[in] ptr JSON pointer to the desired element + + @return reference to the element pointed to by @a ptr + + @throw parse_error.106 if an array index in the passed JSON pointer @a ptr + begins with '0'. See example below. + + @throw parse_error.109 if an array index in the passed JSON pointer @a ptr + is not a number. See example below. + + @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr + is out of range. See example below. + + @throw out_of_range.402 if the array index '-' is used in the passed JSON + pointer @a ptr. As `at` provides checked access (and no elements are + implicitly inserted), the index '-' is always invalid. See example below. + + @throw out_of_range.403 if the JSON pointer describes a key of an object + which cannot be found. See example below. + + @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. + See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 2.0.0 + + @liveexample{The behavior is shown in the example.,at_json_pointer} + */ + reference at(const json_pointer& ptr) + { + return ptr.get_checked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Returns a const reference to the element at with specified JSON pointer @a + ptr, with bounds checking. + + @param[in] ptr JSON pointer to the desired element + + @return reference to the element pointed to by @a ptr + + @throw parse_error.106 if an array index in the passed JSON pointer @a ptr + begins with '0'. See example below. + + @throw parse_error.109 if an array index in the passed JSON pointer @a ptr + is not a number. See example below. + + @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr + is out of range. See example below. + + @throw out_of_range.402 if the array index '-' is used in the passed JSON + pointer @a ptr. As `at` provides checked access (and no elements are + implicitly inserted), the index '-' is always invalid. See example below. + + @throw out_of_range.403 if the JSON pointer describes a key of an object + which cannot be found. See example below. + + @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. + See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 2.0.0 + + @liveexample{The behavior is shown in the example.,at_json_pointer_const} + */ + const_reference at(const json_pointer& ptr) const + { + return ptr.get_checked(this); + } + + /*! + @brief return flattened JSON value + + The function creates a JSON object whose keys are JSON pointers (see [RFC + 6901](https://tools.ietf.org/html/rfc6901)) and whose values are all + primitive. The original JSON value can be restored using the @ref + unflatten() function. + + @return an object that maps JSON pointers to primitive values + + @note Empty objects and arrays are flattened to `null` and will not be + reconstructed correctly by the @ref unflatten() function. + + @complexity Linear in the size the JSON value. + + @liveexample{The following code shows how a JSON object is flattened to an + object whose keys consist of JSON pointers.,flatten} + + @sa @ref unflatten() for the reverse function + + @since version 2.0.0 + */ + basic_json flatten() const + { + basic_json result(value_t::object); + json_pointer::flatten("", *this, result); + return result; + } + + /*! + @brief unflatten a previously flattened JSON value + + The function restores the arbitrary nesting of a JSON value that has been + flattened before using the @ref flatten() function. The JSON value must + meet certain constraints: + 1. The value must be an object. + 2. The keys must be JSON pointers (see + [RFC 6901](https://tools.ietf.org/html/rfc6901)) + 3. The mapped values must be primitive JSON types. + + @return the original JSON from a flattened version + + @note Empty objects and arrays are flattened by @ref flatten() to `null` + values and can not unflattened to their original type. Apart from + this example, for a JSON value `j`, the following is always true: + `j == j.flatten().unflatten()`. + + @complexity Linear in the size the JSON value. + + @throw type_error.314 if value is not an object + @throw type_error.315 if object values are not primitive + + @liveexample{The following code shows how a flattened JSON object is + unflattened into the original nested JSON object.,unflatten} + + @sa @ref flatten() for the reverse function + + @since version 2.0.0 + */ + basic_json unflatten() const + { + return json_pointer::unflatten(*this); + } + + /// @} + + ////////////////////////// + // JSON Patch functions // + ////////////////////////// + + /// @name JSON Patch functions + /// @{ + + /*! + @brief applies a JSON patch + + [JSON Patch](http://jsonpatch.com) defines a JSON document structure for + expressing a sequence of operations to apply to a JSON) document. With + this function, a JSON Patch is applied to the current JSON value by + executing all operations from the patch. + + @param[in] json_patch JSON patch document + @return patched document + + @note The application of a patch is atomic: Either all operations succeed + and the patched document is returned or an exception is thrown. In + any case, the original value is not changed: the patch is applied + to a copy of the value. + + @throw parse_error.104 if the JSON patch does not consist of an array of + objects + + @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory + attributes are missing); example: `"operation add must have member path"` + + @throw out_of_range.401 if an array index is out of range. + + @throw out_of_range.403 if a JSON pointer inside the patch could not be + resolved successfully in the current JSON value; example: `"key baz not + found"` + + @throw out_of_range.405 if JSON pointer has no parent ("add", "remove", + "move") + + @throw other_error.501 if "test" operation was unsuccessful + + @complexity Linear in the size of the JSON value and the length of the + JSON patch. As usually only a fraction of the JSON value is affected by + the patch, the complexity can usually be neglected. + + @liveexample{The following code shows how a JSON patch is applied to a + value.,patch} + + @sa @ref diff -- create a JSON patch by comparing two JSON values + + @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) + @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901) + + @since version 2.0.0 + */ + basic_json patch(const basic_json& json_patch) const + { + // make a working copy to apply the patch to + basic_json result = *this; + + // the valid JSON Patch operations + enum class patch_operations {add, remove, replace, move, copy, test, invalid}; + + const auto get_op = [](const std::string & op) + { + if (op == "add") + { + return patch_operations::add; + } + if (op == "remove") + { + return patch_operations::remove; + } + if (op == "replace") + { + return patch_operations::replace; + } + if (op == "move") + { + return patch_operations::move; + } + if (op == "copy") + { + return patch_operations::copy; + } + if (op == "test") + { + return patch_operations::test; + } + + return patch_operations::invalid; + }; + + // wrapper for "add" operation; add value at ptr + const auto operation_add = [&result](json_pointer & ptr, basic_json val) + { + // adding to the root of the target document means replacing it + if (ptr.empty()) + { + result = val; + return; + } + + // make sure the top element of the pointer exists + json_pointer top_pointer = ptr.top(); + if (top_pointer != ptr) + { + result.at(top_pointer); + } + + // get reference to parent of JSON pointer ptr + const auto last_path = ptr.back(); + ptr.pop_back(); + basic_json& parent = result[ptr]; + + switch (parent.m_type) + { + case value_t::null: + case value_t::object: + { + // use operator[] to add value + parent[last_path] = val; + break; + } + + case value_t::array: + { + if (last_path == "-") + { + // special case: append to back + parent.push_back(val); + } + else + { + const auto idx = json_pointer::array_index(last_path); + if (JSON_HEDLEY_UNLIKELY(idx > parent.size())) + { + // avoid undefined behavior + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + + // default case: insert add offset + parent.insert(parent.begin() + static_cast(idx), val); + } + break; + } + + // if there exists a parent it cannot be primitive + default: // LCOV_EXCL_LINE + JSON_ASSERT(false); // LCOV_EXCL_LINE + } + }; + + // wrapper for "remove" operation; remove value at ptr + const auto operation_remove = [&result](json_pointer & ptr) + { + // get reference to parent of JSON pointer ptr + const auto last_path = ptr.back(); + ptr.pop_back(); + basic_json& parent = result.at(ptr); + + // remove child + if (parent.is_object()) + { + // perform range check + auto it = parent.find(last_path); + if (JSON_HEDLEY_LIKELY(it != parent.end())) + { + parent.erase(it); + } + else + { + JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found")); + } + } + else if (parent.is_array()) + { + // note erase performs range check + parent.erase(json_pointer::array_index(last_path)); + } + }; + + // type check: top level value must be an array + if (JSON_HEDLEY_UNLIKELY(!json_patch.is_array())) + { + JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); + } + + // iterate and apply the operations + for (const auto& val : json_patch) + { + // wrapper to get a value for an operation + const auto get_value = [&val](const std::string & op, + const std::string & member, + bool string_type) -> basic_json & + { + // find value + auto it = val.m_value.object->find(member); + + // context-sensitive error message + const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'"; + + // check if desired value is present + if (JSON_HEDLEY_UNLIKELY(it == val.m_value.object->end())) + { + JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'")); + } + + // check if result is of type string + if (JSON_HEDLEY_UNLIKELY(string_type && !it->second.is_string())) + { + JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'")); + } + + // no error: return value + return it->second; + }; + + // type check: every element of the array must be an object + if (JSON_HEDLEY_UNLIKELY(!val.is_object())) + { + JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); + } + + // collect mandatory members + const auto op = get_value("op", "op", true).template get(); + const auto path = get_value(op, "path", true).template get(); + json_pointer ptr(path); + + switch (get_op(op)) + { + case patch_operations::add: + { + operation_add(ptr, get_value("add", "value", false)); + break; + } + + case patch_operations::remove: + { + operation_remove(ptr); + break; + } + + case patch_operations::replace: + { + // the "path" location must exist - use at() + result.at(ptr) = get_value("replace", "value", false); + break; + } + + case patch_operations::move: + { + const auto from_path = get_value("move", "from", true).template get(); + json_pointer from_ptr(from_path); + + // the "from" location must exist - use at() + basic_json v = result.at(from_ptr); + + // The move operation is functionally identical to a + // "remove" operation on the "from" location, followed + // immediately by an "add" operation at the target + // location with the value that was just removed. + operation_remove(from_ptr); + operation_add(ptr, v); + break; + } + + case patch_operations::copy: + { + const auto from_path = get_value("copy", "from", true).template get(); + const json_pointer from_ptr(from_path); + + // the "from" location must exist - use at() + basic_json v = result.at(from_ptr); + + // The copy is functionally identical to an "add" + // operation at the target location using the value + // specified in the "from" member. + operation_add(ptr, v); + break; + } + + case patch_operations::test: + { + bool success = false; + JSON_TRY + { + // check if "value" matches the one at "path" + // the "path" location must exist - use at() + success = (result.at(ptr) == get_value("test", "value", false)); + } + JSON_INTERNAL_CATCH (out_of_range&) + { + // ignore out of range errors: success remains false + } + + // throw an exception if test fails + if (JSON_HEDLEY_UNLIKELY(!success)) + { + JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump())); + } + + break; + } + + default: + { + // op must be "add", "remove", "replace", "move", "copy", or + // "test" + JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid")); + } + } + } + + return result; + } + + /*! + @brief creates a diff as a JSON patch + + Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can + be changed into the value @a target by calling @ref patch function. + + @invariant For two JSON values @a source and @a target, the following code + yields always `true`: + @code {.cpp} + source.patch(diff(source, target)) == target; + @endcode + + @note Currently, only `remove`, `add`, and `replace` operations are + generated. + + @param[in] source JSON value to compare from + @param[in] target JSON value to compare against + @param[in] path helper value to create JSON pointers + + @return a JSON patch to convert the @a source to @a target + + @complexity Linear in the lengths of @a source and @a target. + + @liveexample{The following code shows how a JSON patch is created as a + diff for two JSON values.,diff} + + @sa @ref patch -- apply a JSON patch + @sa @ref merge_patch -- apply a JSON Merge Patch + + @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) + + @since version 2.0.0 + */ + JSON_HEDLEY_WARN_UNUSED_RESULT + static basic_json diff(const basic_json& source, const basic_json& target, + const std::string& path = "") + { + // the patch + basic_json result(value_t::array); + + // if the values are the same, return empty patch + if (source == target) + { + return result; + } + + if (source.type() != target.type()) + { + // different types: replace value + result.push_back( + { + {"op", "replace"}, {"path", path}, {"value", target} + }); + return result; + } + + switch (source.type()) + { + case value_t::array: + { + // first pass: traverse common elements + std::size_t i = 0; + while (i < source.size() && i < target.size()) + { + // recursive call to compare array values at index i + auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i)); + result.insert(result.end(), temp_diff.begin(), temp_diff.end()); + ++i; + } + + // i now reached the end of at least one array + // in a second pass, traverse the remaining elements + + // remove my remaining elements + const auto end_index = static_cast(result.size()); + while (i < source.size()) + { + // add operations in reverse order to avoid invalid + // indices + result.insert(result.begin() + end_index, object( + { + {"op", "remove"}, + {"path", path + "/" + std::to_string(i)} + })); + ++i; + } + + // add other remaining elements + while (i < target.size()) + { + result.push_back( + { + {"op", "add"}, + {"path", path + "/-"}, + {"value", target[i]} + }); + ++i; + } + + break; + } + + case value_t::object: + { + // first pass: traverse this object's elements + for (auto it = source.cbegin(); it != source.cend(); ++it) + { + // escape the key name to be used in a JSON patch + const auto key = json_pointer::escape(it.key()); + + if (target.find(it.key()) != target.end()) + { + // recursive call to compare object values at key it + auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key); + result.insert(result.end(), temp_diff.begin(), temp_diff.end()); + } + else + { + // found a key that is not in o -> remove it + result.push_back(object( + { + {"op", "remove"}, {"path", path + "/" + key} + })); + } + } + + // second pass: traverse other object's elements + for (auto it = target.cbegin(); it != target.cend(); ++it) + { + if (source.find(it.key()) == source.end()) + { + // found a key that is not in this -> add it + const auto key = json_pointer::escape(it.key()); + result.push_back( + { + {"op", "add"}, {"path", path + "/" + key}, + {"value", it.value()} + }); + } + } + + break; + } + + default: + { + // both primitive type: replace value + result.push_back( + { + {"op", "replace"}, {"path", path}, {"value", target} + }); + break; + } + } + + return result; + } + + /// @} + + //////////////////////////////// + // JSON Merge Patch functions // + //////////////////////////////// + + /// @name JSON Merge Patch functions + /// @{ + + /*! + @brief applies a JSON Merge Patch + + The merge patch format is primarily intended for use with the HTTP PATCH + method as a means of describing a set of modifications to a target + resource's content. This function applies a merge patch to the current + JSON value. + + The function implements the following algorithm from Section 2 of + [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396): + + ``` + define MergePatch(Target, Patch): + if Patch is an Object: + if Target is not an Object: + Target = {} // Ignore the contents and set it to an empty Object + for each Name/Value pair in Patch: + if Value is null: + if Name exists in Target: + remove the Name/Value pair from Target + else: + Target[Name] = MergePatch(Target[Name], Value) + return Target + else: + return Patch + ``` + + Thereby, `Target` is the current object; that is, the patch is applied to + the current value. + + @param[in] apply_patch the patch to apply + + @complexity Linear in the lengths of @a patch. + + @liveexample{The following code shows how a JSON Merge Patch is applied to + a JSON document.,merge_patch} + + @sa @ref patch -- apply a JSON patch + @sa [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396) + + @since version 3.0.0 + */ + void merge_patch(const basic_json& apply_patch) + { + if (apply_patch.is_object()) + { + if (!is_object()) + { + *this = object(); + } + for (auto it = apply_patch.begin(); it != apply_patch.end(); ++it) + { + if (it.value().is_null()) + { + erase(it.key()); + } + else + { + operator[](it.key()).merge_patch(it.value()); + } + } + } + else + { + *this = apply_patch; + } + } + + /// @} +}; + +/*! +@brief user-defined to_string function for JSON values + +This function implements a user-defined to_string for JSON objects. + +@param[in] j a JSON object +@return a std::string object +*/ + +NLOHMANN_BASIC_JSON_TPL_DECLARATION +std::string to_string(const NLOHMANN_BASIC_JSON_TPL& j) +{ + return j.dump(); +} +} // namespace nlohmann + +/////////////////////// +// nonmember support // +/////////////////////// + +// specialization of std::swap, and std::hash +namespace std +{ + +/// hash value for JSON objects +template<> +struct hash +{ + /*! + @brief return a hash value for a JSON object + + @since version 1.0.0 + */ + std::size_t operator()(const nlohmann::json& j) const + { + return nlohmann::detail::hash(j); + } +}; + +/// specialization for std::less +/// @note: do not remove the space after '<', +/// see https://github.com/nlohmann/json/pull/679 +template<> +struct less<::nlohmann::detail::value_t> +{ + /*! + @brief compare two value_t enum values + @since version 3.0.0 + */ + bool operator()(nlohmann::detail::value_t lhs, + nlohmann::detail::value_t rhs) const noexcept + { + return nlohmann::detail::operator<(lhs, rhs); + } +}; + +// C++20 prohibit function specialization in the std namespace. +#ifndef JSON_HAS_CPP_20 + +/*! +@brief exchanges the values of two JSON objects + +@since version 1.0.0 +*/ +template<> +inline void swap(nlohmann::json& j1, nlohmann::json& j2) noexcept( + is_nothrow_move_constructible::value&& + is_nothrow_move_assignable::value + ) +{ + j1.swap(j2); +} + +#endif + +} // namespace std + +/*! +@brief user-defined string literal for JSON values + +This operator implements a user-defined string literal for JSON objects. It +can be used by adding `"_json"` to a string literal and returns a JSON object +if no parse error occurred. + +@param[in] s a string representation of a JSON object +@param[in] n the length of string @a s +@return a JSON object + +@since version 1.0.0 +*/ +JSON_HEDLEY_NON_NULL(1) +inline nlohmann::json operator "" _json(const char* s, std::size_t n) +{ + return nlohmann::json::parse(s, s + n); +} + +/*! +@brief user-defined string literal for JSON pointer + +This operator implements a user-defined string literal for JSON Pointers. It +can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer +object if no parse error occurred. + +@param[in] s a string representation of a JSON Pointer +@param[in] n the length of string @a s +@return a JSON pointer object + +@since version 2.0.0 +*/ +JSON_HEDLEY_NON_NULL(1) +inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n) +{ + return nlohmann::json::json_pointer(std::string(s, n)); +} + +// #include + + +// restore GCC/clang diagnostic settings +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #pragma GCC diagnostic pop +#endif +#if defined(__clang__) + #pragma GCC diagnostic pop +#endif + +// clean up +#undef JSON_ASSERT +#undef JSON_INTERNAL_CATCH +#undef JSON_CATCH +#undef JSON_THROW +#undef JSON_TRY +#undef JSON_HAS_CPP_14 +#undef JSON_HAS_CPP_17 +#undef NLOHMANN_BASIC_JSON_TPL_DECLARATION +#undef NLOHMANN_BASIC_JSON_TPL +#undef JSON_EXPLICIT + +// #include +#undef JSON_HEDLEY_ALWAYS_INLINE +#undef JSON_HEDLEY_ARM_VERSION +#undef JSON_HEDLEY_ARM_VERSION_CHECK +#undef JSON_HEDLEY_ARRAY_PARAM +#undef JSON_HEDLEY_ASSUME +#undef JSON_HEDLEY_BEGIN_C_DECLS +#undef JSON_HEDLEY_CLANG_HAS_ATTRIBUTE +#undef JSON_HEDLEY_CLANG_HAS_BUILTIN +#undef JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE +#undef JSON_HEDLEY_CLANG_HAS_DECLSPEC_DECLSPEC_ATTRIBUTE +#undef JSON_HEDLEY_CLANG_HAS_EXTENSION +#undef JSON_HEDLEY_CLANG_HAS_FEATURE +#undef JSON_HEDLEY_CLANG_HAS_WARNING +#undef JSON_HEDLEY_COMPCERT_VERSION +#undef JSON_HEDLEY_COMPCERT_VERSION_CHECK +#undef JSON_HEDLEY_CONCAT +#undef JSON_HEDLEY_CONCAT3 +#undef JSON_HEDLEY_CONCAT3_EX +#undef JSON_HEDLEY_CONCAT_EX +#undef JSON_HEDLEY_CONST +#undef JSON_HEDLEY_CONSTEXPR +#undef JSON_HEDLEY_CONST_CAST +#undef JSON_HEDLEY_CPP_CAST +#undef JSON_HEDLEY_CRAY_VERSION +#undef JSON_HEDLEY_CRAY_VERSION_CHECK +#undef JSON_HEDLEY_C_DECL +#undef JSON_HEDLEY_DEPRECATED +#undef JSON_HEDLEY_DEPRECATED_FOR +#undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL +#undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_ +#undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED +#undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES +#undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS +#undef JSON_HEDLEY_DIAGNOSTIC_POP +#undef JSON_HEDLEY_DIAGNOSTIC_PUSH +#undef JSON_HEDLEY_DMC_VERSION +#undef JSON_HEDLEY_DMC_VERSION_CHECK +#undef JSON_HEDLEY_EMPTY_BASES +#undef JSON_HEDLEY_EMSCRIPTEN_VERSION +#undef JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK +#undef JSON_HEDLEY_END_C_DECLS +#undef JSON_HEDLEY_FLAGS +#undef JSON_HEDLEY_FLAGS_CAST +#undef JSON_HEDLEY_GCC_HAS_ATTRIBUTE +#undef JSON_HEDLEY_GCC_HAS_BUILTIN +#undef JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE +#undef JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE +#undef JSON_HEDLEY_GCC_HAS_EXTENSION +#undef JSON_HEDLEY_GCC_HAS_FEATURE +#undef JSON_HEDLEY_GCC_HAS_WARNING +#undef JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK +#undef JSON_HEDLEY_GCC_VERSION +#undef JSON_HEDLEY_GCC_VERSION_CHECK +#undef JSON_HEDLEY_GNUC_HAS_ATTRIBUTE +#undef JSON_HEDLEY_GNUC_HAS_BUILTIN +#undef JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE +#undef JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE +#undef JSON_HEDLEY_GNUC_HAS_EXTENSION +#undef JSON_HEDLEY_GNUC_HAS_FEATURE +#undef JSON_HEDLEY_GNUC_HAS_WARNING +#undef JSON_HEDLEY_GNUC_VERSION +#undef JSON_HEDLEY_GNUC_VERSION_CHECK +#undef JSON_HEDLEY_HAS_ATTRIBUTE +#undef JSON_HEDLEY_HAS_BUILTIN +#undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE +#undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS +#undef JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE +#undef JSON_HEDLEY_HAS_EXTENSION +#undef JSON_HEDLEY_HAS_FEATURE +#undef JSON_HEDLEY_HAS_WARNING +#undef JSON_HEDLEY_IAR_VERSION +#undef JSON_HEDLEY_IAR_VERSION_CHECK +#undef JSON_HEDLEY_IBM_VERSION +#undef JSON_HEDLEY_IBM_VERSION_CHECK +#undef JSON_HEDLEY_IMPORT +#undef JSON_HEDLEY_INLINE +#undef JSON_HEDLEY_INTEL_VERSION +#undef JSON_HEDLEY_INTEL_VERSION_CHECK +#undef JSON_HEDLEY_IS_CONSTANT +#undef JSON_HEDLEY_IS_CONSTEXPR_ +#undef JSON_HEDLEY_LIKELY +#undef JSON_HEDLEY_MALLOC +#undef JSON_HEDLEY_MESSAGE +#undef JSON_HEDLEY_MSVC_VERSION +#undef JSON_HEDLEY_MSVC_VERSION_CHECK +#undef JSON_HEDLEY_NEVER_INLINE +#undef JSON_HEDLEY_NON_NULL +#undef JSON_HEDLEY_NO_ESCAPE +#undef JSON_HEDLEY_NO_RETURN +#undef JSON_HEDLEY_NO_THROW +#undef JSON_HEDLEY_NULL +#undef JSON_HEDLEY_PELLES_VERSION +#undef JSON_HEDLEY_PELLES_VERSION_CHECK +#undef JSON_HEDLEY_PGI_VERSION +#undef JSON_HEDLEY_PGI_VERSION_CHECK +#undef JSON_HEDLEY_PREDICT +#undef JSON_HEDLEY_PRINTF_FORMAT +#undef JSON_HEDLEY_PRIVATE +#undef JSON_HEDLEY_PUBLIC +#undef JSON_HEDLEY_PURE +#undef JSON_HEDLEY_REINTERPRET_CAST +#undef JSON_HEDLEY_REQUIRE +#undef JSON_HEDLEY_REQUIRE_CONSTEXPR +#undef JSON_HEDLEY_REQUIRE_MSG +#undef JSON_HEDLEY_RESTRICT +#undef JSON_HEDLEY_RETURNS_NON_NULL +#undef JSON_HEDLEY_SENTINEL +#undef JSON_HEDLEY_STATIC_ASSERT +#undef JSON_HEDLEY_STATIC_CAST +#undef JSON_HEDLEY_STRINGIFY +#undef JSON_HEDLEY_STRINGIFY_EX +#undef JSON_HEDLEY_SUNPRO_VERSION +#undef JSON_HEDLEY_SUNPRO_VERSION_CHECK +#undef JSON_HEDLEY_TINYC_VERSION +#undef JSON_HEDLEY_TINYC_VERSION_CHECK +#undef JSON_HEDLEY_TI_ARMCL_VERSION +#undef JSON_HEDLEY_TI_ARMCL_VERSION_CHECK +#undef JSON_HEDLEY_TI_CL2000_VERSION +#undef JSON_HEDLEY_TI_CL2000_VERSION_CHECK +#undef JSON_HEDLEY_TI_CL430_VERSION +#undef JSON_HEDLEY_TI_CL430_VERSION_CHECK +#undef JSON_HEDLEY_TI_CL6X_VERSION +#undef JSON_HEDLEY_TI_CL6X_VERSION_CHECK +#undef JSON_HEDLEY_TI_CL7X_VERSION +#undef JSON_HEDLEY_TI_CL7X_VERSION_CHECK +#undef JSON_HEDLEY_TI_CLPRU_VERSION +#undef JSON_HEDLEY_TI_CLPRU_VERSION_CHECK +#undef JSON_HEDLEY_TI_VERSION +#undef JSON_HEDLEY_TI_VERSION_CHECK +#undef JSON_HEDLEY_UNAVAILABLE +#undef JSON_HEDLEY_UNLIKELY +#undef JSON_HEDLEY_UNPREDICTABLE +#undef JSON_HEDLEY_UNREACHABLE +#undef JSON_HEDLEY_UNREACHABLE_RETURN +#undef JSON_HEDLEY_VERSION +#undef JSON_HEDLEY_VERSION_DECODE_MAJOR +#undef JSON_HEDLEY_VERSION_DECODE_MINOR +#undef JSON_HEDLEY_VERSION_DECODE_REVISION +#undef JSON_HEDLEY_VERSION_ENCODE +#undef JSON_HEDLEY_WARNING +#undef JSON_HEDLEY_WARN_UNUSED_RESULT +#undef JSON_HEDLEY_WARN_UNUSED_RESULT_MSG +#undef JSON_HEDLEY_FALL_THROUGH + + + +#endif // INCLUDE_NLOHMANN_JSON_HPP_ diff --git a/examples/BGV_binary_arithmetic/BGV_binary_arithmetic.cpp b/examples/BGV_binary_arithmetic/BGV_binary_arithmetic.cpp index 57905597c..e9c85e1d3 100644 --- a/examples/BGV_binary_arithmetic/BGV_binary_arithmetic.cpp +++ b/examples/BGV_binary_arithmetic/BGV_binary_arithmetic.cpp @@ -64,22 +64,20 @@ int main(int argc, char* argv[]) // 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, /*willBeBootstrappable=*/true); - - // 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.enableBootStrapping( - helib::convert, std::vector>(mvec)); + helib::Context context = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(bits) + .c(c) + .bootstrappable(true) + .mvec(mvec) + .build(); // Print the context. - context.zMStar.printout(); + context.printout(); std::cout << std::endl; // Print the security level. @@ -100,7 +98,7 @@ int main(int argc, char* argv[]) const helib::PubKey& public_key = secret_key; // Get the EncryptedArray of the context. - const helib::EncryptedArray& ea = *(context.ea); + const helib::EncryptedArray& ea = context.getEA(); // Build the unpack slot encoding. std::vector unpackSlotEncoding; diff --git a/examples/BGV_country_db_lookup/BGV_country_db_lookup.cpp b/examples/BGV_country_db_lookup/BGV_country_db_lookup.cpp index cfbbd1c2a..adc9613c6 100644 --- a/examples/BGV_country_db_lookup/BGV_country_db_lookup.cpp +++ b/examples/BGV_country_db_lookup/BGV_country_db_lookup.cpp @@ -128,16 +128,15 @@ int main(int argc, char* argv[]) // This object will hold information about the algebra used for this scheme. std::cout << "\nInitializing the Context ... "; HELIB_NTIMER_START(timer_Context); - helib::Context context(m, p, r); + helib::Context context = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .c(c) + .build(); HELIB_NTIMER_STOP(timer_Context); - // Modify the context, adding primes to the modulus chain - // This defines the ciphertext space - std::cout << "\nBuilding modulus chain ... "; - HELIB_NTIMER_START(timer_CHAIN); - helib::buildModChain(context, bits, c); - HELIB_NTIMER_STOP(timer_CHAIN); - // Secret key management std::cout << "\nCreating Secret Key ..."; HELIB_NTIMER_START(timer_SecKey); @@ -160,12 +159,12 @@ int main(int argc, char* argv[]) HELIB_NTIMER_STOP(timer_PubKey); // Get the EncryptedArray of the context - const helib::EncryptedArray& ea = *(context.ea); + const helib::EncryptedArray& ea = context.getEA(); // Print the context std::cout << std::endl; if (debug) - context.zMStar.printout(); + context.printout(); // Print the security level // Note: This will be negligible to improve performance time. diff --git a/examples/BGV_packed_arithmetic/BGV_packed_arithmetic.cpp b/examples/BGV_packed_arithmetic/BGV_packed_arithmetic.cpp index eb29adcdc..aec3a63e3 100644 --- a/examples/BGV_packed_arithmetic/BGV_packed_arithmetic.cpp +++ b/examples/BGV_packed_arithmetic/BGV_packed_arithmetic.cpp @@ -50,14 +50,16 @@ int main(int argc, char* argv[]) // Initialize context // This object will hold information about the algebra created from the // previously set parameters - helib::Context context(m, p, r); - // 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); + helib::Context context = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .c(c) + .build(); // Print the context - context.zMStar.printout(); + context.printout(); std::cout << std::endl; // Print the security level @@ -78,7 +80,7 @@ int main(int argc, char* argv[]) const helib::PubKey& public_key = secret_key; // Get the EncryptedArray of the context - const helib::EncryptedArray& ea = *(context.ea); + const helib::EncryptedArray& ea = context.getEA(); // Get the number of slot (phi(m)) long nslots = ea.size(); diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index eb1c1226e..54c4af2da 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -31,8 +31,14 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}") -find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) add_subdirectory(BGV_binary_arithmetic) add_subdirectory(BGV_country_db_lookup) add_subdirectory(BGV_packed_arithmetic) +add_subdirectory(tutorial) diff --git a/examples/README.md b/examples/README.md index 2ea277836..3617f39d8 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,12 +1,15 @@ # Examples ## 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. ## What is provided + Currently the examples provided comprise: + - BGV_binary_arithmetic - BGV_country_db_lookup - BGV_packed_arithmetic @@ -14,26 +17,27 @@ Currently the examples provided comprise: More examples are expected to be released at a later date. ## Installation -To compile the examples, you must have HElib already installed on your system + +To compile the examples, you must have HElib already installed on your system (see [INSTALL.md](../INSTALL.md) in this distribution's root directory). The -process is pure CMake. First, create a build directory and move into it. -From `examples/build` run CMake, +process is pure CMake. First, create a build directory and move into it. From +`examples/build` run CMake, -``` +```bash cmake [-Dhelib_DIR=/share/cmake/helib] .. ``` then run make from the same directory with optional number of threads using the `-j` flag for example, -``` +```bash make [-j] ``` The executables for each of the example programs can be found in the `bin` directory. -All tests for the examples are written in bats (a test framework for bash) and +All tests for the examples are written in bats (a test framework for bash) and require [bats-core](https://github.com/bats-core/bats-core/releases/tag/v1.2.1). ## Running the examples @@ -47,9 +51,9 @@ All examples have a help method by passing the `-h` flag, for example The BGV_packed_arithmetic example shows some of the basic arithmetic APIs available for ciphertext and plaintext objects. -The BGV_binary_arithmetic example shows the API for performing binary -arithmetic on a vector of ciphertexts where i-th ciphertext contains the i-th -bit of the binary number. +The BGV_binary_arithmetic example shows the API for performing binary arithmetic +on a vector of ciphertexts where i-th ciphertext contains the i-th bit of the +binary number. The BGV_country_db_lookup example shows a use-case for performing a database lookup on countries and their capitals, more information on this can be found @@ -57,30 +61,37 @@ lookup on countries and their capitals, more information on this can be found ## Running the tests -All tests for the examples are written in bats (a test framework for bash) -and require [bats-core](https://github.com/bats-core/bats-core/releases/tag/v1.2.1). +All tests for the examples are written in bats (a test framework for bash) and +require [bats-core](https://github.com/bats-core/bats-core/releases/tag/v1.2.1). -Note that the tests require that the examples have been successfully compiled -in the `build` directory and available in `build/bin`. To run the tests, one -can simply execute the scripts from within the `examples/tests` directory. +Note that the tests require that the examples have been successfully compiled in +the `build` directory and available in `build/bin`. To run the tests, one can +simply execute the scripts from within the `examples/tests` directory. To run all tests type the command below. Optionally, the `-j` flag can use threads to parallelize the tests. Note, this requires GNU parallel, see the [bats](https://github.com/bats-core/bats-core) documentation for more -information. -``` +information. + +```bash bats . [-j ] ``` -To run a specific test file. -``` + +To run a specific test file. + +```bash bats [-j ] ``` -or -``` + +or + +```bash ./ [-j ] ``` + To run a specific test by name add the `-f` flag e.g. -``` + +```bash bats . -f [-j ] ``` @@ -89,6 +100,7 @@ matches. For debugging, it is sometimes useful to view the artifacts generated by the tests. For this, set the environment variable `DEBUG` to `true` or `1` such as, -``` + +```bash DEBUG=1 bats . [-j ] ``` diff --git a/examples/tests/BGV_packed_arithmetic.bats b/examples/tests/BGV_packed_arithmetic.bats index 8eaaddfcd..05b5f9848 100755 --- a/examples/tests/BGV_packed_arithmetic.bats +++ b/examples/tests/BGV_packed_arithmetic.bats @@ -26,8 +26,8 @@ function teardown { remove-test-directory "$tmp_folder" } -results=("[[0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0], [0]]" - "[[2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2], [2]]") +results=("{\"HElibVersion\":\"$(helib_version)\",\"content\":{\"scheme\":\"BGV\",\"slots\":[[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0],[0]]},\"serializationVersion\":\"0.0.1\",\"type\":\"Ptxt\"}" + "{\"HElibVersion\":\"$(helib_version)\",\"content\":{\"scheme\":\"BGV\",\"slots\":[[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2],[2]]},\"serializationVersion\":\"0.0.1\",\"type\":\"Ptxt\"}") @test "BGV_packed_arithmetic works" { run $BGV_packed_arithmetic diff --git a/examples/tests/std.bash b/examples/tests/std.bash index cce73e537..3a6863ca4 100644 --- a/examples/tests/std.bash +++ b/examples/tests/std.bash @@ -15,9 +15,14 @@ function random-char-string { } tmp_folder="tmp_$(random-char-string)" +helib_root="../.." examples_root="../.." examples_bin="$examples_root/build/bin" +function helib_version { + cat "${helib_root}/VERSION" +} + function assert { if "$@"; then return 0 diff --git a/examples/tutorial/01_ckks_basics.cpp b/examples/tutorial/01_ckks_basics.cpp new file mode 100644 index 000000000..eda1aadfa --- /dev/null +++ b/examples/tutorial/01_ckks_basics.cpp @@ -0,0 +1,229 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, plaintexts are vectors of real or complex +// numbers. The length, n, of these vectors is determined by the choice of +// parameters, as discussed below. We often refer to the components of these +// vectors as "slots", which are indexed 0, ..., n-1. We can add, subtract, or +// multiply two ciphertexts, and the corresponding operations are carried out +// slot by slot. This is sometimes referred to as a "SIMD operation" (SIMD +// means Single Instruction Multiple Data), since we can effectively perform +// the same scalar operation in parallel on all n slots. + +int main(int argc, char* argv[]) +{ + // To get started, we need to choose some parameters. This is done by + // initializing a Context object. Since there are a lot of parameters, many + // of them optional, HElib provides a "builder pattern" then lets you provide + // these parameters "by name". + + Context context = + + // initialize a Context object using the builder pattern + ContextBuilder() + + .m(16 * 1024) + // m is the "cyclotomic index". For CKKS, m must be a power of 2. As + // m increases, you get more security and more slots, but the + // performance degrades and the size of a ciphertext increases. See + // table below for more information. + + .bits(119) + // bits specifies the number of bits in the "ciphertext modulus". As + // bits increases, you get less security, but you can perform deeper + // homomorphic computations; in addition, the size of a ciphertext + // increases. See table below for more information. Also see + // 02_depth.cpp for more information about how depth and bits are + // related. + + .precision(20) + // precision specifies the number of bits of precision when data is + // encoded, encrypted, or decrypted. More precisely, each of these + // operations are designed to add an error term of at most + // 2^{-precision} to each slot. As precision increases, the allowed + // depth of homomorphic computations decreases (but security and + // performance are not affected). It is not recommended to use + // precision greater than about 40 or so. + + .c(2) + // c specifies the number of columns in key-switching matrices. Yes, + // it sounds very technical, and it is. However, all you have to know + // about this parameter is that as c increases, you get a little more + // security, but performance degrades and the memory requirement for + // the public key increases. c must be at least 2 and it is not + // recommended to set c higher than 8. See table below for more + // information. + + .build(); + // last step of the builder pattern + + // The following table lists settings of m, bits, and c that yield (at least) + // 128-bit security. It is highly recommended to only use settings from this + // table. + // + // m bits c + // 16384 119 2 + // 32768 358 6 + // 32768 299 3 + // 32768 239 2 + // 65536 725 8 + // 65536 717 6 + // 65536 669 4 + // 65536 613 3 + // 65536 558 2 + // 131072 1445 8 + // 131072 1435 6 + // 131072 1387 5 + // 131072 1329 4 + // 131072 1255 3 + // 131072 1098 2 + // 262144 2940 8 + // 262144 2870 6 + // 262144 2763 5 + // 262144 2646 4 + // 262144 2511 3 + // 262144 2234 2 + + // We can print out the estimated security level. + // This estimate is based on the LWE security estimator. + cout << "securityLevel=" << context.securityLevel() << "\n"; + + // Get the number of slots, n. Note that for CKKS, we always have n=m/4. + long n = context.getNSlots(); + + // Construct a secret key. A secret key must be associated with a specific + // Context, which is passed (by reference) to the constructor. Programming + // note: to avoid dangling pointers, the given Context object must not be + // destroyed while any objects associated with it are still in use. + SecKey secretKey(context); + + // Constructing a secret key does not actually do very much. To actually + // build a full-fledged secret key, we have to invoke the GenSecKey method. + secretKey.GenSecKey(); + + // In HElib, the SecKey class is actually a subclass if the PubKey class. So + // one way to initialize a public key object is like this: + const PubKey& publicKey = secretKey; + + // TECHNICAL NOTE: Note the "&" in the declaration of publicKey. Since the + // SecKey class is a subclass of PubKey, this particular PubKey object is + // ultimately a SecKey object, and through the magic of C++ polymorphism, + // encryptions done via publicKey will actually use the secret key, which has + // certain advantages. If one left out the "&", then encryptions done via + // publicKey will NOT use the secret key. + + //=========================================================================== + + // Let's encrypt something! + // HElib provides a number of idioms for encrypting and decrypting. We focus + // on one particular idiom here. + + // We start by declaring a vector of length n, and we fill it with some + // arbitrary numbers. Note that PI is defined by HElib. + vector v0(n); + for (long i = 0; i < n; i++) + v0[i] = sin(2.0 * PI * i / n); + + // Next, we load the plaintext vector v0 into a special type of container, + // called a PtxtArray. Note that a PtxtArray is associated with a Context + // object, which is passed (by reference) to the constructor. + PtxtArray p0(context, v0); + + // Note that many types of vectors can be loaded into a PtxtArray object + // (including, vectors of int, long, double, or even complex). Also + // note that constructing p0 and loading v0 into could have been done in two + // separate steps: + // PtxtArray p0(context); p0.load(v0); + + // Next, we construct a ciphertext c0. A ciphertext is associated with a + // PubKey object, which is passed (by reference) to the constructor. + // Programming note: to avoid dangling pointers, the given PubKey object must + // not be destroyed while any objects associated with it are still in use. + Ctxt c0(publicKey); + + // Finally, we can encrypt p0 and store it in c0: + p0.encrypt(c0); + // Note that since a ciphertext is always associated with a public key, there + // is no need to pass a public key as a separate parameter to the encryption + // method. + + //=========================================================================== + + // We next create another ciphertext c1, in a slightly different way. + // First, we construct another PtxtArray p1: + PtxtArray p1(context); + + // Next, we fill all n slots of p1 with random numbers in the interval [0,1]: + p1.random(); + + // Finally, we encrypt p1 and store it in c1, as above: + Ctxt c1(publicKey); + p1.encrypt(c1); + + //=========================================================================== + + // We next create a ciphertext c2, in the same as was we did c1: + PtxtArray p2(context); + p2.random(); + Ctxt c2(publicKey); + p2.encrypt(c2); + + //=========================================================================== + + // Now we homorphically compute c3 = c0*c1 + c2*1.5: + Ctxt c3 = c0; + c3 *= c1; + Ctxt c4 = c2; + c4 *= 1.5; + c3 += c4; + + // When this is done, if we denote the i-th slot of a ciphertext c by c[i], + // then we have c3[i] = c0[i]*c1[i] + c2[i]*1.5 for i = 0..n-1. + + //=========================================================================== + + // Next we decrypt c3. + // First, we construct a new PtxtArray pp3. + PtxtArray pp3(context); + + // Next, we decrypt c3, storing the plaintext in p3: + pp3.decrypt(c3, secretKey); + + // Finally, we store the PtxtArray p3 into a standard vector v3: + vector v3; + pp3.store(v3); + + //=========================================================================== + + // If we like, we can test the accuracy of the computation. + // First, we perform the same computation directly on plaintexts. + // The PtxtArray class allows this to be done very easily: + PtxtArray p3 = p0; + p3 *= p1; + PtxtArray p4 = p2; + p4 *= 1.5; + p3 += p4; + + // Then, we compute the distance between p3 (computed on plaintexts) and pp3 + // (computed homomorphically on ciphertexts). This is computed as + // max{ |p3[i]-pp3[i]| : i = 0..n-1 } + double distance = Distance(p3, pp3); + + cout << "distance=" << distance << "\n"; + + return 0; +} diff --git a/examples/tutorial/02_ckks_depth.cpp b/examples/tutorial/02_ckks_depth.cpp new file mode 100644 index 000000000..d8c1df708 --- /dev/null +++ b/examples/tutorial/02_ckks_depth.cpp @@ -0,0 +1,140 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, ciphertexts have a certain amount of "noise". +// This noise increases with the depth of a homomorphic computation, where by +// "depth", we mean the depth of the arithmetic circuit representing the +// computation. Noise negatively impacts a homomorphic computation in two ways: +// as it grows, it reduces both the *capacity* and the *accuracy* of a +// ciphertext. +// +// The capacity of a ciphertext starts out as some number which is a little +// less than to the bits parameter specified when building a Context object, +// and it is reduced by some amount by each homomorphic computation. When the +// capacity drops below 1, the ciphertext can no longer be decrypted. +// +// The accuracy can be measured in terms of the *absolute error* of a +// ciphertext c compared to the plaintext p that it should encrypt. The +// absolute error of c is defined to be max{|c[i]-p[i]| : i=1..n-1}. Here, n is +// the number of slots. The absolute error of a freshly encrypted ciphertext +// should be no more than (about) 2^{-precision}, where precision is a +// parameter specified in building a Context object. The absolute error will +// grow as a homomorphic computation proceeds. +// +// Given a ciphertext c, one can obtain its capacity by invoking c.capacity(), +// and one can obtain a bound on its absolute error by invoking c.errorBound(). + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(32 * 1024) + .bits(358) + .precision(20) + .c(6) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // Let's square c a few times and see what happens + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // Let's perform the same computation on the plaintext: + p *= p; + p *= p; + p *= p; + p *= p; + p *= p; + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + //=========================================================================== + + // On my machine, I get the following output: + // + // c.capacity=328.497 c.errorBound=1.28242e-06 + // c.capacity=289.748 c.errorBound=2.69423e-06 + // c.capacity=252.063 c.errorBound=5.71405e-06 + // c.capacity=213.502 c.errorBound=1.1591e-05 + // c.capacity=176.579 c.errorBound=2.37053e-05 + // c.capacity=139.634 c.errorBound=4.79147e-05 + // distance=1.84256e-05 + // + // So we see that we start out with capacity about 328 (which is somewhat + // less than the value 358 of the bits parameter), and an errorBound of + // 1.28242e-06, which is slightly larger than 2^{-20} = 2^{-precision}. + // After each squaring, capacity decreases by 37-39, while errorBound + // increases by about a factor of 2 (i.e., we lose one bit of precision). + // Finally, when we decrypt, we see the actual error (1.84256e-05) is + // somewhat smaller than errorBound (4.79147e-05). + // + // Note that the values returned by capacity() and errorBound() may vary from + // one run of the program to another, even if all the parameters and + // plaintext data are the same. However, they should not change by much from + // one run to another. + + return 0; +} diff --git a/examples/tutorial/03_ckks_data_movement.cpp b/examples/tutorial/03_ckks_data_movement.cpp new file mode 100644 index 000000000..cbbc18fc6 --- /dev/null +++ b/examples/tutorial/03_ckks_data_movement.cpp @@ -0,0 +1,153 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, besides SIMD operations that act on the slots +// of a ciphertext in parallel, it is also possible to move data around among +// the slots of a ciphertext. + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(32 * 1024) + .bits(358) + .precision(30) + .c(6) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + // To support data movement, we need to add some information to the public + // key. This is done as follows: + addSome1DMatrices(secretKey); + + // Recall that SecKey is a subclass of PubKey. The call to addSome1DMatrices + // needs data stored in the secret key, but the information it computes is + // stored in the public key. + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can rotate the data in the slots by any amount. + + rotate(c, 2); + // rotate c right by 2: + // (c[0], ..., c[n-1]) = (c[n-2], c[n-1], c[0], c[1], ..., c[n-3]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + rotate(c, -1); + // rotate c left by 1 + // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], c[0]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can shift the data in the slots by any amount. + + shift(c, 2); + // rotate c right by 2: + // (c[0], ..., c[n-1]) = (0, 0, c[0], c[1], ..., c[n-3]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + shift(c, -1); + // rotate c left by 1 + // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], 0) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can also sum all of slots, leaving the sum in each slot + + totalSums(c); + // (c[0], ..., c[n-1]) = (S, ..., S), where S = sum_{i=0}^{n-1} c[i] + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + // There are a number of other data movement operations available. + + //=========================================================================== + + // Let's perform the same computation on the plaintext: + + rotate(p, 2); + rotate(p, -1); + shift(p, 2); + shift(p, -1); + totalSums(p); + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + // For debugging, you can also make "approximate" comparisons as follows: + if (pp == Approx(p)) + cout << "GOOD\n"; + else + cout << "BAD\n"; + + // Here, p is the "correct value" and you want to test if pp is "close" to it. + + // NOTES: The Approx function (which is really a class constructor) takes two + // optional arguments: + // double tolerance; // default is 0.01 + // double floor; // default is 1.0 + // + // The expression + // a == Approx(b, tolerance, floor) + // is true iff Distance(a,b) <= tolerance*max(Norm(b),floor), The idea is + // that it checks if the relative error is at most tolerance, unless Norm(b) + // itself is too small (as determined by floor). Here, Norm(b) is the max + // absolute value of the slots, and Distance(a,b) = Norm(a-b). + // + // In addition to PtxtArray's, you can compare values of type double or + // complex, and vectors of type double or complex. + + return 0; +} diff --git a/examples/tutorial/04_ckks_matmul.cpp b/examples/tutorial/04_ckks_matmul.cpp new file mode 100644 index 000000000..e218797a7 --- /dev/null +++ b/examples/tutorial/04_ckks_matmul.cpp @@ -0,0 +1,171 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, since a ciphertext encrypts a vector +// of slots, it makes sense to multiply that vector by a matrix. +// HElib provides highly optimized routines for multiplying +// an encrypted vector by a plaintext matrix. + +// To use these routines, we need to include an extra file: +#include + +// In this example, we will also make some performance measurements. HElib +// provides convenient "timers" to measure running time. We will also be +// measuring space. For this, we will use the getrusage function, if available: + +#if defined(__unix__) || defined(__unix) || defined(unix) +#include +#include +void printMemoryUsage() +{ + struct rusage r; + getrusage(RUSAGE_SELF, &r); + cout << " ru_maxrss=" << r.ru_maxrss << endl; +} +#else +void printMemoryUsage() {} +#endif + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(16 * 1024) + .bits(119) + .precision(30) + .c(2) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + addSome1DMatrices(secretKey); + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We define a plaintext matrix as follows: + MatMul_CKKS mat(context, + [n](long i, long j) { return ((i + j) % n) / double(n); }); + + // Note that the second parameter of the MatMul_CKKS constructor is of type + // std::function, meaning that it should be a + // function-like object that takes two long's and returns a double. In this + // example, the actual parameter is a C++ "lambda" object. + + // We now multiply ciphertext c by this matrix: + c *= mat; + + // Note that this computes c = c*mat, where the slots of c are viewed as a + // row vector + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + // We can multiply the plaintext p by the same matrix: + p *= mat; + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + //=========================================================================== + + // If a given matrix is going to be used many times, one can obtain better + // performance by doing a one-time pre-computation. Let's begin by + // performing the same ciphertext/matrix multiplication, but this + // time, let's measure the running time. HElib provides a convenient + // mechanism for doing this: + + Ctxt c0 = c; + HELIB_NTIMER_START(mul0); // starts a timer called "mul0" + c0 *= mat; + HELIB_NTIMER_STOP(mul0); // stops the time "mul0" + printNamedTimer(cout, "mul0"); + // On my machine, this took about 4.6s + + // A pre-computation is performed by "encoding" the matrix, as follows: + HELIB_NTIMER_START(encode); + EncodedMatMul_CKKS emat(mat); + HELIB_NTIMER_STOP(encode); + printNamedTimer(cout, "encode"); + // On my machine, this took about 2.4s + + // We can apply the encoded matrix to a ciphertext as follows: + Ctxt c1 = c; + + { + HELIB_NTIMER_START(mul1); + c1 *= emat; + } // The timer "mul1" automatically gets stopped when control exits the block + printNamedTimer(cout, "mul1"); + // On my machine, this took about 2.4s + + // We can perform even more precomputation, but it takes up more space. + // First, let's see how much space we are currently using: + printMemoryUsage(); + // On my machine, the memory footprint is now about 340MB + + // Now do more pre-computation: + { + HELIB_NTIMER_START(upgrade); + emat.upgrade(); + } + printNamedTimer(cout, "upgrade"); + // On my machine, this took about 1.7s + + // And let's see how much the space increased: + printMemoryUsage(); + // On my machine, the memory footprint is now about 850MB, + // and so the upgrade costs about 510MB of space. + + // Now we apply the upgraded encoded matrix to the ciphertext: + Ctxt c2 = c; + + { + HELIB_NTIMER_START(mul2); + c2 *= emat; + } + printNamedTimer(cout, "mul2"); + // On my machine, this took about 1.4s. Compared the original time of 4.6s, + // we see a roughly 3.3x speedup. + + return 0; +} diff --git a/examples/tutorial/05_ckks_multlowlvl.cpp b/examples/tutorial/05_ckks_multlowlvl.cpp new file mode 100644 index 000000000..ace59a437 --- /dev/null +++ b/examples/tutorial/05_ckks_multlowlvl.cpp @@ -0,0 +1,129 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme (as well as in BGV), ciphertext multiplication +// is a two-step process. The operation ctxt1 *= ctxt2 is equivalent to the +// following: +// ctxt1.multLowLvl(ctxt2); +// ctxt1.reLinearize(); +// The operation ctxt1.multLowLvl(ctxt2) multiplies ctxt1 by ctxt2, but it +// leaves ctxt1 in a non-canonical state. The operation ctxt1.reLinearize() +// puts ctxt1 back into a canonical state. As it happens, +// ctxt1.multLowLvl(ctxt2) is a very fast operation, while ctxt1.reLinearize() +// is a much slower operation. In addition, some operations, such as +// ciphertext addition, can be applied directly to ciphertexts in non-canonical +// states, yielding ciphertexts also in a non-canonical state. This behavior +// can sometimes be exploited to achieve significant speedups, as illustrated +// here. + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(16 * 1024) + .bits(119) + .precision(20) + .c(2) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt a bunch of random ciphertexts + + int len = 3; + + vector p, q; + for (int i = 0; i < len; i++) { + p.emplace_back(context); + p[i].random(); + q.emplace_back(context); + q[i].random(); + } + + // p[i] is a random PtxtArray for i = 0..len-1 + // q[i] is a random PtxtArray for i = 0..len-1 + + vector c, d; + for (int i = 0; i < len; i++) { + c.emplace_back(publicKey); + p[i].encrypt(c[i]); + d.emplace_back(publicKey); + q[i].encrypt(d[i]); + } + + // c[i] encrypts p[i] for i = 0..len-1 + // d[i] encrypts q[i] for i = 0..len-1 + + //=========================================================================== + + // Now let's compute the inner product e = sum_{i=0}^{len-1} c[i]*d[i] using + // multLowLvl. NOTE: this is for illustration purposes only, as HElib already + // provides a function innerProduct that does the same thing in essentially + // the same way. + + Ctxt e(publicKey); + // We use the fact that a freshly constructed ciphertext acts like an + // encryption of 0 + + for (int i = 0; i < len; i++) { + Ctxt tmp = c[i]; + tmp.multLowLvl(d[i]); + // tmp is now c[i]*d[i] but in a non-canonical state + + e += tmp; + // e is now c[0]*d[0] + ... c[i]*d[i] but in a non-canonical state + } + + e.reLinearize(); + // This puts e back into a canonical state. In this example, we do not really + // have to do this, but if e were to be used in other computations, it would + // likely be more efficient to put e into a canonical state once and for all + // at this point. The point is, if we had written the above loop with + // tmp *= d[i] instead of tmp.multLowLvl(d[i]), we would have preformed len + // expensive reLinearize operations, instead of just one. + + //=========================================================================== + + // Let's do the same computation on plaintexts to check the results. + + PtxtArray r(context); + // We use the fact that a freshly constructed plaintext is 0 + + for (int i = 0; i < len; i++) { + PtxtArray tmp = p[i]; + tmp *= q[i]; + r += tmp; + } + + // Let's decrypt and compare: + PtxtArray rr(context); + rr.decrypt(e, secretKey); + + double distance = Distance(r, rr); + cout << "distance=" << distance << "\n"; + + return 0; +} diff --git a/examples/tutorial/06_ckks_serialization.cpp b/examples/tutorial/06_ckks_serialization.cpp new file mode 100644 index 000000000..33b02bf73 --- /dev/null +++ b/examples/tutorial/06_ckks_serialization.cpp @@ -0,0 +1,98 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +// To do useful CKKS work, we need the ability to write +// our objects to disk or to transmit them. +// This is a sample program for education purposes only. +// It attempts to show the serialization/deserialization +// operations that can be performed on contexts, public +// keys, secret keys, plaintexts, and ciphertexts. + +// NOTE The serialization used in this program reads and +// writes to JSON for demonstration. However, once you +// feel more confident you can also try the binary +// serialization APIs which are similar to these JSON +// ones. + +// NOTE In this tutorial program we introduce a different +// API for creating plaintext objects. These objects can be +// (de)serialised. + +#include + +#include + +int main(int argc, char* argv[]) +{ + // CKKS context created with a builder. + helib::Context CKKS_context = helib::ContextBuilder() + .m(128) + .precision(20) + .bits(30) + .c(3) + .build(); + + // Print context to stdout + std::cout << "*** CKKS context:\n"; + // Below we pretty print the JSON. If you do not wish to pretty print an + // alternative is to call `CKKS_context.writeJSON(std::cout);` + std::cout << CKKS_context.writeToJSON().pretty() << std::endl; + + // Create a secret key associated with the CKKS context + helib::SecKey secret_key(CKKS_context); + + // Generate the secret key + secret_key.GenSecKey(); + + // Compute key-switching matrices that we need + helib::addSome1DMatrices(secret_key); + + // Print secret key to stdout + std::cout << "\n\n*** Secret Key:\n"; + std::cout << secret_key.writeToJSON().pretty() << std::endl; + + // Create an alias public key part from the secret key + const helib::PubKey& public_key = secret_key; + + // Print the public key to stdout + std::cout << "\n\n*** Public Key:\n"; + std::cout << public_key.writeToJSON().pretty() << std::endl; + + // Get the EncryptedArray of the context + const helib::EncryptedArray& ea = CKKS_context.getEA(); + + // Create a Ptxt data object + std::vector data(ea.size()); + + // Generate some data + std::iota(data.begin(), data.end(), 0); + + // Create a ptxt. Note that in this tutorial we make use of the + // alternative ptxt API. + helib::Ptxt ptxt(CKKS_context, data); + + // Print the ptxt to stdout + std::cout << "\n\n*** Ptxt:\n"; + std::cout << ptxt.writeToJSON().pretty() << std::endl; + + // Create a ctxt + helib::Ctxt ctxt(public_key); + + // Encrypt `data` into the ciphertext + ea.getCx().encrypt(ctxt, public_key, data); + + // Print the ctxt to stdout + std::cout << "\n\n*** Ctxt:\n"; + std::cout << ctxt.writeToJSON().pretty() << std::endl; + + return 0; +} diff --git a/examples/tutorial/07_ckks_deserialization.cpp b/examples/tutorial/07_ckks_deserialization.cpp new file mode 100644 index 000000000..62332c3c7 --- /dev/null +++ b/examples/tutorial/07_ckks_deserialization.cpp @@ -0,0 +1,238 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +// To do useful CKKS work, we need the ability to write +// our objects to disk or to transmit them. +// This is a sample program for education purposes only. +// It attempts to show the serialization/deserialization +// operations that can be performed on contexts, public +// keys, secret keys, plaintexts, and ciphertexts. + +// NOTE The serialization used in this program reads and +// writes to JSON for demonstration. However, once you +// feel more confident you can also try the binary +// serialization APIs which are similar to these JSON +// ones. + +// NOTE In this tutorial program we introduce a different +// API for creating plaintext objects. These objects can be +// (de)serialised. + +#include + +#include + +int main(int argc, char* argv[]) +{ + // CKKS context created with a builder. + helib::Context CKKSContext = helib::ContextBuilder() + .m(128) + .precision(20) + .bits(30) + .c(3) + .build(); + + std::ofstream outContextFile; + outContextFile.open("context.json", std::ios::out); + if (outContextFile.is_open()) { + // Write the context to a file + CKKSContext.writeToJSON(outContextFile); + // Close the ofstream + outContextFile.close(); + } else { + throw std::runtime_error("Could not open file 'context.json'."); + } + + std::ifstream inContextFile; + inContextFile.open("context.json"); + if (inContextFile.is_open()) { + // Read in the context from the file + helib::Context deserializedContext = + helib::Context::readFromJSON(inContextFile); + // Close the ifstream + inContextFile.close(); + } else { + throw std::runtime_error("Could not open file 'context.json'."); + } + // Remove the context file. Comment out the line below if you would like to + // inspect the file. + std::remove("context.json"); + + // Create a secret key associated with the CKKS context + helib::SecKey secretKey(CKKSContext); + + // Generate the secret key + secretKey.GenSecKey(); + + // Compute key-switching matrices that we need + helib::addSome1DMatrices(secretKey); + + std::ofstream outSecretKeyFile; + outSecretKeyFile.open("sk.json", std::ios::out); + if (outSecretKeyFile.is_open()) { + // Write the secret key to a file + secretKey.writeToJSON(outSecretKeyFile); + // Close the ofstream + outSecretKeyFile.close(); + } else { + throw std::runtime_error("Could not open file 'sk.json'."); + } + + std::ifstream inSecretKeyFile; + inSecretKeyFile.open("sk.json"); + if (inSecretKeyFile.is_open()) { + // Read in the secret key from the file + helib::SecKey deserializedSecretKey = + helib::SecKey::readFromJSON(inSecretKeyFile, CKKSContext); + // Note there are alternative methods for deserialization of SecKey objects. + // After initialization + // helib::SecKey deserializedSecretKey(CKKSContext); + // One can write + // inSecretKeyFile >> deserializedSecretKey; + // Or alternatively + // deserializedSecretKey.readJSON(inSecretKeyFile); + + // Close the ifstream + inSecretKeyFile.close(); + } else { + throw std::runtime_error("Could not open file 'sk.json'."); + } + // Remove the context file. Comment out the line below if you would like to + // inspect the file. + std::remove("sk.json"); + + // Create an alias public key part from the secret key + const helib::PubKey& publicKey = secretKey; + + std::ofstream outPublicKeyFile; + outPublicKeyFile.open("pk.json", std::ios::out); + if (outPublicKeyFile.is_open()) { + // Write the public key to a file + publicKey.writeToJSON(outPublicKeyFile); + // Close the ofstream + outPublicKeyFile.close(); + } else { + throw std::runtime_error("Could not open file 'pk.json'."); + } + + std::ifstream inPublicKeyFile; + inPublicKeyFile.open("pk.json"); + if (inPublicKeyFile.is_open()) { + // Read in the public key from the file + helib::PubKey deserializedPublicKey = + helib::PubKey::readFromJSON(inPublicKeyFile, CKKSContext); + // Note there are alternative methods for deserialization of PubKey objects. + // After initialization + // helib::PubKey deserializedPublicKey(CKKSContext); + // One can write + // inPublicKeyFile >> deserializedPublicKey; + // Or alternatively + // deserializedPublicKey.readJSON(inPublicKeyFile); + + // Close the ifstream + inPublicKeyFile.close(); + } else { + throw std::runtime_error("Could not open file 'pk.json'."); + } + // Remove the context file. Comment out the line below if you would like to + // inspect the file. + std::remove("pk.json"); + + // Get the EncryptedArray of the context + const helib::EncryptedArray& ea = CKKSContext.getEA(); + + // Create a Ptxt data object + std::vector data(ea.size()); + + // Generate some data + std::iota(data.begin(), data.end(), 0); + + // Create a ptxt. Note that in this tutorial we make use of the + // alternative ptxt API. + helib::Ptxt ptxt(CKKSContext, data); + + std::ofstream outPtxtFile; + outPtxtFile.open("ptxt.json", std::ios::out); + if (outPtxtFile.is_open()) { + // Write the ptxt to a file + ptxt.writeToJSON(outPtxtFile); + // Close the ofstream + outPtxtFile.close(); + } else { + throw std::runtime_error("Could not open file 'ptxt.json'."); + } + + std::ifstream inPtxtFile; + inPtxtFile.open("ptxt.json"); + if (inPtxtFile.is_open()) { + // Read in the ptxt from the file + helib::Ptxt deserializedPtxt = + helib::Ptxt::readFromJSON(inPtxtFile, CKKSContext); + // Note there are alternative methods for deserialization of Ptxt objects. + // After initialization + // helib::Ptxt deserializedPtxt(publicKey); + // One can write + // inPtxtFile >> deserializedPtxt; + // Or alternatively + // deserializedPtxt.readJSON(inPtxtFile); + + // Close the ifstream + inPtxtFile.close(); + } else { + throw std::runtime_error("Could not open file 'ptxt.json'."); + } + // Remove the context file. Comment out the line below if you would like to + // inspect the file. + std::remove("ptxt.json"); + + // Create a ctxt + helib::Ctxt ctxt(publicKey); + + // Encrypt `data` into the ciphertext + ea.getCx().encrypt(ctxt, publicKey, data); + + std::ofstream outCtxtFile; + outCtxtFile.open("ctxt.json", std::ios::out); + if (outCtxtFile.is_open()) { + // Write the ctxt to a file + ctxt.writeToJSON(outCtxtFile); + // Close the ofstream + outCtxtFile.close(); + } else { + throw std::runtime_error("Could not open file 'ctxt.json'."); + } + + std::ifstream inCtxtFile; + inCtxtFile.open("ctxt.json", std::ios::in); + if (inCtxtFile.is_open()) { + // Read in the ctxt from the file + helib::Ctxt deserializedCtxt = + helib::Ctxt::readFromJSON(inCtxtFile, publicKey); + // Note there are alternative methods for deserialization of Ctxt objects. + // After initialization + // helib::Ctxt deserializedCtxt(publicKey); + // One can write + // inCtxtFile >> deserializedCtxt; + // Or alternatively + // deserializedCtxt.readJSON(inCtxtFile); + + // Close the fstream + inCtxtFile.close(); + } else { + throw std::runtime_error("Could not open file 'ctxt.json'."); + } + // Remove the context file. Comment out the line below if you would like to + // inspect the file. + std::remove("ctxt.json"); + + return 0; +} diff --git a/examples/tutorial/CMakeLists.txt b/examples/tutorial/CMakeLists.txt new file mode 100644 index 000000000..a20db50bd --- /dev/null +++ b/examples/tutorial/CMakeLists.txt @@ -0,0 +1,26 @@ +# Copyright (C) 2019-2020 IBM Corp. +# This program is Licensed under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. See accompanying LICENSE file. + +add_executable(01_ckks_basics 01_ckks_basics.cpp) +add_executable(02_ckks_depth 02_ckks_depth.cpp) +add_executable(03_ckks_data_movement 03_ckks_data_movement.cpp) +add_executable(04_ckks_matmul 04_ckks_matmul.cpp) +add_executable(05_ckks_multlowlvl 05_ckks_multlowlvl.cpp) +add_executable(06_ckks_serialization 06_ckks_serialization.cpp) +add_executable(07_ckks_deserialization 07_ckks_deserialization.cpp) + +target_link_libraries(01_ckks_basics helib) +target_link_libraries(02_ckks_depth helib) +target_link_libraries(03_ckks_data_movement helib) +target_link_libraries(04_ckks_matmul helib) +target_link_libraries(05_ckks_multlowlvl helib) +target_link_libraries(06_ckks_serialization helib) +target_link_libraries(07_ckks_deserialization helib) diff --git a/include/helib/Context.h b/include/helib/Context.h index 2a0f462cf..c1a1a5898 100644 --- a/include/helib/Context.h +++ b/include/helib/Context.h @@ -24,6 +24,7 @@ #include #include #include +#include #include @@ -60,49 +61,10 @@ constexpr int BOOT_DFLT_SK_HWT = MIN_SK_HWT; * + sparse keys (weight=120): security ~ 2.4*X +19 * ``` */ - -inline double lweEstimateSecurity(int n, double log2AlphaInv, int hwt) -{ - if (hwt < 0 || (hwt > 0 && hwt < MIN_SK_HWT)) { - return 0; - } - - // clang-format off - constexpr double hwgts[] = - {120, 150, 180, 210, 240, 270, 300, 330, 360, 390, 420, 450}; - constexpr double slopes[] = - {2.4, 2.67, 2.83, 3.0, 3.1, 3.3, 3.3, 3.35, 3.4, 3.45, 3.5, 3.55}; - constexpr double cnstrms[] = - {19, 13, 10, 6, 3, 1, -3, -4, -5, -7, -10, -12}; - // clang-format on - - constexpr size_t numWghts = sizeof(hwgts) / sizeof(hwgts[0]); - - const size_t idx = (hwt - 120) / 30; // index into the array above - double slope = 0, consterm = 0; - if (hwt == 0) { // dense keys - slope = 3.8; - consterm = -20; - } else if (idx < numWghts - 1) { - // estimate prms on a line from prms[i] to prms[i+1] - // how far into this interval - double a = double(hwt - hwgts[idx]) / (hwgts[idx + 1] - hwgts[idx]); - slope = slopes[idx] + a * (slopes[idx + 1] - slopes[idx]); - consterm = cnstrms[idx] + a * (cnstrms[idx + 1] - cnstrms[idx]); - } else { - // Use the params corresponding to largest weight (450 above) - slope = slopes[numWghts - 1]; - consterm = cnstrms[numWghts - 1]; - } - - double x = n / log2AlphaInv; - double ret = slope * x + consterm; - - return ret < 0.0 ? 0.0 : ret; // If ret is negative then return 0.0 -} +double lweEstimateSecurity(int n, double log2AlphaInv, int hwt); /** - * @brief Returns smallest parameter m satisfying various constraints: + * @brief Returns smallest parameter m satisfying various constraints. * @param k security parameter * @param L number of levels * @param c number of columns in key switching matrices @@ -110,6 +72,7 @@ inline double lweEstimateSecurity(int n, double log2AlphaInv, int hwt) * @param d embedding degree (d ==0 or d==1 => no constraint) * @param s at least that many plaintext slots * @param chosen_m preselected value of m (0 => not preselected) + * @return the smallest `m` parameter satisfying the constraints. * Fails with an error message if no suitable m is found * prints an informative message if verbose == true **/ @@ -131,7 +94,7 @@ class ContextBuilder; /** * @class Context - * @brief Maintaining the parameters + * @brief Maintaining the HE scheme parameters **/ class Context { @@ -139,15 +102,107 @@ class Context template friend class ContextBuilder; - // Forward declarations of useful param structs for Context and - // ContextBuilder. + // Forward declarations of useful param structs + // for Context and ContextBuilder. struct ModChainParams; struct BootStrapParams; - std::vector moduli; // Cmodulus objects for the different primes - // This is private since the implementation assumes that the list of + // For serialization. + struct SerializableContent; + + // Cmodulus objects for the different primes + // The implementation assumes that the list of // primes only grows and no prime is ever modified or removed. + std::vector moduli; + + // A helper table to map required modulo-sizes to primeSets + ModuliSizes modSizes; + + // The structure of Zm*. + PAlgebra zMStar; + + // Parameters stored in alMod. + // These are NOT invariant: it is possible to work + // with View objects that use a different PAlgebra object. + + // The structure of Z[X]/(Phi_m(X),p^r). + PAlgebraMod alMod; + + // A default EncryptedArray. + std::shared_ptr ea; + // These parameters are currently set by buildPrimeChain + long hwt_param = 0; // Hamming weight of all keys associated with context + // 0 means "dense" + long e_param = 0; // parameters specific to bootstrapping + long ePrime_param = 0; + + std::shared_ptr pwfl_converter; + + // The structure of a single slot of the plaintext space. + // Note, this will be Z[X]/(G(x),p^r) for some irreducible factor G of + // Phi_m(X). + std::shared_ptr slotRing; + + // The `sqrt(variance)` of the LWE error (default=3.2). + NTL::xdouble stdev; + + double scale; // default = 10 + + // The "ciphertext primes" are the "normal" primes that are used to + // represent the public encryption key and ciphertexts. These are all + // "large" single=precision primes, or bit-size roughly NTL_SP_SIZE bits. + IndexSet ctxtPrimes; + + // A disjoint set of primes, used for key switching. See section 3.1.6 + // in the design document (key-switching). These too are "large" + // single=precision primes, or bit-size close to NTL_SP_SIZE bits. + IndexSet specialPrimes; + + // Yet a third set of primes, aimed at allowing modulus-switching with + // higher resolution. These are somewhat smaller single-precision + // primes, of size from NTL_SP_SIZE-20 to NTL_SP_SIZE-1. + IndexSet smallPrimes; + + // The set of primes for the digits. + // + // The different columns in any key-switching matrix contain encryptions + // of multiplies of the secret key, sk, B1*sk, B2*B1*sk, B3*B2*B1*sk,... + // with each Bi a product of a few "non-special" primes in the chain. The + // digits data member indicate which primes correspond to each of the Bi's. + // These are all IndexSet objects, whose union is the subset ctxtPrimes. + // + // The number of Bi's is one less than the number of columns in the key + // switching matrices (since the 1st column encrypts sk, without any Bi's), + // but we keep in the digits std::vector also an entry for the primes that do + // not participate in any Bi (so digits.size() is the same as the number + // of columns in the key switching matrices). + // See section 3.1.6 in the design document (key-switching). + // Digits of ctxt/columns of key-switching matrix + std::vector digits; + + // Bootstrapping-related data in the context includes both thin and thick + ThinRecryptData rcData; + + // Helper for serialisation. + static SerializableContent readParamsFrom(std::istream& str); + + // Helper for serialisation. + static SerializableContent readParamsFromJSON(const JsonWrapper& str); + + // Constructor for the `Context` object. + // m The index of the cyclotomic polynomial. + // p The plaintext modulus. + // r BGV: The Hensel lifting parameter. CKKS: The bit precision. + // gens The generators of `(Z/mZ)^*` (other than `p`). + // ords The orders of each of the generators of `(Z/mZ)^*`. + Context(unsigned long m, + unsigned long p, + unsigned long r, + const std::vector& gens = std::vector(), + const std::vector& ords = std::vector()); + + // Used by ContextBuilder Context(long m, long p, long r, @@ -156,9 +211,39 @@ class Context const std::optional& mparams, const std::optional& bparams); + // Used for serialisation + Context(const SerializableContent& content); + + // Methods for adding primes. + void addSpecialPrimes(long nDgts, + bool willBeBootstrappable, + long bitsInSpecialPrimes); + + void addCtxtPrimes(long nBits, long targetSize); + + void addSmallPrimes(long resolution, long cpSize); + + // Add the given prime to the `smallPrimes` set. + // q The prime to add. + void addSmallPrime(long q); + + // Add the given prime to the `ctxtPrimes` set. + // q The prime to add. + void addCtxtPrime(long q); + + // Add the given prime to the `specialPrimes` set. + // q The prime to add. + void addSpecialPrime(long q); + public: - // Parameters stored in zMStar. - // These are invariant for any computations involving this Context + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "Context"; + + // NOTE: Parameters stored in zMStar are invariant for any computations + // involving this Context. /** * @brief Getter method for the `m` used to create this `context`. @@ -191,9 +276,17 @@ class Context **/ long getNSlots() const { return zMStar.getNSlots(); } - // Parameters stored in alMod. - // These are NOT invariant: it is possible to work - // with View objects that use a different PAlgebra object. + /** + * @brief Getter method for the scale. + * @return the scale as a `double`. + **/ + double getScale() const { return scale; } + + /** + * @brief Getter method for the standard deviation used.. + * @return the standard deviation as an `NTL::xdouble`. + **/ + NTL::xdouble getStdev() const { return stdev; } /** * @brief Getter method for the default `r` value of the created `context`. @@ -202,7 +295,7 @@ class Context * @note This value is not invariant: it is possible to work "view" objects * that use different `PAlgebra` objects. **/ - long getDefaultR() const { return alMod.getR(); } + long getR() const { return alMod.getR(); } /** * @brief Getter method for the default `p^r` value of the created `context`. @@ -210,86 +303,162 @@ class Context * @note This value is not invariant: it is possible to work "view" objects * that use different `PAlgebra` objects. **/ - long getDefaultPPowR() const { return alMod.getPPowR(); } + long getPPowR() const { return alMod.getPPowR(); } - // synonymn for getDefaultR(). + // synonymn for getR(). // this is used in various corner cases in CKKS where // we really need some default precisiion parameter. // It is also possible to define this differently // in the future. /** - * @brief Getter method for the default `precision` value of the created + * @brief Getter method for the `precision` value of the created * `CKKS` `context`. * @return The bit `precision` value. * @note This value is not invariant: it is possible to work "view" objects * that use different `PAlgebra` objects. **/ - long getDefaultPrecision() const { return alMod.getR(); } + long getPrecision() const { return alMod.getR(); } + + /** + * @brief Get a powerful converter. + * @return A powerful converter. + **/ + const PowerfulDCRT& getPowerfulConverter() const { return *pwfl_converter; } + + /** + * @brief Get a slot ring. + * @return A reference to a `std::shared` pointer pointing to a slotRing. + **/ + const std::shared_ptr& getSlotRing() const { return slotRing; }; + + /** + * @brief Getter method to the index set to the small primes. + * @return A `const` reference to the index set to the small primes. + **/ + const IndexSet& getSmallPrimes() const { return smallPrimes; } + + /** + * @brief Getter method to the index set to the ciphertext primes. + * @return A `const` reference to the index set to the ciphertext primes. + **/ + const IndexSet& getCtxtPrimes() const { return ctxtPrimes; } + + /** + * @brief Getter method to the index set to the special primes. + * @return A `const` reference to the index set to the special primes. + **/ + const IndexSet& getSpecialPrimes() const { return specialPrimes; } + /** + * @brief Getter method to the digits. + * @return A `const` reference to a `std::vector` of index sets that + * represent the digits. + **/ + const std::vector& getDigits() const { return digits; } + + /** + * @brief Getter method to get a single digit. + * @param i The `i` the digit. + * @return A `const` reference to an index set that representing the `i`th + * digit. + **/ + const IndexSet& getDigit(long i) const { return digits[i]; } + + /** + * @brief Getter method for a recryption data object. + * @return A `const` reference to the recryption data object. + **/ + const ThinRecryptData& getRcData() const { return rcData; } + + /** + * @brief Return whether this is a CKKS context or not `Context`. + * @return A `bool`, `true` if the `Context` object uses CKKS scheme false + * otherwise. + * @note We assume `false` return to be BGV scheme. + **/ bool isCKKS() const { return alMod.getTag() == PA_cx_tag; } - //============================================================ + /** + * @brief Getter method for the Hamming weight value. + * @return The Hamming weight value. + **/ + long getHwt() const { return hwt_param; } - //! @brief The structure of Zm*. - PAlgebra zMStar; + /** + * @brief Getter method for the e parameter. + * @return The e parameter. + **/ + long getE() const { return e_param; } - //! @brief The structure of Z[X]/(Phi_m(X),p^r). - PAlgebraMod alMod; + /** + * @brief Getter method for the e prime parameter. + * @return The e prime parameter. + **/ + long getEPrime() const { return ePrime_param; } - //! @brief A default EncryptedArray. - // VJS-FIXME: should this really be public? - std::shared_ptr ea; + /** + * @brief Get the underlying `zMStar` object. + * @return A `zMStar` object. + **/ + const PAlgebra& getZMStar() const { return zMStar; }; + + /** + * @brief Get the underlying `AlMod` object. + * @return A `AlMod` object. + **/ + const PAlgebraMod& getAlMod() const { return alMod; }; /** * @brief Getter method returning the default `view` object of the created * `context`. * @return A reference to the `view` object. **/ - const EncryptedArray& getDefaultView() const { return *ea; } // preferred name - // FIXME: This is deprecated and superseded by the above. - const EncryptedArray& getDefaultEA() const { return *ea; } // legacy name - - std::shared_ptr pwfl_converter; + const EncryptedArray& getView() const { return *ea; } // preferred name /** - * @brief The structure of a single slot of the plaintext space. - * @note This will be Z[X]/(G(x),p^r) for some irreducible factor G of - * Phi_m(X). + * @brief Getter method returning the default `EncryptedArray` object of the + *created `context`. + * @return A reference to the `EncryptedArray` object. + * @note It is foreseen that this method will be eventually deprecated in + * favour of the alternative `getView`. **/ - std::shared_ptr slotRing; + const EncryptedArray& getEA() const { return *ea; } - //! @brief The `sqrt(variance)` of the LWE error (default=3.2). - NTL::xdouble stdev; + /** + * @brief Getter method returning the `std::shared_ptr` to default + * `EncryptedArray` object of the created `context`. + * @return A reference to `std::shared_ptr` to the `EncryptedArray` object. + **/ + const std::shared_ptr& shareEA() const { return ea; } //======================= high probability bounds ================ - double scale; // default = 10 - //! erfc(scale/sqrt(2)) * phi(m) should be less than some negligible - //! parameter epsilon. - //! The default value of 10 should be good enough for most applications. - //! NOTE: -log(erfc(8/sqrt(2)))/log(2) = 49.5 - //! -log(erfc(10/sqrt(2)))/log(2) = 75.8 - //! -log(erfc(11/sqrt(2)))/log(2) = 91.1 - //! -log(erfc(12/sqrt(2)))/log(2) =107.8 - - //! The way this is used is as follows. If we have a normal random - //! variable X with variance sigma^2, then the probability that - //! that X lies outside the interval [-scale*sigma, scale*sigma] is - //! delta=erfc(scale/sqrt(2)). We will usually apply the union bound - //! to a vector of phi(m) such random variables (one for each primitive - //! m-th root of unity), so that the probability that that the L-infty - //! norm exceeds scale*sigma is at most epsilon=phim*delta. Thus, - //! scale*sigma will be used as a high-probability bound on the - //! L-infty norm of such vectors. + // erfc(scale/sqrt(2)) * phi(m) should be less than some negligible + // parameter epsilon. + // The default value of 10 should be good enough for most applications. + // NOTE: -log(erfc(8/sqrt(2)))/log(2) = 49.5 + // -log(erfc(10/sqrt(2)))/log(2) = 75.8 + // -log(erfc(11/sqrt(2)))/log(2) = 91.1 + // -log(erfc(12/sqrt(2)))/log(2) =107.8 + + // The way this is used is as follows. If we have a normal random + // variable X with variance sigma^2, then the probability that + // that X lies outside the interval [-scale*sigma, scale*sigma] is + // delta=erfc(scale/sqrt(2)). We will usually apply the union bound + // to a vector of phi(m) such random variables (one for each primitive + // m-th root of unity), so that the probability that that the L-infty + // norm exceeds scale*sigma is at most epsilon=phim*delta. Thus, + // scale*sigma will be used as a high-probability bound on the + // L-infty norm of such vectors. //======================================= - //! Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen so - //! that each f_i is chosen uniformly and independently from the - //! interval [-magBound, magBound], and that k = degBound. - //! This returns a bound B such that the L-infty norm - //! of the canonical embedding exceeds B with probability at most - //! epsilon. + // Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen so + // that each f_i is chosen uniformly and independently from the + // interval [-magBound, magBound], and that k = degBound. + // This returns a bound B such that the L-infty norm + // of the canonical embedding exceeds B with probability at most + // epsilon. // NOTE: this is a bit heuristic: we assume that if we evaluate // f at a primitive root of unity, then we get something that well @@ -299,24 +468,28 @@ class Context // We then multiply the sqrt of the variance by scale to get // the high probability bound. + /** + * + **/ double noiseBoundForUniform(double magBound, long degBound) const { return scale * std::sqrt(double(degBound) / 3.0) * magBound; } + /** + * + **/ NTL::xdouble noiseBoundForUniform(NTL::xdouble magBound, long degBound) const { return scale * std::sqrt(double(degBound) / 3.0) * magBound; } - //======================================= - - //! Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen so - //! that each f_i is chosen uniformly and independently from the - //! from the set of balanced residues modulo the given modulus. - //! This returns a bound B such that the L-infty norm - //! of the canonical embedding exceeds B with probability at most - //! epsilon. + // Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen so + // that each f_i is chosen uniformly and independently from the + // from the set of balanced residues modulo the given modulus. + // This returns a bound B such that the L-infty norm + // of the canonical embedding exceeds B with probability at most + // epsilon. // NOTE: for odd modulus, this means each f_i is uniformly distributed // over { -floor(modulus/2), ..., floor(modulus/2) }. @@ -337,6 +510,9 @@ class Context // NOTE: this is slightly more accurate that just calling // noiseBoundForUniform with magBound=modulus/2. + /** + * + **/ double noiseBoundForMod(long modulus, long degBound) const { double var = fsquare(modulus) / 12.0; @@ -346,38 +522,40 @@ class Context return scale * std::sqrt(degBound * var); } - //======================================= - - //! Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen - //! so that each f_i is chosen uniformly and independently from - //! N(0, sigma^2), and that k = degBound. - //! This returns a bound B such that the L-infty norm - //! of the canonical embedding exceeds B with probability at most - //! epsilon. + // Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen + // so that each f_i is chosen uniformly and independently from + // N(0, sigma^2), and that k = degBound. + // This returns a bound B such that the L-infty norm + // of the canonical embedding exceeds B with probability at most + // epsilon. // NOTE: if we evaluate f at a primitive root of unity, // then we get a normal random variable variance degBound * sigma^2. // We then multiply the sqrt of the variance by scale to get // the high probability bound. + /** + * + **/ double noiseBoundForGaussian(double sigma, long degBound) const { return scale * std::sqrt(double(degBound)) * sigma; } + /** + * + **/ NTL::xdouble noiseBoundForGaussian(NTL::xdouble sigma, long degBound) const { return scale * std::sqrt(double(degBound)) * sigma; } - //======================================= - - //! Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen - //! so that each f_i is zero with probability 1-prob, 1 with probability - //! prob/2, and -1 with probability prob/2. - //! This returns a bound B such that the L-infty norm - //! of the canonical embedding exceeds B with probability at most - //! epsilon. + // Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen + // so that each f_i is zero with probability 1-prob, 1 with probability + // prob/2, and -1 with probability prob/2. + // This returns a bound B such that the L-infty norm + // of the canonical embedding exceeds B with probability at most + // epsilon. // NOTE: this is a bit heuristic: we assume that if we evaluate // f at a primitive root of unity, then we get something that @@ -387,18 +565,19 @@ class Context // We then multiply the sqrt of the variance by scale to get // the high probability bound. + /** + * + **/ double noiseBoundForSmall(double prob, long degBound) const { return scale * std::sqrt(double(degBound)) * std::sqrt(prob); } - //======================================= - - //! Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen - //! hwt coefficients are chosen to \pm 1, and the remainder zero. - //! This returns a bound B such that the L-infty norm - //! of the canonical embedding exceeds B with probability at most - //! epsilon. + // Assume the polynomial f(x) = sum_{i < k} f_i x^i is chosen + // hwt coefficients are chosen to \pm 1, and the remainder zero. + // This returns a bound B such that the L-infty norm + // of the canonical embedding exceeds B with probability at most + // epsilon. // NOTE: this is a bit heuristic: we assume that if we evaluate // f at a primitive root of unity, then we get something that @@ -410,31 +589,35 @@ class Context // NOTE: degBound is not used here, but I include it // for consistency with the other noiseBound routines + /** + * + **/ double noiseBoundForHWt(long hwt, UNUSED long degBound) const { return scale * std::sqrt(double(hwt)); } - //======================================= - - //! This computes a high probability bound on the L-infty norm - //! of x0+s*x1 in the pwrfl basis, assuming is chosen with coeffs - //! in the pwrfl basis uniformly and independently dist'd over [-1/2,1/2], - //! x0 has arbitrary coeffs over [-1/2,1/2] in the pwrfl basis, - //! and assuming s is chosen with skHwt nonzero coeffs mod X^m-1 - //! in the power basis (uniformly and independently over {-1,1}). - //! The bound should be satisfied with probability epsilon. - - //! NOTE: this is a bit heuristic. See design document for details. + // This computes a high probability bound on the L-infty norm + // of x0+s*x1 in the pwrfl basis, assuming is chosen with coeffs + // in the pwrfl basis uniformly and independently dist'd over [-1/2,1/2], + // x0 has arbitrary coeffs over [-1/2,1/2] in the pwrfl basis, + // and assuming s is chosen with skHwt nonzero coeffs mod X^m-1 + // in the power basis (uniformly and independently over {-1,1}). + // The bound should be satisfied with probability epsilon. - //! NOTE: this is still valid even when m is a power of 2 + // NOTE: this is a bit heuristic. See design document for details. + // NOTE: this is still valid even when m is a power of 2 + /** + * @brief Calculate the standard deviation for recryption. + * @return The standard deviation for recryption. + **/ double stdDevForRecryption() const { long skHwt = hwt_param; - long k = zMStar.getNFactors(); // number of prime factors of m + long k = zMStar.getNFactors(); long m = zMStar.getM(); long phim = zMStar.getPhiM(); @@ -444,89 +627,35 @@ class Context return std::sqrt(mrat * double(skHwt) * double(1L << k) / 3.0) * 0.5; } + /** + * @brief Calculate the bound for recryption. + * @return The bound for recryption. + **/ double boundForRecryption() const { - double c_m = zMStar.get_cM(); - // multiply by this fudge factor - // VJS-FIXME: this fudge factor has to go - - return 0.5 + c_m * scale * stdDevForRecryption(); + return 0.5 + scale * stdDevForRecryption(); } /** - * The "ciphertext primes" are the "normal" primes that are used to - * represent the public encryption key and ciphertexts. These are all - * "large" single=precision primes, or bit-size roughly NTL_SP_SIZE bits. + * @brief Get the helper table to map required modulo-sizes to primeSets. + * @return The table as `ModuliSizes` type. **/ - IndexSet ctxtPrimes; - - //! A disjoint set of primes, used for key switching. See section 3.1.6 - //! in the design document (key-switching). These too are "large" - //! single=precision primes, or bit-size close to NTL_SP_SIZE bits. - IndexSet specialPrimes; - - //! Yet a third set of primes, aimed at allowing modulus-switching with - //! higher resolution. These are somewhat smaller single-precision - //! primes, of size from NTL_SP_SIZE-20 to NTL_SP_SIZE-1. - IndexSet smallPrimes; - - //! A helper table to map required modulo-sizes to primeSets - ModuliSizes modSizes; - void setModSizeTable() { modSizes.init(*this); } + const ModuliSizes& getModSizeTable() const { return modSizes; } /** - * @brief The set of primes for the digits. - * - * The different columns in any key-switching matrix contain encryptions - * of multiplies of the secret key, sk, B1*sk, B2*B1*sk, B3*B2*B1*sk,... - * with each Bi a product of a few "non-special" primes in the chain. The - * digits data member indicate which primes correspond to each of the Bi's. - * These are all IndexSet objects, whose union is the subset ctxtPrimes. - * - * The number of Bi's is one less than the number of columns in the key - * switching matrices (since the 1st column encrypts sk, without any Bi's), - * but we keep in the digits std::vector also an entry for the primes that do - * not participate in any Bi (so digits.size() is the same as the number - * of columns in the key switching matrices). - * See section 3.1.6 in the design document (key-switching). + * @brief Set the helper table to map required modulo-sizes to primeSets. **/ - // Digits of ctxt/columns of key-switching matrix - std::vector digits; - - //! Bootstrapping-related data in the context - // includes both thin and thick - ThinRecryptData rcData; - - //======================================= - - // These parameters are currently set by buildPrimeChain - - long hwt_param = 0; // Hamming weight of all keys associated with context - // 0 means "dense" - - long e_param = 0; // parameters specific to bootstrapping - long ePrime_param = 0; + void setModSizeTable() { modSizes.init(*this); } - /******************************************************************/ - // constructor /** - * @brief Constructor for the `Context` object. - * @param m The index of the cyclotomic polynomial. - * @param p The plaintext modulus. - * @param r BGV: The Hensel lifting parameter. CKKS: The bit precision. - * @param gens The generators of `(Z/mZ)^*` (other than `p`). - * @param ords The orders of each of the generators of `(Z/mZ)^*`. + * @brief Default destructor. **/ - Context(unsigned long m, - unsigned long p, - unsigned long r, - const std::vector& gens = std::vector(), - const std::vector& ords = std::vector()); + ~Context() = default; /** - * @brief Default destructor. + * @brief Deleted default constructor. **/ - ~Context() = default; + Context() = delete; /** * @brief Deleted copy constructor. @@ -609,7 +738,7 @@ class Context return IndexSet(first, last); } - // FIXME: replacement for bitsPerLevel...placeholder for now + // FIXME: replacement for bitsPerLevel placeholder for now long BPL() const { return 30; } /** @@ -680,7 +809,6 @@ class Context return false; } - ///@{ /** * @brief Calculate the product of all primes in the given set. * @param p The product of the input primes. @@ -693,7 +821,6 @@ class Context productOfPrimes(p, s); return p; } - ///@} // FIXME: run-time error when ithPrime(i) returns 0 /** @@ -766,68 +893,6 @@ class Context **/ void printout(std::ostream& out = std::cout) const; - /** - * @brief Add the given prime to the `smallPrimes` set. - * @param q The prime to add. - **/ - void AddSmallPrime(long q); - - /** - * @brief Add the given prime to the `ctxtPrimes` set. - * @param q The prime to add. - **/ - void AddCtxtPrime(long q); - - /** - * @brief Add the given prime to the `specialPrimes` set. - * @param q The prime to add. - **/ - void AddSpecialPrime(long q); - - ///@{ - /** - @name I/O routines - - To write out all the data associated with a context, do the following: - - \code - writeContextBase(str, context); - str << context; - \endcode - - The first function call writes out just [m p r gens ords], which is the - data needed to invoke the context constructor. - - The second call writes out all other information, including the - stdev field, the prime sequence (including which primes are "special"), - and the digits info. - - To read in all the data associated with a context, do the following: - - \code - unsigned long m, p, r; - std::vector gens, ords; - - readContextBase(str, m, p, r, gens, ords); - - Context context(m, p, r, gens, ords); - - str >> context; - \endcode - - The call to readContextBase just reads the values m, p, r and the set - of generators in Zm* /(p) and their order. Then, after constructing the - context, the >> operator reads in and attaches all other information. - **/ - - /** - * @brief Write out the basic information `m`, `p` and `r` of the given - * `Context` object. - * @param str Output `std::ostream`. - * @param context The `Context` to write. - **/ - friend void writeContextBase(std::ostream& str, const Context& context); - /** * @brief Write out all other data associated with a given `Context` object. * @param str Output `std::ostream`. @@ -864,12 +929,66 @@ class Context friend std::istream& operator>>(std::istream& str, Context& context); ///@} - friend void writeContextBinary(std::ostream& str, const Context& context); - friend void readContextBinary(std::istream& str, Context& context); + /** + * @brief Write out the `Context` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `Context` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `Context` object. + **/ + static Context readFrom(std::istream& str); - // internal function to undo buldModChain...used for parameter - // generation programs + /** + * @brief Read from the stream the serialized `Context` object in binary + * format. + * @param str Input `std::istream`. + * @return Raw pointer to the deserialized `Context` object. + **/ + static Context* readPtrFrom(std::istream& str); + /** + * @brief Write out the `Context` object to the output stream using JSON + * format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the `Context` object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized `Context` object using JSON + * format. + * @param str Input `std::istream`. + * @return The deserialized `Context` object. + **/ + static Context readFromJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized `Context` object. + * @param j The `JsonWrapper` containing the serialized `Context` object. + * @return The deserialized `Context` object. + **/ + static Context readFromJSON(const JsonWrapper& j); + + /** + * @brief Read from the `JsonWrapper` the serialized `Context` object. + * @param j The `JsonWrapper` containing the serialized `Context` object. + * @return Raw pointer to the deserialized `Context` object. + **/ + static Context* readPtrFromJSON(std::istream& str); + + // Internal function to undo buldModChain. + // Used for parameter generation programs. + // FIXME Should this not be private? void clearModChain() { moduli.clear(); @@ -882,61 +1001,32 @@ class Context e_param = 0; ePrime_param = 0; } -}; -//! @brief write [m p r gens ords] data -void writeContextBase(std::ostream& s, const Context& context); -//! @brief read [m p r gens ords] data, needed to construct context -void readContextBase(std::istream& s, - unsigned long& m, - unsigned long& p, - unsigned long& r, - std::vector& gens, - std::vector& ords); -std::unique_ptr buildContextFromAscii(std::istream& str); - -//! @brief write [m p r gens ords] data -void writeContextBaseBinary(std::ostream& str, const Context& context); -void writeContextBinary(std::ostream& str, const Context& context); - -//! @brief read [m p r gens ords] data, needed to construct context -void readContextBaseBinary(std::istream& s, - unsigned long& m, - unsigned long& p, - unsigned long& r, - std::vector& gens, - std::vector& ords); - -std::unique_ptr buildContextFromBinary(std::istream& str); -void readContextBinary(std::istream& str, Context& context); - -// Build modulus chain with nBits worth of ctxt primes, -// using nDgts digits in key-switching. + /** + * @brief Build the modulus chain for given `Context` object. + * @param nBits Total number of bits required for the modulus chain. + * @param nDgts Number of digits/columns in the key-switching matrix. Default + * is 3. + * @param willBeBoostrappable Flag for initializing bootstrapping data. + *Default is `false`. + * @param skHwt The Hamming weight of the secret key. Default is 0. + * @param resolution The bit size of resolution of the modulus chain. Default + * is 3. + * @param bitsInSpecialPrimes The bit size of the special primes in the + *modulus chain. Default is 0. + **/ + void buildModChain(long nBits, + long nDgts = 3, + bool willBeBootstrappable = false, + long skHwt = 0, + long resolution = 3, + long bitsInSpecialPrimes = 0); -/** - * @brief Build the modulus chain for given `Context` object. - * @param nBits Total number of bits required for the modulus chain. - * @param nDgts Number of digits/columns in the key-switching matrix. Default - * is 3. - * @param willBeBoostrappable Flag for initializing bootstrapping data. Default - * is `false`. - * @param skHwt The Hamming weight of the secret key. Default is 0. - * @param resolution The bit size of resolution of the modulus chain. Default - * is 3. - * @param bitsInSpecialPrimes The bit size of the special primes in the modulus - * chain. Default is 0. - **/ -void buildModChain(Context& context, - long nBits, - long nDgts = 3, - bool willBeBootstrappable = false, - long skHwt = 0, - long resolution = 3, - long bitsInSpecialPrimes = 0); - -// should be called if after you build the mod chain in some way -// *other* than calling buildModChain. -void endBuildModChain(Context& context); + // should be called if after you build the mod chain in some way + // *other* than calling buildModChain. + void endBuildModChain(); + +}; // End of class Context /** * @brief `ostream` operator for serializing the `ContextBuilder` object. @@ -967,7 +1057,7 @@ class ContextBuilder std::optional> makeParamsArgs() const; - // Default values by scheme. + // Default values by scheme struct default_values; // General parameters @@ -986,6 +1076,9 @@ class ContextBuilder long bitsInSpecialPrimes_ = 0; bool buildModChainFlag_ = true; // Default build the modchain. + double stdev_ = 3.2; + double scale_ = 10; + // Boostrap params (BGV only) NTL::Vec mvec_; bool buildCacheFlag_ = false; @@ -993,6 +1086,12 @@ class ContextBuilder bool bootstrappableFlag_ = false; // Default not boostrappable. public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "ContextBuilder"; + /** * @brief Sets `m` the order of the cyclotomic polynomial. * @param m The order of the cyclotomic polynomial. @@ -1046,6 +1145,28 @@ class ContextBuilder return *this; } + /** + * @brief Sets `scale` the scale parameter. + * @param scale The bit scale parameter. + * @return Reference to the `ContextBuilder` object. + **/ + ContextBuilder& scale(double scale) + { + scale_ = scale; + return *this; + } + + /** + * @brief Sets `stdev` the standard deviation parameter. + * @param stdev The standard deviation parameter. + * @return Reference to the `ContextBuilder` object. + **/ + ContextBuilder& stdev(double stdev) + { + stdev_ = stdev; + return *this; + } + /** * @brief Sets `c` the number of columns (a.k.a. digits) in the key switching * matrices. @@ -1222,7 +1343,7 @@ class ContextBuilder **/ template ::value>* = nullptr> - ContextBuilder& bootstrappable(bool yesno) + ContextBuilder& bootstrappable(bool yesno = true) { bootstrappableFlag_ = yesno; return *this; @@ -1244,7 +1365,7 @@ class ContextBuilder friend std::ostream& operator<<(std::ostream& os, const ContextBuilder& cb); -}; +}; // End of class ContextBuilder // Default BGV values template <> @@ -1264,7 +1385,6 @@ struct ContextBuilder::default_values static constexpr long r = 20; }; -///@} // Should point to the "current" context extern Context* activeContext; diff --git a/include/helib/Ctxt.h b/include/helib/Ctxt.h index f6ed712bd..a06de376d 100644 --- a/include/helib/Ctxt.h +++ b/include/helib/Ctxt.h @@ -186,14 +186,70 @@ class SKHandle friend std::istream& operator>>(std::istream& s, SKHandle& handle); // Raw IO - void read(std::istream& str); - void write(std::ostream& str) const; + + /** + * @brief Write out the `SKHandle` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `SKHandle` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `SKHandle` object. + **/ + static SKHandle readFrom(std::istream& str); + + /** + * @brief Write out the secret key handle (`SKHandle`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the secret key handle (`SKHandle`) object to a + * `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized secret key handle (`SKHandle`) + * object using JSON format. + * @param str Input `std::istream`. + * @return The deserialized `SKHandle` object. + **/ + static SKHandle readFromJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized secret key handle + * (`SKHandle`) object. + * @param j The `JsonWrapper` containing the serialized `SKHandle` object. + * @return The deserialized `SKHandle` object. + **/ + static SKHandle readFromJSON(const JsonWrapper& j); + + /** + * @brief Read from the stream the serialized secret key handle (`SKHandle`) + * object using JSON format. + * @param str Input `std::istream`. + **/ + void readJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized secret key handle + * (`SKHandle`) object. + * @param j The `JsonWrapper` containing the serialized `SKHandle` object. + **/ + void readJSON(const JsonWrapper& j); }; inline std::ostream& operator<<(std::ostream& s, const SKHandle& handle) { - return s << "[" << handle.getPowerOfS() << " " << handle.getPowerOfX() << " " - << handle.getSecretKeyID() << "]"; + handle.writeToJSON(s); + return s; } /** @@ -235,8 +291,72 @@ class CtxtPart : public DoubleCRT DoubleCRT(other), skHandle(otherHandle) {} + /** + * @brief Write out the `CtxtPart` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `CtxtPart` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `CtxtPart` object. + **/ + static CtxtPart readFrom(std::istream& str, const Context& context); + + /** + * @brief In-place read from the stream the serialized `CtxtPart` object in + * binary format. + * @param str Input `std::istream`. + **/ void read(std::istream& str); - void write(std::ostream& str) const; + + /** + * @brief Write out the ciphertext part (`CtxtPart`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the ciphertext part (`CtxtPart`) object to a + * `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized ciphertext part (`CtxtPart`) + * object using JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + * @return The deserialized `CtxtPart` object. + **/ + static CtxtPart readFromJSON(std::istream& str, const Context& context); + + /** + * @brief Read from the `JsonWrapper` the serialized ciphertext part + *(`CtxtPart`) object. + * @param j The `JsonWrapper` containing the serialized `CtxtPart` object. + * @param context The `Context` to be used. + * @return The deserialized `CtxtPart` object. + **/ + static CtxtPart readFromJSON(const JsonWrapper& j, const Context& context); + + /** + * @brief Read from the stream the serialized ciphertext part (`CtxtPart`) + * object using JSON format. + * @param str Input `std::istream`. + **/ + void readJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized ciphertext part + *(`CtxtPart`) object. + * @param j The `JsonWrapper` containing the serialized `SKHandle` object. + **/ + void readJSON(const JsonWrapper& j); }; std::istream& operator>>(std::istream& s, CtxtPart& p); @@ -381,6 +501,12 @@ class Ctxt void mulIntFactor(long e); public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "Ctxt"; + // Default copy-constructor Ctxt(const Ctxt& other) = default; @@ -528,7 +654,7 @@ class Ctxt void addConstantCKKS(double x) { // FIXME: not enough precision when x is large addConstantCKKS( - rationalApprox(x, /*denomBound=*/1 << getContext().alMod.getR())); + rationalApprox(x, /*denomBound=*/1 << getContext().getAlMod().getR())); } // [[deprecated]] @@ -1031,7 +1157,7 @@ class Ctxt //! the side-effect of increasing the plaintext space to p^{r+e}. void multByP(long e = 1) { - long p2e = NTL::power_long(context.zMStar.getP(), e); + long p2e = NTL::power_long(context.getP(), e); ptxtSpace *= p2e; multByConstant(NTL::to_ZZ(p2e)); } @@ -1163,7 +1289,7 @@ class Ctxt void clear() { // set as an empty ciphertext parts.clear(); - primeSet = context.ctxtPrimes; + primeSet = context.getCtxtPrimes(); noiseBound = 0.0; intFactor = 1; ratFactor = ptxtMag = 1.0; @@ -1202,7 +1328,7 @@ class Ctxt // Return r such that p^r = ptxtSpace long effectiveR() const { - long p = context.zMStar.getP(); + long p = context.getP(); for (long r = 1, p2r = p; r < NTL_SP_NBITS; r++, p2r *= p) { if (p2r == ptxtSpace) return r; @@ -1228,9 +1354,72 @@ class Ctxt friend std::ostream& operator<<(std::ostream& str, const Ctxt& ctxt); // Raw IO - void write(std::ostream& str) const; + + /** + * @brief Write out the `Ctxt` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `Ctxt` object in binary format. + * @param str Input `std::istream`. + * @return The deserialized `Ctxt` object. + **/ + static Ctxt readFrom(std::istream& str, const PubKey& pubKey); + + /** + * @brief In-place read from the stream the serialized `Ctxt` object in binary + * format. + * @param str Input `std::istream`. + **/ void read(std::istream& str); + /** + * @brief Write out the ciphertext (`Ctxt`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the ciphertext (`Ctxt`) object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized ciphertext (`Ctxt`) object using + * JSON format. + * @param str Input `std::istream`. + * @param pubKey The `PubKey` to be used. + * @return The deserialized `Ctxt` object. + **/ + static Ctxt readFromJSON(std::istream& str, const PubKey& pubKey); + + /** + * @brief Read from the `JsonWrapper` the serialized ciphertext (`Ctxt`) + * object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + * @param pubKey The `PubKey` to be used. + * @return The deserialized `Ctxt` object. + **/ + static Ctxt readFromJSON(const JsonWrapper& j, const PubKey& pubKey); + + /** + * @brief In-place read from the `str` `std::istream` the serialized + * ciphertext (`Ctxt`) object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + **/ + void readJSON(std::istream& str); + + /** + * @brief In-place read from the `JsonWrapper` the serialized ciphertext + * (`Ctxt`) object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + **/ + void readJSON(const JsonWrapper& j); + // scale up c1, c2 so they have the same ratFactor static void equalizeRationalFactors(Ctxt& c1, Ctxt& c2); diff --git a/include/helib/DoubleCRT.h b/include/helib/DoubleCRT.h index f3db2d208..e0a4df2a0 100644 --- a/include/helib/DoubleCRT.h +++ b/include/helib/DoubleCRT.h @@ -415,8 +415,72 @@ class DoubleCRT void reduce() const {} // place-holder for consistent with AltCRT // Raw I/O + + /** + * @brief Write out the `DoubleCRT` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `DoubleCRT` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `DoubleCRT` object. + **/ + static DoubleCRT readFrom(std::istream& str, const Context& context); + + /** + * @brief In-place read from the stream the serialized `DoubleCRT` object in + * binary format. + * @param str Input `std::istream`. + **/ void read(std::istream& str); - void write(std::ostream& str) const; + + /** + * @brief Write out the ciphertext (`Ctxt`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the ciphertext (`Ctxt`) object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized ciphertext (`Ctxt`) object using + * JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + * @return The deserialized `Ctxt` object. + **/ + static DoubleCRT readFromJSON(std::istream& str, const Context& context); + + /** + * @brief Read from the `JsonWrapper` the serialized ciphertext (`Ctxt`) + * object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + * @param context The `Context` to be used. + * @return The deserialized `Ctxt` object. + **/ + static DoubleCRT readFromJSON(const JsonWrapper& j, const Context& context); + + /** + * @brief In-place read from the `str` `std::istream` the serialized + * ciphertext (`Ctxt`) object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + **/ + void readJSON(std::istream& str); + + /** + * @brief In-place read from the `JsonWrapper` the serialized ciphertext + * (`Ctxt`) object. + * @param j The `JsonWrapper` containing the serialized `Ctxt` object. + **/ + void readJSON(const JsonWrapper& j); // I/O: ONLY the matrix is outputted/recovered, not the moduli chain!! An // error is raised on input if this is not consistent with the current chain diff --git a/include/helib/EncodedPtxt.h b/include/helib/EncodedPtxt.h index e4f2b1a26..b902346ba 100644 --- a/include/helib/EncodedPtxt.h +++ b/include/helib/EncodedPtxt.h @@ -199,7 +199,8 @@ class FatEncodedPtxt_BGV FatEncodedPtxt_BGV(const EncodedPtxt_BGV& eptxt, const IndexSet& s) : dcrt(eptxt.getPoly(), eptxt.getContext(), s), ptxtSpace(eptxt.getPtxtSpace()), - size(embeddingLargestCoeff(eptxt.getPoly(), eptxt.getContext().zMStar)) + size(embeddingLargestCoeff(eptxt.getPoly(), + eptxt.getContext().getZMStar())) {} FatEncodedPtxt_BGV(const DoubleCRT& dcrt_, long ptxtSpace_, double size_) : diff --git a/include/helib/EncryptedArray.h b/include/helib/EncryptedArray.h index cb4a16241..9f76e45d4 100644 --- a/include/helib/EncryptedArray.h +++ b/include/helib/EncryptedArray.h @@ -176,7 +176,7 @@ class EncryptedArrayBase // CKKS only // mag: defaults to Norm(array). // prec: defaults to r=getAlMod().getR(), which - // is usually the same as context.getDefaultPrecision(). + // is usually the same as context.getPrecision(). // mag should be an upper bound on Norm(array). // If an encoding will be encrypted, the user may wish @@ -896,7 +896,7 @@ class EncryptedArrayDerived : public EncryptedArrayBase double encodei(zzX& ptxt, long precision = -1) const; // encode i in all slots explicit EncryptedArrayDerived(const Context& _context) : - context(_context), alMod(context.alMod.getCx()) + context(_context), alMod(context.getAlMod().getCx()) { clear(iEncoded); } @@ -1275,7 +1275,7 @@ class EncryptedArrayDerived : public EncryptedArrayBase double encodeRoundingError() const { const Context& context = getContext(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); // VJS-NOTE: I changed m to phi(m). // VJS-FIXME: for the power of two case, noiseBoundForUniform @@ -1303,7 +1303,7 @@ class EncryptedArrayDerived : public EncryptedArrayBase virtual double defaultErr() const override { const Context& context = getContext(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); // VJS-FIXME: For the power of two case, noiseBoundForUniform // is a bit too pessimistic, as this is the circularly symmetric @@ -1572,7 +1572,8 @@ class EncryptedArray public: //! constructor: G defaults to the monomial X, PAlgebraMod from context EncryptedArray(const Context& context, const NTL::ZZX& G = NTL::ZZX(1, 1)) : - alMod(context.alMod), rep(buildEncryptedArray(context, context.alMod, G)) + alMod(context.getAlMod()), + rep(buildEncryptedArray(context, context.getAlMod(), G)) {} //! constructor: G defaults to F0, PAlgebraMod explicitly given EncryptedArray(const Context& context, const PAlgebraMod& _alMod) : @@ -1951,22 +1952,22 @@ class EncryptedArray inline void rotate(Ctxt& ctxt, long k) { - ctxt.getContext().getDefaultView().rotate(ctxt, k); + ctxt.getContext().getView().rotate(ctxt, k); } inline void shift(Ctxt& ctxt, long k) { - ctxt.getContext().getDefaultView().shift(ctxt, k); + ctxt.getContext().getView().shift(ctxt, k); } inline void rotate1D(Ctxt& ctxt, long i, long k, bool dc = false) { - ctxt.getContext().getDefaultView().rotate1D(ctxt, i, k, dc); + ctxt.getContext().getView().rotate1D(ctxt, i, k, dc); } inline void shift1D(Ctxt& ctxt, long i, long k) { - ctxt.getContext().getDefaultView().shift1D(ctxt, i, k); + ctxt.getContext().getView().shift1D(ctxt, i, k); } // PlaintextArray @@ -2149,7 +2150,8 @@ class PtxtArray PlaintextArray pa; explicit PtxtArray(const EncryptedArray& ea_) : ea(ea_), pa(ea) {} - explicit PtxtArray(const Context& context) : ea(*context.ea), pa(ea) {} + + explicit PtxtArray(const Context& context) : ea(context.getView()), pa(ea) {} // copy constructor: default PtxtArray(const PtxtArray&) = default; @@ -2485,7 +2487,7 @@ void runningSums(const EncryptedArray& ea, Ctxt& ctxt); inline void runningSums(Ctxt& ctxt) { - runningSums(ctxt.getContext().getDefaultView(), ctxt); + runningSums(ctxt.getContext().getView(), ctxt); } //! @brief A ctxt that encrypts \f$(x_1, ..., x_n)\f$ is replaced by an @@ -2494,7 +2496,7 @@ void totalSums(const EncryptedArray& ea, Ctxt& ctxt); inline void totalSums(Ctxt& ctxt) { - totalSums(ctxt.getContext().getDefaultView(), ctxt); + totalSums(ctxt.getContext().getView(), ctxt); } //! @brief Map all non-zero slots to 1, leaving zero slots as zero. diff --git a/include/helib/IndexSet.h b/include/helib/IndexSet.h index 5d8c5b51e..baa646de4 100644 --- a/include/helib/IndexSet.h +++ b/include/helib/IndexSet.h @@ -18,6 +18,8 @@ #include +#include + namespace helib { //! @brief A dynamic set of non-negative integers. @@ -29,11 +31,9 @@ namespace helib { //! \endcode class IndexSet { - std::vector rep; // NOTE: modern versions of C++ are supposed // to implement this efficiently as a "specialized template class". - // Older versions of C++ define the equivalent class bit_std::vector. long _first, _last, _card; @@ -121,8 +121,48 @@ class IndexSet bool isInterval() const { return (_card == (1 + _last - _first)); } /*** raw IO ***/ - void read(std::istream& str); - void write(std::ostream& str) const; + + /** + * @brief Write out the `IndexSet` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `IndexSet` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `IndexSet` object. + **/ + static IndexSet readFrom(std::istream& str); + + /** + * @brief Write out the `IndexSet` object to the output stream using + * JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the `IndexSet` object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized `IndexSet` object using JSON + * format. + * @param str Input `std::istream`. + * @return The deserialized `IndexSet` object. + **/ + static IndexSet readFromJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized `IndexSet` object. + * @param j The `JsonWrapper` containing the serialized `IndexSet` object. + * @return The deserialized `IndexSet` object. + **/ + static IndexSet readFromJSON(const JsonWrapper& j); /*** code to allow one to write "for (long i: set)" ***/ @@ -132,6 +172,7 @@ class IndexSet public: long operator*() const { return i_; } + iterator& operator++() { i_ = s_.next(i_); @@ -157,8 +198,7 @@ class IndexSet iterator end() const { return iterator(*this, this->last() + 1); } }; -// some high-level convenience methods...not very efficient... -// not sure if we really need these +// some high-level convenience methods. //! @brief union IndexSet operator|(const IndexSet& s, const IndexSet& t); diff --git a/include/helib/JsonWrapper.h b/include/helib/JsonWrapper.h new file mode 100644 index 000000000..5a7e51aa5 --- /dev/null +++ b/include/helib/JsonWrapper.h @@ -0,0 +1,28 @@ +#ifndef JSONWRAPPER_HIDDEN_H +#define JSONWRAPPER_HIDDEN_H +#include +#include + +namespace helib { + +struct JsonWrapper +{ +public: + explicit JsonWrapper(const std::any& json_repr) : json_obj(json_repr) {} + explicit operator bool() const { return json_obj.has_value(); } + const std::any& getJSONobj() const { return json_obj; } + JsonWrapper at(const std::string& key) const; + std::string toString() const; + + friend std::ostream& operator<<(std::ostream& str, + const JsonWrapper& wrapper); + + std::string pretty(long indent = 2) const; + +private: + std::any json_obj; +}; + +} // namespace helib + +#endif // JSONWRAPPER_HIDDEN_H diff --git a/include/helib/NumbTh.h b/include/helib/NumbTh.h index cd18c126a..725318da2 100644 --- a/include/helib/NumbTh.h +++ b/include/helib/NumbTh.h @@ -657,53 +657,6 @@ class RandomState //! the char cc void seekPastChar(std::istream& str, int cc); -/** - * @brief Advance the input stream `str` beyond white spaces and a single - * `separator` in the region-of-interest delimited by `begin_char` and - * `end_char`. - * @param str The stream to be advanced. - * @param begin_char The character determining the beginning of the - * region-of-interest (to advance beyond of). - * @param separator The separator character to advance beyond of. - * @param end_char The character determining the end of the region-of-interest - * (to advance beyond of). - * @return `true` if the region-of-interest is not completed (i.e.: `end_char` - * is not reached). `false` otherwise. - * @note Throws `helib::RuntimeError` if after spaces there is a character - * different from `begin_char`, `beyond`, or `end_char`. - */ -bool iterateInterestRegion(std::istream& str, - int begin_char, - int separator, - int end_char); - -/** - * @brief Advance the input stream `istr` beyond white spaces. Then split the - * region delimited by `begin_char` and `end_char` at each occurrence of - * `separator` that is not contained in an inner `begin_char` - `end_char` - * section. The function returns a `std::vector` with the - * stream of every section of the input region. - * @param istr The stream to be advanced. - * @param begin_char The character determining the beginning of the - * region-of-interest. - * @param end_char The character determining the end of the - * region-of-interest - * @param separator The separator character to split at. - * @param skip_space Boolean value determining whether to skip spaces when - * extracting the sub-streams (default = `true`). - * @return A `std::vector` with the stream of every section - * of the input region. - * @throws IOError If the stream is badly formatted (i.e. it does not start with - * `begin_char` or it does not end with `end_char`). - * @note Requires `begin_char`, `end_char` and `separator` to be distinct and - * different from ` ` (space). - */ -std::vector extractTokenizeRegion(std::istream& istr, - char begin_char, - char end_char, - char separator, - bool skip_space = true); - //! @brief Reverse a vector in place template void reverse(NTL::Vec& v, long lo, long hi) diff --git a/include/helib/PAlgebra.h b/include/helib/PAlgebra.h index 90192e10b..b067800ef 100644 --- a/include/helib/PAlgebra.h +++ b/include/helib/PAlgebra.h @@ -194,7 +194,6 @@ class PAlgebra const NTL::ZZX& getPhimX() const { return PhimX; } //! The "ring constant" cM - void set_cM(double c) { cM = c; } double get_cM() const { return cM; } //! The prime-power factorization of m @@ -264,6 +263,7 @@ class PAlgebra { return cube.breakIndexByDim(idx, dim); } + //! The inverse of breakIndexByDim long assembleIndexByDim(std::pair idx, long dim) const { diff --git a/include/helib/PolyMod.h b/include/helib/PolyMod.h index ff7ce05b8..b78ae0d63 100644 --- a/include/helib/PolyMod.h +++ b/include/helib/PolyMod.h @@ -16,7 +16,9 @@ #include #include #include + #include +#include /** * @file PolyMod.h @@ -374,46 +376,114 @@ class PolyMod **/ PolyMod& operator-=(const NTL::ZZX& otherPoly); + /** + * @brief Serialize `this` `PolyMod` to the output stream `os`. + * @param os Output `std::ostream`. + * @note p2r and G are not serialized, see note of `deserialize`. + * + * The output stream will be formatted as a JSON list.\n + * Each coefficient of `poly` will be serialized in an element of such list.\n + * For example if we have a `PolyMod` object `poly` such that `poly[0]=coef0`, + * `poly[1]=coef1`, `poly[2]=coef2`, and `poly[i]=0` for `i>2`, it will be + * serialized as '['coef0', 'coef1', 'coef2']'. + **/ + void writeToJSON(std::ostream& os) const; + + /** + * @brief Serialize `this` `PolyMod` to the `JsonWrapper` object. + * @return The `JsonWrapper` containing the serialized `PolyMod`. + * @note p2r and G are not serialized, see note of `deserialize`. + * + * The output will be a JSON list.\n + * Each coefficient of `poly` will be serialized in an element of such list.\n + * For example if we have a `PolyMod` object `poly` such that `poly[0]=coef0`, + * `poly[1]=coef1`, `poly[2]=coef2`, and `poly[i]=0` for `i>2`, it will be + * serialized as '['coef0', 'coef1', 'coef2']'. + **/ + JsonWrapper writeToJSON() const; + /** * @brief Deserialize a `PolyMod` object from the input stream `is`. * @param is Input `std::istream`. - * @param poly Destination `PolyMod` object. - * @throws IOError if the stream is badly formatted (i.e. it is not delimited - * by '[' and ']'). + * @param ringDescriptor Descriptor object for the plaintext ring. + * @return The deserialized `PolyMod` object. + * @throws IOError if the stream is not a valid JSON. + * @code + * PolyMod my_poly = PolyMod::readFromJSON(std::cin, context); + * @endcode + * + * The input stream has to be formatted as a JSON list.\n + * Each element of the list will be deserialized as a coefficient of the + * polynomial.\n + * For example '['coef0', 'coef1', 'coef2']' will be deserialized as a + * `PolyMod` object `poly` where `poly[0]=coef0`, `poly[1]=coef1`, + * `poly[2]=coef2` and `poly[i]=0` for `i>2`. + **/ + static PolyMod readFromJSON( + std::istream& is, + const std::shared_ptr& ringDescriptor); + + /** + * @brief Deserialize a `PolyMod` object from the `JsonWrapper` `jw`. + * @param jw Input `JsonWrapper`. + * @param ringDescriptor Descriptor object for the plaintext ring. + * @return The deserialized `PolyMod` object. + * @code + * PolyMod my_poly = PolyMod::readFromJSON(..., context); + * @endcode + * + * The input stream has to be a JSON list.\n + * Each element of the list will be deserialized as a coefficient of the + * polynomial.\n + * For example '['coef0', 'coef1', 'coef2']' will be deserialized as a + * `PolyMod` object `poly` where `poly[0]=coef0`, `poly[1]=coef1`, + * `poly[2]=coef2` and `poly[i]=0` for `i>2`. + **/ + static PolyMod readFromJSON( + const JsonWrapper& jw, + const std::shared_ptr& ringDescriptor); + + /** + * @brief In-place deserialize a `PolyMod` object from the input stream `is`. + * @param is Input `std::istream`. + * @throws IOError if the stream is not a valid JSON. * @note `poly` must be constructed with an appropriate p2r and G @b BEFORE * calling this function. For example, * @code * PolyMod my_poly(p2r, G); - * deserialize(std::cin, my_poly); + * my_poly.readJSON(std::cin); * @endcode * - * The input stream has to be formatted as a comma-separated list surrounded - * by '[' and ']'.\n + * The input stream has to be formatted as a JSON list.\n * Each element of the list will be deserialized as a coefficient of the * polynomial.\n * For example '['coef0', 'coef1', 'coef2']' will be deserialized as a * `PolyMod` object `poly` where `poly[0]=coef0`, `poly[1]=coef1`, * `poly[2]=coef2` and `poly[i]=0` for `i>2`. **/ - friend void deserialize(std::istream& is, PolyMod& poly); + void readJSON(std::istream& is); /** - * @brief Serialize a `PolyMod` to the output stream `os`. - * @param os Output `std::ostream`. - * @param poly `PolyMod` object to be written. - * @return Input `std::ostream` post writing. - * @note p2r and G are not serialized, see note of `deserialize`. + * @brief In-place deserialize a `PolyMod` object from the from the + * `JsonWrapper` `jw`. + * @param jw Input `JsonWrapper`. + * @note `poly` must be constructed with an appropriate p2r and G @b BEFORE + * calling this function. For example, + * @code + * PolyMod my_poly(p2r, G); + * my_poly.readJSON(...); + * @endcode * - * The output stream will be formatted as a comma-separated list surrounded by - * '[' and ']'.\n - * Each coefficient of `poly` will be serialized in an element of such list by - * the `>>` operator.\n - * For example if we have a `PolyMod` object `poly` such that `poly[0]=coef0`, - * `poly[1]=coef1`, `poly[2]=coef2`, and `poly[i]=0` for `i>2`, it will be - * serialized as '['coef0', 'coef1', 'coef2']'. + * The input stream has to a JSON list.\n + * Each element of the list will be deserialized as a coefficient of the + * polynomial.\n + * For example '['coef0', 'coef1', 'coef2']' will be deserialized as a + *`PolyMod` object `poly` where `poly[0]=coef0`, `poly[1]=coef1`, + *`poly[2]=coef2` and `poly[i]=0` for `i>2`. **/ - friend void serialize(std::ostream& os, const PolyMod& slot); + void readJSON(const JsonWrapper& jw); + // TODO: serialization 2.0: fix the following comment /** * @brief Input shift operator. * @param is Input `std::istream`. @@ -438,6 +508,7 @@ class PolyMod **/ friend std::istream& operator>>(std::istream& is, PolyMod& poly); + // TODO: serialization 2.0: fix the following comment /** * @brief Output shift operator. * @param os Output `std::ostream`. diff --git a/include/helib/Ptxt.h b/include/helib/Ptxt.h index 3b881b0de..4dfb51927 100644 --- a/include/helib/Ptxt.h +++ b/include/helib/Ptxt.h @@ -101,77 +101,6 @@ void innerProduct(Ptxt& result, result += (first_vec[i] * second_vec[i]); } -/** - * @brief Deserialize a `std::complex` from the input stream `is` - * delimited by '[' and ']' (instead of the default '(', ')'). - * @param is The input stream reference. - * @param num The complex number to deserialize. - * @throws IOError if the stream contains more than 2 parts. - * - * The input stream has to be formatted as '['number']' (this will be - * deserialized as (number, 0)) or '['real_part', 'imag_part']' (this will be - * deserialized as (real_part, imag_part)). - */ -void deserialize(std::istream& is, std::complex& num); - -/** - * @brief Serialize a `std::complex` to the output stream `os` - * delimited by '[' and ']' (instead of the default '(', ')'). - * @param os The output stream reference. - * @param num The complex number to serialize. - * - * The output will be formatted as '['`num.real()`', '`num.imag()`']'. - */ -void serialize(std::ostream& os, const std::complex& num); - -// Forward declaration as function is a friend of the templated `Ptxt` class. -/** - * @brief Function to deserialize a `Ptxt`. - * @tparam Scheme The `Ptxt` object scheme. Can be only be `BGV` or `CKKS`. - * @param is Input `std::istream`. - * @param ptxt Destination `Ptxt` object. - * @throws IOError if the stream is badly formatted (i.e. it is not delimited by - * '[' and ']'). - * @note `ptxt` must be constructed with an appropriate context @b BEFORE - * calling this function. For example, - * @code - * Ptxt my_ptxt(context); - * deserialize(std::cin, my_ptxt); - * @endcode - * - * The input stream has to be formatted as a comma-separated list surrounded by - * '[' and ']'.\n - * Each element of the list will be deserialized as a slot of the - * type determined by the scheme.\n - * If the number of tokens in the list is less - * than the number of slots, the remaining slots will be padded by 0.\n - * For example '['slot0', 'slot1', 'slot2']' will be deserialized as a - * plaintext `ptxt` where `ptxt[0]=slot0`, `ptxt[1]=slot1`, - * `ptxt[2]=slot2` and `ptxt[i]=0` for `i>2`. - */ -template -void deserialize(std::istream& is, Ptxt& ptxt); - -// Forward declaration as function is a friend of the templated `Ptxt` class. -/** - * @brief Function to serialize a `Ptxt`. - * @tparam Scheme The `Ptxt` object scheme. Can be only be `BGV` or `CKKS`. - * @param os Output `std::ostream`. - * @param ptxt `Ptxt` object to be written. - * @return Input `std::ostream` post serializing. - * @note `Ptxt` `context` is not serialized, see note of `deserialize`. - * - * The output stream will be formatted as a comma-separated list surrounded by - * '[' and ']'.\n - * Each slot of `ptxt` will be serialized in an element of such list by the - * `serialize` function determined by the scheme.\n - * For example if we have a plaintext `ptxt` such that `ptxt[0]=slot0`, - * `ptxt[1]=slot1`, `ptxt[2]=slot2`, and `ptxt[i]=0` for `i>2`, it will be - * serialized as '['slot0', 'slot1', 'slot2', `0`, `0` ...]'. - */ -template -void serialize(std::ostream& os, const Ptxt& ptxt); - // Forward declaration as function is a friend of the templated `Ptxt` class. /** * @brief Input shift operator. Uses the `deserialize` function internally. @@ -263,6 +192,12 @@ class Ptxt "scheme (CKKS or BGV)"); public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "Ptxt"; + /** * @brief Alias for type to be stored in the slots. * @@ -796,10 +731,126 @@ class Ptxt **/ Ptxt& mapTo01(); - // No docs as the four functions have been forward-declared with docs. - friend void deserialize(std::istream& is, Ptxt& ptxt); - - friend void serialize(std::ostream& os, const Ptxt& ptxt); + /** + * @brief Function to serialize `this` `Ptxt`. + * @param os Output `std::ostream`. + * @note `Ptxt` `context` is not serialized, see note of `readJSON`. + * + * The output stream will be a JSON where the `Ptxt` content will be + * serialized in the `slots` field.\n Each slot of `ptxt` will be serialized + * in an element of such list by the JSON serializer function determined by + * the scheme.\n For example if we have a plaintext `ptxt` such that + * `ptxt[0]=slot0`, `ptxt[1]=slot1`, `ptxt[2]=slot2`, and `ptxt[i]=0` for + * `i>2`, it will be serialized as '['slot0', 'slot1', 'slot2', `0`, `0` + * ...]'. + */ + void writeToJSON(std::ostream& os) const; + + /** + * @brief Function to serialize `this` `Ptxt`. + * @return The `JsonWrapper` containing the serialization. + * @note `Ptxt` `context` is not serialized, see note of `readJSON`. + * + * The output JsonWrapper will be a JSON where the `Ptxt` content will be + * serialized in the `slots` field.\n + * Each slot of `ptxt` will be serialized in an element of such list by the + * JSON serializer function determined by the scheme.\n + * For example if we have a plaintext `ptxt` such that `ptxt[0]=slot0`, + * `ptxt[1]=slot1`, `ptxt[2]=slot2`, and `ptxt[i]=0` for `i>2`, it will be + * serialized as '['slot0', 'slot1', 'slot2', `0`, `0`, ...]'. + */ + JsonWrapper writeToJSON() const; + + /** + * @brief Function to deserialize and return a `Ptxt` from a JSON + * stream. + * @param is Input `std::istream`. + * @throws IOError if the stream is badly formatted (i.e. it does not contain + * a valid JSON). + * @code + * Ptxt my_ptxt = Ptxt::readFromJSON(std::cin, context); + * @endcode + * + * The input stream has to contain a valid typed JSON value.\n + * Each element of the content list will be deserialized as a slot of the type + * determined by the scheme.\n + * If the number of tokens in the slot list is less than the number of slots, + * the remaining slots will be padded by 0.\n + * For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized + * as a plaintext `ptxt` where `ptxt[0]=slot0`, `ptxt[1]=slot1`, + * `ptxt[2]=slot2` and `ptxt[i]=0` for `i>2`. + */ + static Ptxt readFromJSON(std::istream& is, const Context& context); + + /** + * @brief Function to deserialize and return a `Ptxt` from a + * `JsonWrapper` object. + * @param jw `JsonWrapper` containing the serialized object. + * @throws IOError if the `JsonWrapper` object does not contains a valid + * serialization of a `Ptxt`. + * @code + * Ptxt my_ptxt = Ptxt::readFromJSON(..., context); + * @endcode + * + * The `JsonWrapper` must contain a valid `Ptxt` serialization.\n + * Each element of the content list will be deserialized as a slot of the type + * determined by the scheme.\n + * If the number of tokens in the slot list is less than the number of slots, + * the remaining slots will be padded by 0.\n + * For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized + * as a plaintext `ptxt` where `ptxt[0]=slot0`, `ptxt[1]=slot1`, + * `ptxt[2]=slot2` and `ptxt[i]=0` for `i>2`. + */ + static Ptxt readFromJSON(const JsonWrapper& jw, + const Context& context); + + /** + * @brief In-place function to deserialize a `Ptxt` from a JSON + * stream. + * @param is Input `std::istream`. + * @throws IOError if the stream is badly formatted (i.e. it does not contain + * a valid JSON). + * @note `this` must be constructed with an appropriate context @b BEFORE + * calling this function. For example, + * @code + * Ptxt my_ptxt(context); + * my_ptxt.readJSON(std::cin); + * @endcode + * + * The input stream has to contain a valid typed JSON value.\n + * Each element of the content list will be deserialized as a slot of the type + * determined by the scheme.\n + * If the number of tokens in the slot list is less than the number of slots, + * the remaining slots will be padded by 0.\n + * For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized + * as a plaintext `ptxt` where `ptxt[0]=slot0`, `ptxt[1]=slot1`, + * `ptxt[2]=slot2` and `ptxt[i]=0` for `i>2`. + */ + void readJSON(std::istream& is); + + /** + * @brief In-place function to deserialize a `Ptxt` from a + * `JsonWrapper` object. + * @param jw `JsonWrapper` containing the serialized object. + * @throws IOError if the `JsonWrapper` object does not contains a valid + * serialization of a `Ptxt`. + * @note `this` must be constructed with an appropriate context @b BEFORE + * calling this function. For example, + * @code + * Ptxt my_ptxt(context); + * my_ptxt.readJSON(...); + * @endcode + * + * The `JsonWrapper` must contain a valid `Ptxt` serialization.\n + * Each element of the content list will be deserialized as a slot of the type + * determined by the scheme.\n + * If the number of tokens in the slot list is less than the number of slots, + * the remaining slots will be padded by 0.\n + * For example a slot list '['slot0', 'slot1', 'slot2']' will be deserialized + * as a plaintext `ptxt` where `ptxt[0]=slot0`, `ptxt[1]=slot1`, + * `ptxt[2]=slot2` and `ptxt[i]=0` for `i>2`. + */ + void readJSON(const JsonWrapper& jw); friend std::istream& operator>>(std::istream& is, Ptxt& ptxt); diff --git a/include/helib/binio.h b/include/helib/binio.h deleted file mode 100644 index a7bc0f1c9..000000000 --- a/include/helib/binio.h +++ /dev/null @@ -1,136 +0,0 @@ -/* Copyright (C) 2012-2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ -#ifndef HELIB_BINIO_H -#define HELIB_BINIO_H -#include -#include -#include -#include -#include - -#define BINIO_32BIT 4 -#define BINIO_48BIT 6 -#define BINIO_64BIT 8 - -#define BINIO_EYE_SIZE 4 - -// clang-format off -#define BINIO_EYE_CONTEXTBASE_BEGIN "|BS[" -#define BINIO_EYE_CONTEXTBASE_END "]BS|" -#define BINIO_EYE_CONTEXT_BEGIN "|CN[" -#define BINIO_EYE_CONTEXT_END "]CN|" -#define BINIO_EYE_CTXT_BEGIN "|CX[" -#define BINIO_EYE_CTXT_END "]CX|" -#define BINIO_EYE_PK_BEGIN "|PK[" -#define BINIO_EYE_PK_END "]PK|" -#define BINIO_EYE_SK_BEGIN "|SK[" -#define BINIO_EYE_SK_END "]SK|" -#define BINIO_EYE_SKM_BEGIN "|KM[" -#define BINIO_EYE_SKM_END "]KM|" -// clang-format on - -namespace helib { - -/* This struct (or similar) is a nice to have not used at the moment. */ -// struct BinaryHeader { -// uint8_t structId[4]; -// uint8_t version[4] = {0, 0, 0, 1}; -// uint64_t id; -// uint64_t payloadSize; -//}; - -/* Some utility functions for binary IO */ - -int readEyeCatcher(std::istream& str, const char* expect); -void writeEyeCatcher(std::ostream& str, const char* eye); - -void write_ntl_vec_long(std::ostream& str, - const NTL::vec_long& vl, - long intSize = BINIO_64BIT); -void read_ntl_vec_long(std::istream& str, NTL::vec_long& vl); - -long read_raw_int(std::istream& str); -int read_raw_int32(std::istream& str); -void write_raw_int(std::ostream& str, long num); -void write_raw_int32(std::ostream& str, int num); - -void write_raw_double(std::ostream& str, const double d); -double read_raw_double(std::istream& str); - -void write_raw_xdouble(std::ostream& str, const NTL::xdouble xd); -NTL::xdouble read_raw_xdouble(std::istream& str); - -void write_raw_ZZ(std::ostream& str, const NTL::ZZ& zz); -void read_raw_ZZ(std::istream& str, NTL::ZZ& zz); - -template -void write_raw_vector(std::ostream& str, const std::vector& v) -{ - write_raw_int(str, v.size()); - - for (const T& n : v) { - n.write(str); - } -} - -// vector has a different implementation, since long.write does not work -template <> -void write_raw_vector(std::ostream& str, const std::vector& v); - -// vector has a different implementation, since double.write does not -// work -template <> -void write_raw_vector(std::ostream& str, const std::vector& v); - -template -void read_raw_vector(std::istream& str, std::vector& v, T& init) -{ - long sz = read_raw_int(str); - v.resize(sz, init); // Make space in vector - - for (auto& n : v) { - n.read(str); - } -} - -template -void read_raw_vector(std::istream& str, std::vector& v) -{ - read_raw_vector(str, v, T()); -} - -// vector has a different implementation, since long.read does not work -template <> -void read_raw_vector(std::istream& str, std::vector& v); - -// vector has a different implementation, since double.read does not -// work -template <> -void read_raw_vector(std::istream& str, std::vector& v); - -// KeySwitch::read(...) (in keySwitching.cpp) requires the context. -class Context; -template -void read_raw_vector(std::istream& str, - std::vector& v, - const Context& context) -{ - long sz = read_raw_int(str); - v.resize(sz); // Make space in vector - - for (auto& n : v) { - n.read(str, context); - } -} - -} // namespace helib -#endif // ifndef HELIB_BINIO_H diff --git a/include/helib/helib.h b/include/helib/helib.h index a136cd49a..cdbc1a515 100644 --- a/include/helib/helib.h +++ b/include/helib/helib.h @@ -17,6 +17,8 @@ @brief Entry point header for HElib */ +#include + #include #include #include diff --git a/include/helib/keySwitching.h b/include/helib/keySwitching.h index 5e26eb245..76996812d 100644 --- a/include/helib/keySwitching.h +++ b/include/helib/keySwitching.h @@ -86,6 +86,12 @@ namespace helib { class KeySwitch { public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "KeySwitch"; + SKHandle fromKey; // A handle for the key s' long toKeyID; // Index of the key s that we are switching into long ptxtSpace; // either p or p^r @@ -121,8 +127,66 @@ class KeySwitch void readMatrix(std::istream& str, const Context& context); //! Raw IO - void read(std::istream& str, const Context& context); - void write(std::ostream& str) const; + /** + * @brief Write out the `KeySwitch` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `KeySwitch` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `KeySwitch` object. + **/ + static KeySwitch readFrom(std::istream& str, const Context& context); + + /** + * @brief Write out the switch key (`KeySwitch`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the switch key (`KeySwitch`) object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized switch key (`KeySwitch`) object + * using JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + * @return The deserialized `KeySwitch` object. + **/ + static KeySwitch readFromJSON(std::istream& str, const Context& context); + + /** + * @brief Read from the `JsonWrapper` the serialized switch key (`KeySwitch`) + * object. + * @param j The `JsonWrapper` containing the serialized `KeySwitch` object. + * @param context The `Context` to be used. + * @return The deserialized `KeySwitch` object. + **/ + static KeySwitch readFromJSON(const JsonWrapper& j, const Context& context); + + /** + * @brief In-place read from the stream the serialized switch key + * (`KeySwitch`) object using JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + **/ + void readJSON(std::istream& str, const Context& context); + + /** + * @brief In-place read from the `JsonWrapper` the serialized switch key + * (`KeySwitch`) object. + * @param j The `JsonWrapper` containing the serialized `KeySwitch` object. + * @param context The `Context` to be used. + **/ + void readJSON(const JsonWrapper& j, const Context& context); }; std::ostream& operator<<(std::ostream& str, const KeySwitch& matrix); // We DO NOT have std::istream& operator>>(std::istream& str, KeySwitch& diff --git a/include/helib/keys.h b/include/helib/keys.h index 3c0ec198b..d594a0a0e 100644 --- a/include/helib/keys.h +++ b/include/helib/keys.h @@ -37,9 +37,6 @@ namespace helib { #define HELIB_KSS_MIN (3) // minimal strategy (for g_i, and for g_i^{-ord_i} for bad dims) -void writePubKeyBinary(std::ostream& str, const PubKey& pk); -void readPubKeyBinary(std::istream& str, PubKey& pk); - /** * @class PubKey * @brief The public key @@ -73,8 +70,13 @@ class PubKey Ctxt recryptEkey; // the key itself, encrypted under key #0 public: - //! This constructor thorws run-time error if activeContext=nullptr - PubKey(); + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "PubKey"; + + PubKey() = delete; explicit PubKey(const Context& _context); @@ -213,8 +215,65 @@ class PubKey friend class SecKey; friend std::ostream& operator<<(std::ostream& str, const PubKey& pk); friend std::istream& operator>>(std::istream& str, PubKey& pk); - friend void ::helib::writePubKeyBinary(std::ostream& str, const PubKey& pk); - friend void ::helib::readPubKeyBinary(std::istream& str, PubKey& pk); + + /** + * @brief Write out the `PubKey` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `PubKey` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `PubKey` object. + **/ + static PubKey readFrom(std::istream& str, const Context& context); + + /** + * @brief Write out the public key (`PubKey`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the public key (`PubKey`) object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized public key (`PubKey`) object + * using JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + * @return The deserialized `PubKey` object. + **/ + static PubKey readFromJSON(std::istream& str, const Context& context); + + /** + * @brief Read from the `JsonWrapper` the serialized public key (`PubKey`) + * object. + * @param j The `JsonWrapper` containing the serialized `PubKey` object. + * @param context The `Context` to be used. + * @return The deserialized `PubKey` object. + **/ + static PubKey readFromJSON(const JsonWrapper& j, const Context& context); + + /** + * @brief In-place read from the stream the serialized public key (`PubKey`) + * object using JSON format. + * @param str Input `std::istream`. + **/ + void readJSON(std::istream& str); + + /** + * @brief In-place read from the `JsonWrapper` the serialized public key + * (`PubKey`) object. + * @param j The `JsonWrapper` containing the serialized `PubKey` object. + **/ + void readJSON(const JsonWrapper& j); // defines plaintext space for the bootstrapping encrypted secret key static long ePlusR(long p); @@ -224,19 +283,24 @@ class PubKey void hackPtxtSpace(long p2r) { pubEncrKey.ptxtSpace = p2r; } }; -void writeSecKeyBinary(std::ostream& str, const SecKey& sk); -void readSecKeyBinary(std::istream& str, SecKey& sk); - /** * @class SecKey * @brief The secret key ******************************************************************/ class SecKey : public PubKey { // The secret key -public: +private: + friend class KeySwitch; std::vector sKeys; // The secret key(s) themselves + explicit SecKey(const PubKey& pk); public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "SecKey"; + // Disable default constructor SecKey() = delete; @@ -329,8 +393,65 @@ class SecKey : public PubKey friend std::ostream& operator<<(std::ostream& str, const SecKey& sk); friend std::istream& operator>>(std::istream& str, SecKey& sk); - friend void ::helib::writeSecKeyBinary(std::ostream& str, const SecKey& sk); - friend void ::helib::readSecKeyBinary(std::istream& str, SecKey& sk); + + /** + * @brief Write out the `SecKey` object in binary format. + * @param str Output `std::ostream`. + **/ + void writeTo(std::ostream& str) const; + + /** + * @brief Read from the stream the serialized `SecKey` object in binary + * format. + * @param str Input `std::istream`. + * @return The deserialized `SecKey` object. + **/ + static SecKey readFrom(std::istream& str, const Context& context); + + /** + * @brief Write out the secret key (`SecKey`) object to the output + * stream using JSON format. + * @param str Output `std::ostream`. + **/ + void writeToJSON(std::ostream& str) const; + + /** + * @brief Write out the secret key (`SecKey`) object to a `JsonWrapper`. + * @return The `JsonWrapper`. + **/ + JsonWrapper writeToJSON() const; + + /** + * @brief Read from the stream the serialized secret key (`SecKey`) object + * using JSON format. + * @param str Input `std::istream`. + * @param context The `Context` to be used. + * @return The deserialized `SecKey` object. + **/ + static SecKey readFromJSON(std::istream& str, const Context& context); + + /** + * @brief Read from the `JsonWrapper` the serialized secret key (`SecKey`) + * object. + * @param j The `JsonWrapper` containing the serialized `SecKey` object. + * @param context The `Context` to be used. + * @return The deserialized `SecKey` object. + **/ + static SecKey readFromJSON(const JsonWrapper& j, const Context& context); + + /** + * @brief Read from the stream the serialized secret key (`SecKey`) object + * using JSON format. + * @param str Input `std::istream`. + **/ + void readJSON(std::istream& str); + + /** + * @brief Read from the `JsonWrapper` the serialized secret key (`SecKey`) + * object. + * @param j The `JsonWrapper` containing the serialized `SecKey` object. + **/ + void readJSON(const JsonWrapper& j); // TODO: Add a similar method for binary serialization // This just writes the derived part, not including the public key diff --git a/include/helib/matmul.h b/include/helib/matmul.h index 144f83453..d048f2091 100644 --- a/include/helib/matmul.h +++ b/include/helib/matmul.h @@ -155,7 +155,7 @@ class MatMul_CKKS : public MatMul1D_CKKS {} MatMul_CKKS(const Context& context, get_fun_type _get_fun) : - ea(context.getDefaultEA()), get_fun(_get_fun) + ea(context.getEA()), get_fun(_get_fun) {} virtual const EncryptedArray& getEA() const override { return ea; } @@ -184,7 +184,7 @@ class MatMul_CKKS_Complex : public MatMul1D_CKKS {} MatMul_CKKS_Complex(const Context& context, get_fun_type _get_fun) : - ea(context.getDefaultEA()), get_fun(_get_fun) + ea(context.getEA()), get_fun(_get_fun) {} virtual const EncryptedArray& getEA() const override { return ea; } diff --git a/include/helib/partialMatch.h b/include/helib/partialMatch.h index 117349cff..2279b18cd 100644 --- a/include/helib/partialMatch.h +++ b/include/helib/partialMatch.h @@ -170,14 +170,14 @@ inline Matrix calculateScores( **/ inline PolyMod partialMatchEncode(uint32_t input, const Context& context) { - const long p = context.zMStar.getP(); - std::vector coeffs(context.zMStar.getOrdP()); + const long p = context.getP(); + std::vector coeffs(context.getOrdP()); // TODO - shouldn't keep checking input. for (long i = 0; i < long(coeffs.size()) && input != 0; ++i) { coeffs[i] = input % p; input /= p; } - return PolyMod(coeffs, context.slotRing); + return PolyMod(coeffs, context.getSlotRing()); } struct Expr; @@ -609,7 +609,7 @@ inline Matrix Database::contains( if (lookup_query.containsOR) { // FLT on the scores result.apply([&](auto& txt) { - txt.power(context->alMod.getPPowR() - 1); + txt.power(context->getAlMod().getPPowR() - 1); return txt; }); } @@ -623,7 +623,7 @@ inline Matrix Database::getScore( const Query_t& weighted_query, const Matrix& query_data) const { - auto mask = calculateMasks(*(context->ea), query_data, this->data); + auto mask = calculateMasks(context->getEA(), query_data, this->data); auto result = calculateScores(weighted_query.Fs, weighted_query.mus, diff --git a/include/helib/permutations.h b/include/helib/permutations.h index bb4218837..0d4117587 100644 --- a/include/helib/permutations.h +++ b/include/helib/permutations.h @@ -317,6 +317,7 @@ class FullBinaryTree long leftChildIdx(long i) const { return nodes.at(i).leftChild; } long rightChildIdx(long i) const { return nodes.at(i).rightChild; } + // FIXME: refactoring2.0: should we change also this? void printout(std::ostream& s, long idx = 0) const { s << "[" << aux << " "; diff --git a/include/helib/randomMatrices.h b/include/helib/randomMatrices.h index f376cb518..d0587053a 100644 --- a/include/helib/randomMatrices.h +++ b/include/helib/randomMatrices.h @@ -261,7 +261,7 @@ class RandomFullMatrix : public MatMulFull_derived RBak bak; bak.save(); - ea.getContext().alMod.restoreContext(); + ea.getContext().getAlMod().restoreContext(); data.resize(n); for (long i : range(n)) { data[i].resize(n); @@ -300,7 +300,7 @@ class RandomFullBlockMatrix : public BlockMatMulFull_derived RBak bak; bak.save(); - ea.getContext().alMod.restoreContext(); + ea.getContext().getAlMod().restoreContext(); data.resize(n); for (long i : range(n)) { data[i].resize(n); diff --git a/include/helib/recryption.h b/include/helib/recryption.h index 92becae40..28809681a 100644 --- a/include/helib/recryption.h +++ b/include/helib/recryption.h @@ -46,18 +46,20 @@ class RecryptData long skHwt; //! for plaintext space p^{e-e'+r} - std::shared_ptr alMod; + std::shared_ptr alMod = nullptr; //! for plaintext space p^{e-e'+r} - std::shared_ptr ea; + std::shared_ptr ea = nullptr; bool build_cache; + bool alsoThick; + //! linear maps - std::shared_ptr firstMap, secondMap; + std::shared_ptr firstMap = nullptr, secondMap = nullptr; //! conversion between ZZX and Powerful - std::shared_ptr p2dConv; + std::shared_ptr p2dConv = nullptr; //! linPolys for unpacking the slots std::vector unpackSlotEncoding; @@ -67,6 +69,7 @@ class RecryptData skHwt = 0; e = ePrime = 0; build_cache = false; + alsoThick = false; } //! Initialize the recryption data in the context diff --git a/include/helib/scheme.h b/include/helib/scheme.h index c889618f0..9f278a984 100644 --- a/include/helib/scheme.h +++ b/include/helib/scheme.h @@ -32,6 +32,11 @@ struct CKKS * @brief Slot type used for CKKS plaintexts: `std::complex`. **/ using SlotType = std::complex; + + /** + * @brief Scheme label to be added to JSON serialization. + */ + static constexpr std::string_view schemeName = "CKKS"; }; /** @@ -44,6 +49,11 @@ struct BGV * polynomial modulo p^r and G. **/ using SlotType = PolyMod; + + /** + * @brief Scheme label to be added to JSON serialization. + */ + static constexpr std::string_view schemeName = "BGV"; }; } // namespace helib diff --git a/include/helib/set.h b/include/helib/set.h index c076747e4..937d01035 100644 --- a/include/helib/set.h +++ b/include/helib/set.h @@ -82,7 +82,7 @@ inline TXT calculateSetIntersection(const TXT& query, auto lquery = std::make_unique(query); Ptxt entry(query.getContext(), server_set[i]); *lquery -= entry; - mapTo01(*query.getContext().ea, *lquery); + mapTo01(query.getContext().getEA(), *lquery); lquery->negate(); lquery->addConstant(NTL::ZZX(1L)); sumRegister.add(lquery); diff --git a/include/helib/version.in.h b/include/helib/version.in.h index 0b8f9f458..7c29ca0a7 100644 --- a/include/helib/version.in.h +++ b/include/helib/version.in.h @@ -41,7 +41,7 @@ struct version /** * @brief The string representation of this version of HElib. **/ - static constexpr auto asString = "v@PROJECT_VERSION@"; + static constexpr auto asString = "@PROJECT_VERSION@"; /** * @brief Function that returns whether this version of HElib is equal to or diff --git a/misc/format.sh b/misc/format.sh index 629dbc086..75c38eaff 100755 --- a/misc/format.sh +++ b/misc/format.sh @@ -47,6 +47,7 @@ previous_dir="" for file in $(find -E . -type f -regex '.*\.(c|h|cpp|hpp)' \ ! -path '*/misc/*' \ ! -path '*/build/*' \ + ! -path '*/dependencies/*' \ ! -name "PGFFT.*"); do current_dir=$(dirname $file) if [ "$current_dir" != "$previous_dir" ]; then diff --git a/misc/psi/CMakeLists.txt b/misc/psi/CMakeLists.txt index 795c74142..93ed317f7 100644 --- a/misc/psi/CMakeLists.txt +++ b/misc/psi/CMakeLists.txt @@ -31,7 +31,12 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}") - find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) add_subdirectory(scoring) add_subdirectory(lookup) diff --git a/misc/psi/README.md b/misc/psi/README.md index 582b7940a..0220401c7 100644 --- a/misc/psi/README.md +++ b/misc/psi/README.md @@ -1,6 +1,6 @@ # Building and Running the lookup/scoring tests -## Prequisites +## Prerequisites - You must have bats-core installed. - Build and install HElib. @@ -18,6 +18,37 @@ make -j3 ## Run the tests +Note that the test data is not provided. Data can be generated and encoded +using the utilities [here](../../utils/). + +Due to how the tests have been written, please ensure both the database and +query have at least four columns. For example, a database of 2 rows and 4 +columns, where the data can be seen in bold + +[comment]: <> (Use these formatting and HTML tags instead of the conventional) +[comment]: <> (code block to allow formatted text within what looks like a) +[comment]: <> (code block) + +
+2 4
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[0,1],[2,3],[4,5]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[0],[0],[0]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[6,7],[8,9],[10,11]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[1],[1],[1]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[12,13],[14,15],[16,17]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[2],[2],[2]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[18,19],[0],[0]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[3],[3],[3]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+
+and an example query +
+1 4
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[0,1],[2,3],[4,5]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[6,7],[8,9],[10,11]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[12,13],[14,15],[16,17]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+{"HElibVersion":"2.0.0","content":{"scheme":"BGV","slots":[[18,19],[0],[0]]},"serializationVersion":"0.0.1","type":"Ptxt"}
+
+ Make sure you are in the directory `/HElib/misc/psi/test` directory. @@ -38,7 +69,7 @@ directory `data_and_params`. ``` DEBUG=1 bats . ``` -You should see a lot of tmp directories, one for each test. +You should see a lot of `tmp` directories, one for each test. 3. View the results ``` diff --git a/misc/psi/lookup/CMakeLists.txt b/misc/psi/lookup/CMakeLists.txt index 5e2822826..5d03b34bf 100644 --- a/misc/psi/lookup/CMakeLists.txt +++ b/misc/psi/lookup/CMakeLists.txt @@ -20,7 +20,12 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON) project(lookup LANGUAGES CXX) -find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 characters newline at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../../../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) add_executable(lookup lookup.cpp) diff --git a/misc/psi/scoring/CMakeLists.txt b/misc/psi/scoring/CMakeLists.txt index 59d24dec7..ce62deece 100644 --- a/misc/psi/scoring/CMakeLists.txt +++ b/misc/psi/scoring/CMakeLists.txt @@ -20,7 +20,12 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON) project(scoring LANGUAGES CXX) -find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../../../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) add_executable(scoring scoring.cpp) diff --git a/misc/psi/tests/gen-expected-mask.py b/misc/psi/tests/gen-expected-mask.py index b7fcce31b..488ea9099 100755 --- a/misc/psi/tests/gen-expected-mask.py +++ b/misc/psi/tests/gen-expected-mask.py @@ -13,12 +13,16 @@ import argparse import sys -import ast +import json import math import operator from enum import Enum from functools import reduce +def getVersion(): + with open("../../../../VERSION") as f: + return f.readline().replace('\n', '') + def modCoeffsInSlots(listOfLists, p): return list([coeff % p for coeff in slot ] for slot in listOfLists) @@ -106,7 +110,7 @@ def parseHeader(line): def readRecord(data, p): nrecords, ncols = parseHeader(data.readline()) for _ in range(nrecords): - record = [ ast.literal_eval(data.readline()) for _ in range(ncols) ] + record = [ json.loads(data.readline())['content']['slots'] for _ in range(ncols) ] if p > 0: record = modRecord(record, p) yield record @@ -132,7 +136,9 @@ def main(): records = tuple(readRecord(db, args.mod_p)) print(len(records)) for record in records: - print(testFn(record, querydata)) + print(f'{{"HElibVersion":"{getVersion()}","content":{{"scheme":"BGV","slots":', end='') + print(testFn(record, querydata).__str__().replace(', ', ','), end='') + print(f'}},"serializationVersion":"0.0.1","type":"Ptxt"}}') if __name__ == "__main__": main() diff --git a/misc/psi/tests/gen-params.batx b/misc/psi/tests/gen-params.batx index 14cf353ea..a4945876e 100644 --- a/misc/psi/tests/gen-params.batx +++ b/misc/psi/tests/gen-params.batx @@ -14,8 +14,8 @@ utils_dir="../../../../utils" load "../../../utils/tests/std" -#nslots=3 -nslots=13860 +nslots=3 +#nslots=13860 #nslots=79872 datadir="data_and_params" data_prefix="../$datadir" @@ -27,7 +27,7 @@ function create-toy-lookup-params { touch "${prefix_bgv}".params # d=2, nslots=3 echo "# Generated by bash test" >> "${prefix_bgv}".params - echo "p=13" >> "${prefix_bgv}".params + echo "p=13" >> "${prefix_bgv}".params # Also works with p=167 echo "m=7" >> "${prefix_bgv}".params echo "r=1" >> "${prefix_bgv}".params echo "c=2" >> "${prefix_bgv}".params @@ -63,7 +63,6 @@ function teardown { function create-serious-lookup-params { rm -f "${prefix_bgv}".params touch "${prefix_bgv}".params - # d=2, nslots=3 echo "# Generated by bash test" >> "${prefix_bgv}".params echo "p=257" >> "${prefix_bgv}".params echo "m=56803" >> "${prefix_bgv}".params # d=4, nslots=13860, ~179 sec @@ -75,8 +74,8 @@ function create-serious-lookup-params { } @test "only generate the context" { -# create-toy-lookup-params - create-serious-lookup-params + create-toy-lookup-params +# create-serious-lookup-params createContext BGV "${prefix_bgv}.params" "$prefix_bgv" "--frob-skm" techo "$(cat ${prefix_bgv}.info)" } @@ -84,8 +83,8 @@ function create-serious-lookup-params { @test "generate params and encrypt query and database" { # Delete the existing data and params directory. rm -rf ../$datadir -# create-toy-lookup-params - create-serious-lookup-params + create-toy-lookup-params +# create-serious-lookup-params createContext BGV "${prefix_bgv}.params" "$prefix_bgv" "--frob-skm" # Encrypt the database and query $encrypt ${prefix_bgv}.pk ${db_encoded} -o "db.ctxt" diff --git a/misc/psi/tests/lookup.bats b/misc/psi/tests/lookup.bats index 100590182..20bbdce23 100755 --- a/misc/psi/tests/lookup.bats +++ b/misc/psi/tests/lookup.bats @@ -14,8 +14,10 @@ utils_dir="../../../../utils" load "../../../utils/tests/std" -modulus=257 -nslots=13860 +nslots=3 +modulus=13 +#nslots=13860 +#modulus=257 #nslots=79872 #modulus=1278209 datadir="data_and_params" diff --git a/misc/psi/tests/scoring.bats b/misc/psi/tests/scoring.bats index fd1a25d05..e09271ddb 100755 --- a/misc/psi/tests/scoring.bats +++ b/misc/psi/tests/scoring.bats @@ -14,8 +14,10 @@ utils_dir="../../../../utils" load "../../../utils/tests/std" -modulus=257 -nslots=13860 +nslots=3 +modulus=13 +#nslots=13860 +#modulus=257 #nslots=79872 #modulus=1278209 datadir="data_and_params" diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index a1ec1d3a0..f247ecc51 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -13,7 +13,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) project(helib - VERSION 1.3.1 + VERSION "${HELIB_VERSION}" LANGUAGES CXX) # Globals HELIB_CMAKE_EXTRA_DIR, HELIB_INCLUDE_DIR, HELIB_HEADER_DIR, @@ -90,6 +90,7 @@ set(HELIB_SRCS "binaryArith.cpp" "binaryCompare.cpp" "binio.cpp" + "io.cpp" "bluestein.cpp" "CModulus.cpp" "Context.cpp" @@ -105,6 +106,7 @@ set(HELIB_SRCS "hypercube.cpp" "IndexSet.cpp" "intraSlot.cpp" + "JsonWrapper.cpp" "keys.cpp" "keySwitching.cpp" "log.cpp" @@ -139,7 +141,6 @@ set(HELIB_HEADERS "${HELIB_HEADER_DIR}/ArgMap.h" "${HELIB_HEADER_DIR}/binaryArith.h" "${HELIB_HEADER_DIR}/binaryCompare.h" - "${HELIB_HEADER_DIR}/binio.h" "${HELIB_HEADER_DIR}/bluestein.h" "${HELIB_HEADER_DIR}/ClonedPtr.h" "${HELIB_HEADER_DIR}/CModulus.h" @@ -158,6 +159,7 @@ set(HELIB_HEADERS "${HELIB_HEADER_DIR}/IndexMap.h" "${HELIB_HEADER_DIR}/IndexSet.h" "${HELIB_HEADER_DIR}/intraSlot.h" + "${HELIB_HEADER_DIR}/JsonWrapper.h" "${HELIB_HEADER_DIR}/matching.h" "${HELIB_HEADER_DIR}/matmul.h" "${HELIB_HEADER_DIR}/Matrix.h" @@ -195,11 +197,16 @@ set(HELIB_HEADERS "${CMAKE_CURRENT_BINARY_DIR}/helib/version.h" # version.h is auto-generated in CMAKE_CURRENT_BINARY_DIR ) +set(HELIB_PRIVATE_HEADERS + "io.h") + # Add helib target as a shared/static library if (BUILD_SHARED) - add_library(helib SHARED ${HELIB_SRCS} ${HELIB_HEADERS}) + add_library(helib + SHARED ${HELIB_SRCS} ${HELIB_HEADERS} ${HELIB_PRIVATE_HEADERS}) else (BUILD_SHARED) - add_library(helib STATIC ${HELIB_SRCS} ${HELIB_HEADERS}) + add_library(helib + STATIC ${HELIB_SRCS} ${HELIB_HEADERS} ${HELIB_PRIVATE_HEADERS}) endif (BUILD_SHARED) # Set HElib's properties. In this case we ask to build HElib with @@ -253,6 +260,7 @@ endif (PACKAGE_BUILD) target_include_directories( helib PRIVATE + "$" PUBLIC # NOTE: The includes must be kept in this order to avoid cmake # looking for HElib in /usr/local/include # Headers used from source/build location: diff --git a/src/Context.cpp b/src/Context.cpp index d4fc641e5..4ff846191 100644 --- a/src/Context.cpp +++ b/src/Context.cpp @@ -12,16 +12,156 @@ #include #include #include + +#include +using json = ::nlohmann::json; + #include #include #include -#include #include #include #include +#include + +#include "binio.h" +#include "io.h" namespace helib { +double lweEstimateSecurity(int n, double log2AlphaInv, int hwt) +{ + if (hwt < 0 || (hwt > 0 && hwt < MIN_SK_HWT)) { + return 0; + } + + // clang-format off + constexpr double hwgts[] = + {120, 150, 180, 210, 240, 270, 300, 330, 360, 390, 420, 450}; + constexpr double slopes[] = + {2.4, 2.67, 2.83, 3.0, 3.1, 3.3, 3.3, 3.35, 3.4, 3.45, 3.5, 3.55}; + constexpr double cnstrms[] = + {19, 13, 10, 6, 3, 1, -3, -4, -5, -7, -10, -12}; + // clang-format on + + constexpr size_t numWghts = sizeof(hwgts) / sizeof(hwgts[0]); + + const size_t idx = (hwt - 120) / 30; // index into the array above + double slope = 0, consterm = 0; + if (hwt == 0) { // dense keys + slope = 3.8; + consterm = -20; + } else if (idx < numWghts - 1) { + // estimate prms on a line from prms[i] to prms[i+1] + // how far into this interval + double a = double(hwt - hwgts[idx]) / (hwgts[idx + 1] - hwgts[idx]); + slope = slopes[idx] + a * (slopes[idx + 1] - slopes[idx]); + consterm = cnstrms[idx] + a * (cnstrms[idx + 1] - cnstrms[idx]); + } else { + // Use the params corresponding to largest weight (450 above) + slope = slopes[numWghts - 1]; + consterm = cnstrms[numWghts - 1]; + } + + double x = n / log2AlphaInv; + double ret = slope * x + consterm; + + return ret < 0.0 ? 0.0 : ret; // If ret is negative then return 0.0 +} + +// You initialize a PrimeGenerator as follows: +// PrimeGenerator gen(len, m); +// Each call to gen.next() generates a prime p with +// (1-1/2^B)*2^len <= p < 2^len and p = 2^k*t*m + 1, +// where t is odd and k is as large as possible +// and B is a small constant (typically, B in {2,3,4}). +// If no such prime is found, then an error is raised. + +struct PrimeGenerator +{ + const static long B = 3; + long len, m; + long k, t; + + PrimeGenerator(long _len, long _m) : len(_len), m(_m) + { + assertInRange(len, + long(B), + static_cast(NTL_SP_NBITS), + "PrimeGenerator: len is not " + "in [B, NTL_SP_NBITS]", + true); + assertInRange(m, + 1l, + static_cast(NTL_SP_BOUND), + "PrimeGenerator: m is " + "not in [1, NTL_SP_BOUND)"); + + // compute k as smallest non-negative integer such that + // 2^{len-B} < 2^k*m + k = 0; + while ((m << k) <= (1L << (len - B))) + k++; + + t = divc((1L << len) - 1, m << k); + // this ensures the fist call to next will trigger a new k-value + } + + long next() + { + // we consider all odd t in the interval + // [ (1-1/2^B)*2^len-1)/(2^k*m), (2^len-1)/(2^k*m) ). + // For k satisfying 2^{len-B} >= 2^k*m, this interval is + // contains at least one integer. + // It is equivalent to consider the interval + // of integers [tlb, tub), where tlb = ceil(((1-1/2^B)*2^len-1)/(2^k*m)) + // and tub = ceil((2^len-1)/(2^k*m)). + + long tub = divc((1L << len) - 1, m << k); + + for (;;) { + + t++; + + if (t >= tub) { + // move to smaller value of k, reset t and tub + + k--; + + long klb; + if (m % 2 == 0) + klb = 0; + else + klb = 1; + + // we run k down to 0 if m is even, and down to 1 + // if m is odd. + + if (k < klb) + throw RuntimeError("Prime generator ran out of primes"); + + t = divc((1L << len) - (1L << (len - B)) - 1, m << k); + tub = divc((1L << len) - 1, m << k); + } + + if (t % 2 == 0) + continue; // we only want to consider odd t + + long cand = ((t * m) << k) + 1; // = 2^k*t*m + 1 + + // double check that cand is in the prescribed interval + assertInRange(cand, + (1L << len) - (1L << (len - B)), + 1L << len, + "Candidate cand is not in the prescribed interval"); + + if (NTL::ProbPrime(cand, 60)) + return cand; + // iteration count == 60 implies 2^{-120} error probability + } + } +}; + // Useful params objects (POD) to simplify calls between ContextBuilder and // Context. struct Context::ModChainParams @@ -32,6 +172,8 @@ struct Context::ModChainParams long skHwt; long resolution; long bitsInSpecialPrimes; + double stdev; + double scale; }; struct Context::BootStrapParams @@ -41,6 +183,27 @@ struct Context::BootStrapParams bool thickFlag; }; +struct Context::SerializableContent +{ + long p; + long r; + long m; + std::vector gens; + std::vector ords; + NTL::xdouble stdev; + double scale; + IndexSet smallPrimes; + IndexSet specialPrimes; + std::vector qs; + std::vector digits; + long hwt_param; + long e_param; + long ePrime_param; + NTL::Vec mvec; + bool build_cache; + bool alsoThick; +}; + long FindM(long k, long nBits, long c, @@ -234,7 +397,7 @@ bool Context::operator==(const Context& other) const if (digits[i] != other.digits[i]) return false; - if (stdev != other.stdev) + if (stdev != other.getStdev()) return false; if (scale != other.scale) @@ -249,338 +412,259 @@ bool Context::operator==(const Context& other) const return true; } -void writeContextBaseBinary(std::ostream& str, const Context& context) +void Context::writeTo(std::ostream& str) const { - writeEyeCatcher(str, BINIO_EYE_CONTEXTBASE_BEGIN); + SerializeHeader().writeTo(str); - write_raw_int(str, context.zMStar.getP()); - write_raw_int(str, context.alMod.getR()); - write_raw_int(str, context.zMStar.getM()); + writeEyeCatcher(str, EyeCatcher::CONTEXT_BEGIN); - write_raw_int(str, context.zMStar.numOfGens()); + write_raw_int(str, this->zMStar.getP()); + write_raw_int(str, this->alMod.getR()); + write_raw_int(str, this->zMStar.getM()); + + write_raw_int(str, this->zMStar.numOfGens()); // There aren't simple getters to get the gens and ords vectors - for (long i = 0; i < context.zMStar.numOfGens(); i++) { - write_raw_int(str, context.zMStar.ZmStarGen(i)); + for (long i = 0; i < this->zMStar.numOfGens(); i++) { + write_raw_int(str, this->zMStar.ZmStarGen(i)); } - write_raw_int(str, context.zMStar.numOfGens()); + write_raw_int(str, this->zMStar.numOfGens()); // Copying the way it is done in ASCII IO. // Bad dimensions are represented as a negated ord - for (long i = 0; i < context.zMStar.numOfGens(); i++) { - if (context.zMStar.SameOrd(i)) - write_raw_int(str, context.zMStar.OrderOf(i)); + for (long i = 0; i < this->zMStar.numOfGens(); i++) { + if (this->zMStar.SameOrd(i)) + write_raw_int(str, this->zMStar.OrderOf(i)); else - write_raw_int(str, -context.zMStar.OrderOf(i)); + write_raw_int(str, -this->zMStar.OrderOf(i)); } - writeEyeCatcher(str, BINIO_EYE_CONTEXTBASE_END); -} - -void readContextBaseBinary(std::istream& str, - unsigned long& m, - unsigned long& p, - unsigned long& r, - std::vector& gens, - std::vector& ords) -{ - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CONTEXTBASE_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-context-base eye catcher"); - - p = read_raw_int(str); - r = read_raw_int(str); - m = read_raw_int(str); - - // Number of gens and ords saved in front of vectors - read_raw_vector(str, gens); - read_raw_vector(str, ords); - - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CONTEXTBASE_END); - assertEq(eyeCatcherFound, 0, "Could not find post-context-base eye catcher"); -} - -std::unique_ptr buildContextFromBinary(std::istream& str) -{ - unsigned long m, p, r; - std::vector gens, ords; - readContextBaseBinary(str, m, p, r, gens, ords); - return std::unique_ptr(new Context(m, p, r, gens, ords)); -} - -void writeContextBinary(std::ostream& str, const Context& context) -{ - - writeEyeCatcher(str, BINIO_EYE_CONTEXT_BEGIN); - // standard-deviation - write_raw_xdouble(str, context.stdev); + write_raw_xdouble(str, this->stdev); // scale - write_raw_double(str, context.scale); + write_raw_double(str, this->scale); // the "small" index - write_raw_int(str, context.smallPrimes.card()); - for (long tmp : context.smallPrimes) { - write_raw_int(str, tmp); - } + this->smallPrimes.writeTo(str); // the "special" index - write_raw_int(str, context.specialPrimes.card()); - for (long tmp : context.specialPrimes) { - write_raw_int(str, tmp); - } + this->specialPrimes.writeTo(str); // output the primes in the chain - write_raw_int(str, context.moduli.size()); + write_raw_int(str, this->moduli.size()); - for (long i = 0; i < (long)context.moduli.size(); i++) { - write_raw_int(str, context.moduli[i].getQ()); + for (const auto& modulo : this->moduli) { + write_raw_int(str, modulo.getQ()); } // output the digits - write_raw_int(str, context.digits.size()); + write_raw_int(str, this->digits.size()); - for (long i = 0; i < (long)context.digits.size(); i++) { - write_raw_int(str, context.digits[i].card()); - for (long tmp : context.digits[i]) { - write_raw_int(str, tmp); - } + for (const auto& digit : this->digits) { + digit.writeTo(str); } - write_raw_int(str, context.hwt_param); - write_raw_int(str, context.e_param); - write_raw_int(str, context.ePrime_param); + write_raw_int(str, this->hwt_param); + write_raw_int(str, this->e_param); + write_raw_int(str, this->ePrime_param); - write_ntl_vec_long(str, context.rcData.mvec); + write_ntl_vec_long(str, this->rcData.mvec); + write_raw_int(str, static_cast(this->rcData.build_cache)); + write_raw_int(str, static_cast(this->rcData.alsoThick)); - writeEyeCatcher(str, BINIO_EYE_CONTEXT_END); + writeEyeCatcher(str, EyeCatcher::CONTEXT_END); } -void readContextBinary(std::istream& str, Context& context) +Context::SerializableContent Context::readParamsFrom(std::istream& str) { - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CONTEXT_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-context eye catcher"); - - // Get the standard deviation - context.stdev = read_raw_xdouble(str); + const auto header = SerializeHeader::readFrom(str); + assertEq(header.version, + Binio::VERSION_0_0_1_0, + "Header: version " + header.versionString() + + " not supported"); - // Get the scale - context.scale = read_raw_double(str); - - IndexSet smallPrimes; - long smallPrimes_sz = read_raw_int(str); - for (long tmp, i = 0; i < smallPrimes_sz; i++) { - tmp = read_raw_int(str); - smallPrimes.insert(tmp); - } + bool eyeCatcherFound = readEyeCatcher(str, EyeCatcher::CONTEXT_BEGIN); + assertTrue(eyeCatcherFound, + "Could not find pre-context eye catcher"); - IndexSet specialPrimes; - long specialPrimes_sz = read_raw_int(str); - for (long tmp, i = 0; i < specialPrimes_sz; i++) { - tmp = read_raw_int(str); - specialPrimes.insert(tmp); - } + Context::SerializableContent context_params; + context_params.p = read_raw_int(str); + context_params.r = read_raw_int(str); + context_params.m = read_raw_int(str); - context.moduli.clear(); - context.smallPrimes.clear(); - context.specialPrimes.clear(); - context.ctxtPrimes.clear(); + // Number of gens and ords saved in front of vectors + read_raw_vector(str, context_params.gens); + read_raw_vector(str, context_params.ords); - long nPrimes = read_raw_int(str); + // Get the standard deviation + context_params.stdev = read_raw_xdouble(str); - for (long p, i = 0; i < nPrimes; i++) { - p = read_raw_int(str); + // Get the scale + context_params.scale = read_raw_double(str); - context.moduli.push_back(Cmodulus(context.zMStar, p, 0)); + context_params.smallPrimes = IndexSet::readFrom(str); + context_params.specialPrimes = IndexSet::readFrom(str); - if (smallPrimes.contains(i)) - context.smallPrimes.insert(i); // small prime - else if (specialPrimes.contains(i)) - context.specialPrimes.insert(i); // special prime - else - context.ctxtPrimes.insert(i); // ciphertext prime - } + read_raw_vector(str, context_params.qs); long nDigits = read_raw_int(str); + context_params.digits.reserve(nDigits); - context.digits.resize(nDigits); - for (long i = 0; i < (long)context.digits.size(); i++) { - long sizeOfS = read_raw_int(str); - - for (long tmp, n = 0; n < sizeOfS; n++) { - tmp = read_raw_int(str); - context.digits[i].insert(tmp); - } + for (long i = 0; i < (long)nDigits; i++) { + context_params.digits.emplace_back(IndexSet::readFrom(str)); } - context.hwt_param = read_raw_int(str); - context.e_param = read_raw_int(str); - context.ePrime_param = read_raw_int(str); - - endBuildModChain(context); + context_params.hwt_param = read_raw_int(str); + context_params.e_param = read_raw_int(str); + context_params.ePrime_param = read_raw_int(str); // Read in the partition of m into co-prime factors (if bootstrappable) - NTL::Vec mv; - read_ntl_vec_long(str, mv); + read_ntl_vec_long(str, context_params.mvec); - if (mv.length() > 0) { - context.enableBootStrapping(mv); - // VJS-FIXME: what about the build_cache and alsoThick params? - } + context_params.build_cache = read_raw_int(str); + context_params.alsoThick = read_raw_int(str); + + eyeCatcherFound = readEyeCatcher(str, EyeCatcher::CONTEXT_END); + assertTrue(eyeCatcherFound, + "Could not find post-context eye catcher"); - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CONTEXT_END); - assertEq(eyeCatcherFound, 0, "Could not find post-context eye catcher"); + return context_params; } -void writeContextBase(std::ostream& str, const Context& context) +Context Context::readFrom(std::istream& str) { - str << "[" << context.zMStar.getM() << " " << context.zMStar.getP() << " " - << context.alMod.getR() << " ["; - for (long i = 0; i < (long)context.zMStar.numOfGens(); i++) { - str << context.zMStar.ZmStarGen(i) - << ((i == (long)context.zMStar.numOfGens() - 1) ? "]" : " "); - } - str << " ["; - for (long i = 0; i < (long)context.zMStar.numOfGens(); i++) { - long ord = context.zMStar.OrderOf(i); - if (context.zMStar.SameOrd(i)) - str << ord; - else - str << (-ord); - if (i < (long)context.zMStar.numOfGens() - 1) - str << ' '; - } - str << "]]"; + return Context(readParamsFrom(str)); } -std::ostream& operator<<(std::ostream& str, const Context& context) +Context* Context::readPtrFrom(std::istream& str) { - str << "[\n"; - - // standard-deviation - str << context.stdev << "\n"; - - // scale - str << context.scale << "\n"; - - // the "small" index - str << context.smallPrimes << "\n "; - - // the "special" index - str << context.specialPrimes << "\n "; - - // output the primes in the chain - str << context.moduli.size() << "\n"; - for (long i = 0; i < (long)context.moduli.size(); i++) - str << context.moduli[i].getQ() << " "; - str << "\n "; - - // output the digits - str << context.digits.size() << "\n"; - for (long i = 0; i < (long)context.digits.size(); i++) - str << context.digits[i] << " "; - - str << "\n"; - - str << context.hwt_param << " "; - str << context.e_param << " "; - str << context.ePrime_param << "\n"; - - str << context.rcData.mvec; - str << " " << context.rcData.build_cache; - - str << "]\n"; - - return str; + return new Context(readParamsFrom(str)); } -void readContextBase(std::istream& str, - unsigned long& m, - unsigned long& p, - unsigned long& r, - std::vector& gens, - std::vector& ords) +Context::SerializableContent Context::readParamsFromJSON( + const JsonWrapper& jwrap) { - // Advance str beyond first '[' - seekPastChar(str, '['); // this function is defined in NumbTh.cpp - - str >> m >> p >> r; - str >> gens; - str >> ords; - - seekPastChar(str, ']'); + auto body = [&]() { + const json j = fromTypedJson(unwrap(jwrap)); + + Context::SerializableContent content; + + // This way stops ordering inconsistencies + content.m = j.at("m"); + content.p = j.at("p"); + content.r = j.at("r"); + content.gens = j.at("gens").get>(); + content.ords = j.at("ords").get>(); + content.stdev = j.at("stdev").get(); + content.scale = j.at("scale"); + content.smallPrimes = IndexSet::readFromJSON(wrap(j.at("smallPrimes"))); + content.specialPrimes = IndexSet::readFromJSON(wrap(j.at("specialPrimes"))); + content.qs = j.at("qs").get>(); + content.digits = readVectorFromJSON(j.at("digits")); + content.hwt_param = j.at("hwt_param"); + content.e_param = j.at("e_param"); + content.ePrime_param = j.at("ePrime_param"); + content.mvec = j.at("mvec"); + content.build_cache = j.at("build_cache"); + content.alsoThick = j.at("alsoThick"); + + return content; + }; + + return executeRedirectJsonError(body); } -std::unique_ptr buildContextFromAscii(std::istream& str) +Context Context::readFromJSON(std::istream& is) { - unsigned long m, p, r; - std::vector gens, ords; - readContextBase(str, m, p, r, gens, ords); - return std::unique_ptr(new Context(m, p, r, gens, ords)); + return executeRedirectJsonError([&]() { + json j; + is >> j; + return Context::readFromJSON(wrap(j)); + }); } -std::istream& operator>>(std::istream& str, Context& context) +Context Context::readFromJSON(const JsonWrapper& jw) { - seekPastChar(str, '['); // this function is defined in NumbTh.cpp - - // Get the standard deviation - str >> context.stdev; - - // Get the scale - str >> context.scale; - - IndexSet smallPrimes; - str >> smallPrimes; - - IndexSet specialPrimes; - str >> specialPrimes; - - context.moduli.clear(); - context.smallPrimes.clear(); - context.specialPrimes.clear(); - context.ctxtPrimes.clear(); + return Context(readParamsFromJSON(jw)); +} - long nPrimes; - str >> nPrimes; - for (long i = 0; i < nPrimes; i++) { - long p; - str >> p; +Context* Context::readPtrFromJSON(std::istream& is) +{ + return executeRedirectJsonError([&]() { + json j; + is >> j; + return new Context(readParamsFromJSON(wrap(j))); + }); +} - context.moduli.push_back(Cmodulus(context.zMStar, p, 0)); +JsonWrapper Context::writeToJSON() const +{ + std::function body = [this]() { + std::vector gens(this->zMStar.numOfGens()); + // There aren't simple getters to get the gens and ords vectors + for (long i = 0; i < this->zMStar.numOfGens(); i++) { + gens[i] = this->zMStar.ZmStarGen(i); + } - if (smallPrimes.contains(i)) - context.smallPrimes.insert(i); // small prime - else if (specialPrimes.contains(i)) - context.specialPrimes.insert(i); // special prime - else - context.ctxtPrimes.insert(i); // ciphertext prime - } + std::vector ords(this->zMStar.numOfGens()); + // Bad dimensions are represented as a negated ord + for (long i = 0; i < this->zMStar.numOfGens(); i++) { + if (this->zMStar.SameOrd(i)) + ords[i] = this->zMStar.OrderOf(i); + else + ords[i] = -this->zMStar.OrderOf(i); + } - // read in the partition to digits - long nDigits; - str >> nDigits; - context.digits.resize(nDigits); - for (long i = 0; i < (long)context.digits.size(); i++) - str >> context.digits[i]; + // output the primes in the chain + std::vector qs; + qs.reserve(this->moduli.size()); + for (const auto& modulo : this->moduli) { + qs.emplace_back(modulo.getQ()); + } - str >> context.hwt_param; - str >> context.e_param; - str >> context.ePrime_param; + // m + // p + // r + // gens + // ords + // stdev + // scale + json j = {{"m", this->zMStar.getM()}, + {"p", this->zMStar.getP()}, + {"r", this->alMod.getR()}, + {"gens", gens}, + {"ords", ords}, + {"stdev", this->stdev}, + {"scale", this->scale}, + {"smallPrimes", unwrap(this->smallPrimes.writeToJSON())}, + {"specialPrimes", unwrap(this->specialPrimes.writeToJSON())}, + {"qs", qs}, + {"digits", writeVectorToJSON(this->digits)}, + {"hwt_param", this->hwt_param}, + {"e_param", this->e_param}, + {"ePrime_param", this->ePrime_param}, + {"mvec", this->rcData.mvec}, + {"build_cache", this->rcData.build_cache}, + {"alsoThick", this->rcData.alsoThick}}; + return wrap(toTypedJson(j)); + }; + + return executeRedirectJsonError(body); +} // namespace helib - endBuildModChain(context); +void Context::writeToJSON(std::ostream& os) const +{ + // We need to wrap as this->writeToJSON() returns a JsonWrapper, so os << js + // may throw a json-related exception + return executeRedirectJsonError( + [&, this]() { os << this->writeToJSON(); }); +} - // Read in the partition of m into co-prime factors (if bootstrappable) - NTL::Vec mv; - int build_cache; - str >> mv; - str >> build_cache; - if (mv.length() > 0) { - context.enableBootStrapping(mv, build_cache); - // VJS-FIXME: what about alsoThick? why is this different - // than the binary case?? - } - seekPastChar(str, ']'); - return str; +std::ostream& operator<<(std::ostream& os, const Context& context) +{ + context.writeToJSON(os); + return os; } NTL::ZZX getG(const EncryptedArray& ea) @@ -663,13 +747,15 @@ Context::Context(long m, Context(m, p, r, gens, ords) { if (mparams) { - ::helib::buildModChain(*this, - mparams->bits, - mparams->c, - mparams->bootstrappableFlag, - mparams->skHwt, - mparams->resolution, - mparams->bitsInSpecialPrimes); + this->stdev = mparams->stdev; + this->scale = mparams->scale; + + this->buildModChain(mparams->bits, + mparams->c, + mparams->bootstrappableFlag, + mparams->skHwt, + mparams->resolution, + mparams->bitsInSpecialPrimes); if (mparams->bootstrappableFlag && bparams) { this->enableBootStrapping(bparams->mvec, @@ -679,27 +765,445 @@ Context::Context(long m, } } +Context::Context(const SerializableContent& content) : + Context(content.m, content.p, content.r, content.gens, content.ords) +{ + this->stdev = content.stdev; + this->scale = content.scale; + this->digits = content.digits; + this->hwt_param = content.hwt_param; + this->e_param = content.e_param; + this->ePrime_param = content.ePrime_param; + + for (long i = 0; i < lsize(content.qs); i++) { + long q = content.qs[i]; + + this->moduli.emplace_back(this->zMStar, q, 0); + + // FIXME: Consider serializing all 3 sets and setting them directly. + if (content.smallPrimes.contains(i)) + this->smallPrimes.insert(i); // small prime + else if (content.specialPrimes.contains(i)) + this->specialPrimes.insert(i); // special prime + else + this->ctxtPrimes.insert(i); // ciphertext prime + } + + endBuildModChain(); + + // Read in the partition of m into co-prime factors (if bootstrappable) + if (content.mvec.length() > 0) { + // VJS-FIXME: what about the build_cache and alsoThick params? + this->enableBootStrapping(content.mvec, + content.build_cache, + content.alsoThick); + } +} + +static void CheckPrimes(const Context& context, + const IndexSet& s, + const char* name) +{ + for (long i : s) { + NTL::zz_pPush push; + context.ithModulus(i).restoreModulus(); + if (!NTL::zz_p::IsFFTPrime()) { + Warning(__func__ + std::string(": non-FFT prime in ") + name); + } + } +} + +// Add small primes to get target resolution +// FIXME: there is some black magic here. +// we need to better document the strategy. +void Context::addSmallPrimes(long resolution, long cpSize) +{ + // cpSize is the size of the ciphertext primes + // Sanity-checks, cpSize \in [0.9*NTL_SP_NBITS, NTL_SP_NBITS] + assertTrue(cpSize >= 30, "cpSize is too small (minimum is 30)"); + assertInRange(cpSize * 10, + 9l * NTL_SP_NBITS, + 10l * NTL_SP_NBITS, + "cpSize not in [0.9*NTL_SP_NBITS, NTL_SP_NBITS]", + true); + + long m = getM(); + if (m <= 0 || m > (1 << 20)) // sanity checks + throw RuntimeError("addSmallPrimes: m undefined or larger than 2^20"); + // NOTE: Below we are ensured that 16m*log(m) << NTL_SP_BOUND + + if (resolution < 1 || resolution > 10) // set to default of 3-bit resolution + resolution = 3; + + std::vector sizes; + long smallest; // size of the smallest of the smallPrimes + // We need at least two of this size, maybe three + + if (cpSize >= 54) + smallest = divc(2 * cpSize, 3); + else if (cpSize >= 45) + smallest = divc(7 * cpSize, 10); + else { // Make the smallest ones at least 22-bit primes + smallest = divc(11 * cpSize, 15); + sizes.push_back(smallest); // need three of them + } + sizes.push_back(smallest); + sizes.push_back(smallest); + + // This ensures we can express everything to given resolution. + + // use sizes cpSize-r, cpSize-2r, cpSize-4r,... down to the sizes above + for (long delta = resolution; cpSize - delta > smallest; delta *= 2) + sizes.push_back(cpSize - delta); + + // This helps to minimize the number of small primes needed + // to express any particular resolution. + // This could be removed...need to experiment. + + // Special cases: add also cpSize-3*resolution, + // and for resolution=1 also cpSize-11 + if (cpSize - 3 * resolution > smallest) + sizes.push_back(cpSize - 3 * resolution); + if (resolution == 1 && cpSize - 11 > smallest) + sizes.push_back(cpSize - 11); + + std::sort(sizes.begin(), sizes.end()); // order by size + + long last_sz = 0; + std::unique_ptr gen; + for (long sz : sizes) { + if (sz != last_sz) + gen.reset(new PrimeGenerator(sz, m)); + long q = gen->next(); + addSmallPrime(q); + last_sz = sz; + } +} + +void Context::addCtxtPrime(long q) +{ + assertFalse(inChain(q), "Prime q is already in the prime chain"); + long i = moduli.size(); // The index of the new prime in the list + moduli.push_back(Cmodulus(zMStar, q, 0)); + ctxtPrimes.insert(i); +} + +void Context::addSpecialPrime(long q) +{ + assertFalse(inChain(q), "Special prime q is already in the prime chain"); + long i = moduli.size(); // The index of the new prime in the list + moduli.push_back(Cmodulus(zMStar, q, 0)); + specialPrimes.insert(i); +} + +// Determine the target size of the ctxtPrimes. The target size is +// set at 2^n, where n is at most NTL_SP_NBITS and at least +// ceil(0.9*NTL_SP_NBITS), so that we don't overshoot nBits by too +// much. +// The reason that we do not allow to go below 0.9*NTL_SP_NBITS is +// that we need some of the smallPrimes to be sufficiently smaller +// than the ctxtPrimes, and still we need these smallPrimes to have +// m'th roots of unity. +static long ctxtPrimeSize(long nBits) +{ + double bit_loss = + -std::log1p(-1.0 / double(1L << PrimeGenerator::B)) / std::log(2.0); + // std::cerr << "*** bit_loss=" << bit_loss; + + // How many primes of size NTL_SP_NBITS it takes to get to nBits + double maxPsize = NTL_SP_NBITS - bit_loss; + // primes of length len are guaranteed to be at least (1-1/2^B)*2^len, + + long nPrimes = long(ceil(nBits / maxPsize)); + // this is sufficiently many primes + + // now we want to trim the size to avoid unnecssary overshooting + // so we decrease targetSize, while guaranteeing that + // nPrimes primes of length targetSize multiply out to + // at least nBits bits. + + long targetSize = NTL_SP_NBITS; + while (10 * (targetSize - 1) >= 9 * NTL_SP_NBITS && (targetSize - 1) >= 30 && + ((targetSize - 1) - bit_loss) * nPrimes >= nBits) + targetSize--; + + if (((targetSize - 1) - bit_loss) * nPrimes >= nBits) + Warning(__func__ + std::string(": non-optimal targetSize")); + + return targetSize; +} + +void Context::addCtxtPrimes(long nBits, long targetSize) +{ + // We add enough primes of size targetSize until their product is + // at least 2^{nBits} + + // Sanity-checks, targetSize \in [0.9*NTL_SP_NBITS, NTL_SP_NBITS] + assertTrue(targetSize >= 30, + "Target prime is too small (minimum size is 30)"); + assertInRange(targetSize * 10, + 9l * NTL_SP_NBITS, + 10l * NTL_SP_NBITS, + "targetSize not in [0.9*NTL_SP_NBITS, NTL_SP_NBITS]", + true); + const PAlgebra& palg = getZMStar(); + long m = palg.getM(); + + PrimeGenerator gen(targetSize, m); + double bitlen = 0; // how many bits we already have + while (bitlen < nBits - 0.5) { + long q = gen.next(); // generate the next prime + addCtxtPrime(q); // add it to the list + bitlen += std::log2(q); + } + + // std::cerr << "*** ctxtPrimes excess: " << (bitlen - nBits) << "\n"; + HELIB_STATS_UPDATE("excess-ctxtPrimes", bitlen - nBits); +} + +void Context::addSpecialPrimes(long nDgts, + bool willBeBootstrappable, + long bitsInSpecialPrimes) +{ + const PAlgebra& palg = getZMStar(); + long p = std::abs(palg.getP()); // for CKKS, palg.getP() == -1 + long m = palg.getM(); + long phim = palg.getPhiM(); + long p2r = isCKKS() ? 1 : getAlMod().getPPowR(); + + long p2e = p2r; + if (willBeBootstrappable && !isCKKS()) { + // bigger p^e for bootstrapping + long e, ePrime; + RecryptData::setAE(e, ePrime, *this); + p2e *= NTL::power_long(p, e - ePrime); + + // initialize e and ePrime parameters in the context + this->e_param = e; + this->ePrime_param = ePrime; + } + + long nCtxtPrimes = getCtxtPrimes().card(); + if (nDgts > nCtxtPrimes) + nDgts = nCtxtPrimes; // sanity checks + if (nDgts <= 0) + nDgts = 1; + + digits.resize(nDgts); // allocate space + + if (nDgts > 1) { // we break ciphertext into a few digits when key-switching + // NOTE: The code below assumes that all the ctxtPrimes have roughly the + // same size + + IndexSet remaining = getCtxtPrimes(); + for (long dgt = 0; dgt < nDgts - 1; dgt++) { + long digitCard = divc(remaining.card(), nDgts - dgt); + // ceiling(#-of-remaining-primes, #-or-remaining-digits) + + for (long i : remaining) { + digits[dgt].insert(i); + if (digits[dgt].card() >= digitCard) + break; + } + remaining.remove(digits[dgt]); // update the remaining set + } + // The last digit has everything else + if (empty(remaining)) { // sanity check, use one less digit + nDgts--; + digits.resize(nDgts); + } else + digits[nDgts - 1] = remaining; + } else { // only one digit + digits[0] = getCtxtPrimes(); + } + + double maxDigitLog = 0.0; + for (auto& digit : digits) { + double size = logOfProduct(digit); + if (size > maxDigitLog) + maxDigitLog = size; + } + + // Add special primes to the chain for the P factor of key-switching + double nBits; + + if (bitsInSpecialPrimes) + nBits = bitsInSpecialPrimes; + else { +#if 0 + nBits = (maxDigitLog + std::log(nDgts) + NTL::log(stdev * 2) + + std::log(p2e)) / + std::log(2.0); + // FIXME: Victor says: the above calculation does not make much sense to me +#else + double h; + if (getHwt() == 0) + h = phim / 2.0; + else + h = getHwt(); + + double log_phim = std::log(phim); + if (log_phim < 1) + log_phim = 1; + + if (isCKKS()) { + // This is based on a smaller noise estimate so as + // to better protect precision...this is based on + // a noise level equal to the mod switch added noise. + // Note that the relin_CKKS_adjust function in Ctxt.cpp + // depends on this estimate. + nBits = (maxDigitLog + NTL::log(getStdev()) + std::log(nDgts) - + 0.5 * std::log(h)) / + std::log(2.0); + } else if (palg.getPow2()) { + nBits = (maxDigitLog + std::log(p2e) + NTL::log(getStdev()) + + 0.5 * std::log(12.0) + std::log(nDgts) - + 0.5 * std::log(log_phim) - 2 * std::log(p) - std::log(h)) / + std::log(2.0); + } else { + nBits = + (maxDigitLog + std::log(m) + std::log(p2e) + NTL::log(getStdev()) + + 0.5 * std::log(12.0) + std::log(nDgts) - 0.5 * log_phim - + 0.5 * std::log(log_phim) - 2 * std::log(p) - std::log(h)) / + std::log(2.0); + } + + // Both of the above over-estimate nBits by a factor of + // log2(scale). That should provide a sufficient safety margin. + // See design document + +#endif + } + + if (nBits < 1) + nBits = 1; + + double bit_loss = + -std::log1p(-1.0 / double(1L << PrimeGenerator::B)) / std::log(2.0); + + // How many primes of size NTL_SP_NBITS it takes to get to nBits + double maxPsize = NTL_SP_NBITS - bit_loss; + // primes of length len are guaranteed to be at least (1-1/2^B)*2^len, + + long nPrimes = long(ceil(nBits / maxPsize)); + // this is sufficiently many prime + + // now we want to trim the size to avoid unnecssary overshooting + // so we decrease targetSize, while guaranteeing that + // nPrimes primes of length targetSize multiply out to + // at least nBits bits. + + long targetSize = NTL_SP_NBITS; + while ((targetSize - 1) >= 0.55 * NTL_SP_NBITS && (targetSize - 1) >= 30 && + ((targetSize - 1) - bit_loss) * nPrimes >= nBits) + targetSize--; + + if (((targetSize - 1) - bit_loss) * nPrimes >= nBits) + Warning(__func__ + std::string(": non-optimal targetSize")); + + PrimeGenerator gen(targetSize, m); + + while (nPrimes > 0) { + long q = gen.next(); + + if (inChain(q)) + continue; + // nbits could equal NTL_SP_BITS or the size of one + // of the small primes, so we have to check for duplicates here... + // this is not the most efficient way to do this, + // but it doesn't make sense to optimize this any further + + addSpecialPrime(q); + nPrimes--; + } + + // std::cerr << "*** specialPrimes excess: " << + // (logOfProduct(specialPrimes)/std::log(2.0) - nBits) << + // "\n"; + HELIB_STATS_UPDATE("excess-specialPrimes", + logOfProduct(getSpecialPrimes()) / std::log(2.0) - nBits); +} + +void Context::buildModChain(long nBits, + long nDgts, + bool willBeBootstrappable, + long skHwt, + long resolution, + long bitsInSpecialPrimes) +{ + // Cannot build modulus chain with nBits < 0 + assertTrue(nBits > 0, + "Cannot initialise modulus chain with nBits < 1"); + + assertTrue(skHwt >= 0, "invalid skHwt parameter"); + + // ignore for CKKS + if (isCKKS()) + willBeBootstrappable = false; + + if (skHwt == 0) { + // default skHwt: if bootstrapping, set to BOOT_DFLT_SK_HWT + if (willBeBootstrappable) + skHwt = BOOT_DFLT_SK_HWT; + } + + // initialize hwt param in context + hwt_param = skHwt; + + long pSize = ctxtPrimeSize(nBits); + addSmallPrimes(resolution, pSize); + addCtxtPrimes(nBits, pSize); + addSpecialPrimes(nDgts, willBeBootstrappable, bitsInSpecialPrimes); + + CheckPrimes(*this, smallPrimes, "smallPrimes"); + CheckPrimes(*this, ctxtPrimes, "ctxtPrimes"); + CheckPrimes(*this, specialPrimes, "specialPrimes"); + + endBuildModChain(); +} + +void Context::addSmallPrime(long q) +{ + assertFalse(inChain(q), "Small prime q is already in the prime chain"); + long i = moduli.size(); // The index of the new prime in the list + moduli.push_back(Cmodulus(zMStar, q, 0)); + smallPrimes.insert(i); +} + +void Context::endBuildModChain() +{ + setModSizeTable(); + long m = getM(); + std::vector mvec; + pp_factorize(mvec, m); + NTL::Vec mmvec; + convert(mmvec, mvec); + pwfl_converter = std::make_shared(*this, mmvec); +} + // Helper for the build and buildPtr methods template const std::pair, std::optional> ContextBuilder::makeParamsArgs() const { - const auto mparams = buildModChainFlag_ - ? std::make_optional({ - bits_, - c_, - bootstrappableFlag_, - skHwt_, - resolution_, - bitsInSpecialPrimes_, - }) - : std::nullopt; + const auto mparams = + buildModChainFlag_ + ? std::make_optional({bits_, + c_, + bootstrappableFlag_, + skHwt_, + resolution_, + bitsInSpecialPrimes_, + stdev_, + scale_}) + : std::nullopt; const auto bparams = bootstrappableFlag_ ? std::make_optional( {mvec_, buildCacheFlag_, thickFlag_}) : std::nullopt; + return {mparams, bparams}; } @@ -717,48 +1221,45 @@ Context* ContextBuilder::buildPtr() const return new Context(m_, p_, r_, gens_, ords_, mparams, bparams); } +// Essentially serialization of params. template <> std::ostream& operator<<(std::ostream& os, const ContextBuilder& cb) { - os << "{\n" - << " scheme: BGV\n" - << " m: " << cb.m_ << "\n" - << " p: " << cb.p_ << "\n" - << " r: " << cb.r_ << "\n" - << " c: " << cb.c_ << "\n" - << " gens: " << vecToStr(cb.gens_) << "\n" - << " ords: " << vecToStr(cb.ords_) << "\n" - << " buildModChainFlag: " << cb.buildModChainFlag_ << "\n" - << " bits: " << cb.bits_ << "\n" - << " skHwt: " << cb.skHwt_ << "\n" - << " resolution: " << cb.resolution_ << "\n" - << " bitsInSpecialPrimes: " << cb.bitsInSpecialPrimes_ << "\n" - << " bootstrappableFlag: " << cb.bootstrappableFlag_ << "\n" - << " mvec: " << cb.mvec_ << "\n" - << " buildCacheFlag: " << cb.buildCacheFlag_ << "\n" - << " thickFlag: " << cb.thickFlag_ << "\n" - << "}" << std::endl; - + const json j = {{"scheme", "bgv"}, + {"m", cb.m_}, + {"p", cb.p_}, + {"r", cb.r_}, + {"c", cb.c_}, + {"gens", cb.gens_}, + {"ords", cb.ords_}, + {"buildModChainFlag", cb.buildModChainFlag_}, + {"bits", cb.bits_}, + {"skHwt", cb.skHwt_}, + {"resolution", cb.resolution_}, + {"bitsInSpecialPrimes", cb.bitsInSpecialPrimes_}, + {"bootstrappableFlag", cb.bootstrappableFlag_}, + {"mvec", cb.mvec_}, + {"buildCacheFlag", cb.buildCacheFlag_}, + {"thickFlag", cb.thickFlag_}}; + os << toTypedJson>(j); return os; } template <> std::ostream& operator<<(std::ostream& os, const ContextBuilder& cb) { - os << "{\n" - << " scheme: CKKS\n" - << " m: " << cb.m_ << ",\n" - << " precision: " << cb.r_ << ",\n" - << " c: " << cb.c_ << ",\n" - << " gens: " << vecToStr(cb.gens_) << ",\n" - << " ords: " << vecToStr(cb.ords_) << ",\n" - << " buildModChainFlag: " << cb.buildModChainFlag_ << ",\n" - << " bits: " << cb.bits_ << ",\n" - << " skHwt: " << cb.skHwt_ << ",\n" - << " resolution: " << cb.resolution_ << ",\n" - << " bitsInSpecialPrimes: " << cb.bitsInSpecialPrimes_ << "\n" - << "}" << std::endl; - + const json j = {{"scheme", "ckks"}, + {"m", cb.m_}, + {"precision", cb.r_}, + {"c", cb.c_}, + {"gens", cb.gens_}, + {"ords", cb.ords_}, + {"buildModChainFlag", cb.buildModChainFlag_}, + {"bits", cb.bits_}, + {"skHwt", cb.skHwt_}, + {"resolution", cb.resolution_}, + {"bitsInSpecialPrimes", cb.bitsInSpecialPrimes_}}; + os << toTypedJson>(j); return os; } diff --git a/src/Ctxt.cpp b/src/Ctxt.cpp index 97135133d..cad69fc88 100644 --- a/src/Ctxt.cpp +++ b/src/Ctxt.cpp @@ -12,7 +12,9 @@ #include #include -#include +#include "io.h" +#include "binio.h" + #include #include #include @@ -35,18 +37,62 @@ namespace helib { extern int fhe_watcher; static const double safety = 1 * log(2.0); // 1 bits of safety -void SKHandle::read(std::istream& str) +SKHandle SKHandle::readFrom(std::istream& str) +{ + long newPowerOfS = read_raw_int(str); + long newPowerOfX = read_raw_int(str); + long newSecretKeyID = read_raw_int(str); + return SKHandle(newPowerOfS, newPowerOfX, newSecretKeyID); +} + +void SKHandle::writeTo(std::ostream& str) const +{ + write_raw_int(str, this->powerOfS); + write_raw_int(str, this->powerOfX); + write_raw_int(str, this->secretKeyID); +} + +void SKHandle::writeToJSON(std::ostream& str) const { - powerOfS = read_raw_int(str); - powerOfX = read_raw_int(str); - secretKeyID = read_raw_int(str); + str << this->writeToJSON(); } -void SKHandle::write(std::ostream& str) const +JsonWrapper SKHandle::writeToJSON() const { - write_raw_int(str, powerOfS); - write_raw_int(str, powerOfX); - write_raw_int(str, secretKeyID); + json j = {{"powerOfS", this->powerOfS}, + {"powerOfX", this->powerOfX}, + {"secretKeyID", this->secretKeyID}}; + + return wrap(j); +} + +SKHandle SKHandle::readFromJSON(std::istream& str) +{ + json j; + str >> j; + return readFromJSON(wrap(j)); +} + +SKHandle SKHandle::readFromJSON(const JsonWrapper& j) +{ + SKHandle ret; + ret.readJSON(j); + return ret; +} + +void SKHandle::readJSON(std::istream& str) +{ + json j; + str >> j; + readJSON(wrap(j)); +} + +void SKHandle::readJSON(const JsonWrapper& jw) +{ + json j = unwrap(jw); + this->powerOfS = j.at("powerOfS"); + this->powerOfX = j.at("powerOfX"); + this->secretKeyID = j.at("secretKeyID"); } // A hack for recording required automorphisms (see NumbTh.h) @@ -58,10 +104,10 @@ bool Ctxt::isCorrect() const NTL::xdouble xQ = NTL::xexp(getContext().logOfProduct(getPrimeSet())); double bnd; - if (DECRYPT_ON_PWFL_BASIS && !getContext().zMStar.getPow2()) - bnd = getContext().zMStar.getNormBnd(); + if (DECRYPT_ON_PWFL_BASIS && !getContext().getZMStar().getPow2()) + bnd = getContext().getZMStar().getNormBnd(); else - bnd = getContext().zMStar.getPolyNormBnd(); + bnd = getContext().getZMStar().getPolyNormBnd(); return totalNoiseBound() * bnd <= 0.48 * xQ; } @@ -73,7 +119,6 @@ bool Ctxt::isCorrect() const void Ctxt::DummyEncrypt(const NTL::ZZX& ptxt, double size) { const Context& context = getContext(); - const PAlgebra& zMStar = context.zMStar; if (isCKKS()) { ptxtSpace = 1; @@ -81,8 +126,8 @@ void Ctxt::DummyEncrypt(const NTL::ZZX& ptxt, double size) if (size < 0) size = 1.0; ptxtMag = size; - ratFactor = context.ea->getCx().encodeScalingFactor() / size; - noiseBound = context.noiseBoundForUniform(0.5, zMStar.getPhiM()); + ratFactor = context.getEA().getCx().encodeScalingFactor() / size; + noiseBound = context.noiseBoundForUniform(0.5, context.getPhiM()); // noiseBound is a bound on the error during encoding, we assume // heuristically that rounding errors are uniform in [-0.5,0.5]. } else { // BGV @@ -90,18 +135,18 @@ void Ctxt::DummyEncrypt(const NTL::ZZX& ptxt, double size) // HEURISTIC: we assume that we can safely model the coefficients // of ptxt as uniformly and independently distributed over // [-magBound, magBound], where magBound = ptxtSpace/2 - noiseBound = context.noiseBoundForMod(ptxtSpace, zMStar.getPhiM()); + noiseBound = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); } else noiseBound = size; } - primeSet = context.ctxtPrimes; + primeSet = context.getCtxtPrimes(); // A single part, with the plaintext as data and handle pointing to 1 - long f = isCKKS() - ? 1 - : rem(context.productOfPrimes(context.ctxtPrimes), ptxtSpace); + long f = isCKKS() ? 1 + : rem(context.productOfPrimes(context.getCtxtPrimes()), + ptxtSpace); if (f == 1) { DoubleCRT dcrt(ptxt, context, primeSet); parts.assign(1, CtxtPart(dcrt)); @@ -117,11 +162,12 @@ void Ctxt::DummyEncrypt(const NTL::ZZX& ptxt, double size) // contains either all the special primes or none of them bool Ctxt::verifyPrimeSet() const { - IndexSet s = primeSet & context.specialPrimes; // special primes in primeSet - if (!empty(s) && s != context.specialPrimes) + IndexSet s = + primeSet & context.getSpecialPrimes(); // special primes in primeSet + if (!empty(s) && s != context.getSpecialPrimes()) return false; - s = primeSet & context.ctxtPrimes; // ctxt primes in primeSet + s = primeSet & context.getCtxtPrimes(); // ctxt primes in primeSet return s.isInterval(); } @@ -133,7 +179,7 @@ void Ctxt::keySwitchDigits(const KeySwitch& W, std::vector& digits) // with the maximum number of levels, else the PRG will go out of sync. // FIXME: This is a bug waiting to happen. - DoubleCRT ai(context, context.ctxtPrimes | context.specialPrimes); + DoubleCRT ai(context, context.getCtxtPrimes() | context.getSpecialPrimes()); // Subsequent ai's use the evolving RNG state RandomState state; // backup the NTL PRG seed @@ -228,7 +274,7 @@ Ctxt::Ctxt(const PubKey& newPubKey, long newPtxtSpace) : assertTrue(NTL::GCD(ptxtSpace, pubKey.getPtxtSpace()) > 1, "Ptxt spaces from ciphertext and public key are coprime"); } - primeSet = context.ctxtPrimes; + primeSet = context.getCtxtPrimes(); intFactor = 1; ratFactor = ptxtMag = 1.0; } @@ -242,7 +288,7 @@ Ctxt::Ctxt(ZeroCtxtLike_type, const Ctxt& ctxt) : { // VJS-FIXME: should we set primeSet = ctxt.primeSet instead? // It probably does not matter - primeSet = context.ctxtPrimes; + primeSet = context.getCtxtPrimes(); intFactor = 1; ratFactor = ptxtMag = 1.0; } @@ -319,7 +365,7 @@ void Ctxt::bringToSet(const IndexSet& s) } if (empty(s)) { // If empty, use a singleton with 1st ctxt prime - IndexSet tmp(getContext().ctxtPrimes.first()); + IndexSet tmp(getContext().getCtxtPrimes().first()); modUpToSet(tmp); modDownToSet(tmp); } else { @@ -437,11 +483,11 @@ void Ctxt::modDownToSet(const IndexSet& s) norms[2 * i + 1], fdeltas[2 * i], fdeltas[2 * i + 1], - context.zMStar); + context.getZMStar()); } if (nparts % 2) { norms[nparts - 1] = - embeddingLargestCoeff(fdeltas[nparts - 1], context.zMStar); + embeddingLargestCoeff(fdeltas[nparts - 1], context.getZMStar()); } #else for (long i : range(nparts)) @@ -528,15 +574,15 @@ void Ctxt::reducePtxtSpace(long newPtxtSpace) // modulus-switching added noise term. void Ctxt::dropSmallAndSpecialPrimes() { - if (primeSet.disjointFrom(context.smallPrimes)) { + if (primeSet.disjointFrom(context.getSmallPrimes())) { // nothing to do except drop the special primes, if any - modDownToSet(context.ctxtPrimes); + modDownToSet(context.getCtxtPrimes()); } else { // we will be dropping some smallPrimes, and we need to figure // out how much we have to compensate with other ctxtPrimes // The target set contains only the ctxtPrimes, and its size - IndexSet target = primeSet & context.ctxtPrimes; + IndexSet target = primeSet & context.getCtxtPrimes(); // Compute the set of dropped primes and its total size IndexSet dropping = primeSet / target; @@ -560,12 +606,12 @@ void Ctxt::dropSmallAndSpecialPrimes() if (0 && isCKKS()) { // VJS-NOTE: I'm disabling this for now. See comment above // std::cerr << "*** special processing in dropSmallAndSpecialPrimes\n"; - double log_bound = - log_modswitch_noise + log(context.alMod.getPPowR()) - log(ptxtMag); + double log_bound = log_modswitch_noise + + log(context.getAlMod().getPPowR()) - log(ptxtMag); double log_rf = log(getRatFactor()) // log(factor) after scaling + context.logOfProduct(target) - logOfPrimeSet(); if (log_rf < log_bound) { - IndexSet candidates = context.ctxtPrimes / target; + IndexSet candidates = context.getCtxtPrimes() / target; for (long i : candidates) { target.insert(i); log_compensation += context.logOfPrime(i); @@ -587,7 +633,7 @@ void Ctxt::dropSmallAndSpecialPrimes() log_modswitch_noise += 3 * log(2.0); // 3 bits of elbow room if (log_noise - log_dropping + log_compensation < log_modswitch_noise) { - IndexSet candidates = context.ctxtPrimes / target; + IndexSet candidates = context.getCtxtPrimes() / target; for (long i : candidates) { target.insert(i); log_compensation += context.logOfPrime(i); @@ -607,15 +653,14 @@ void Ctxt::relin_CKKS_adjust() // we have to increase the noise if it's too small, // in order to protect against loss of precision - const PAlgebra& palg = context.zMStar; - long phim = palg.getPhiM(); - long k = context.scale; + long phim = context.getPhiM(); + long k = context.getScale(); double h; - if (context.hwt_param == 0) + if (context.getHwt() == 0) h = phim / 2.0; else - h = context.hwt_param; + h = context.getHwt(); double log_phim = std::log(phim); if (log_phim < 1) @@ -687,14 +732,14 @@ void Ctxt::reLinearize(long keyID) relin_CKKS_adjust(); long g = ptxtSpace; - double logProd = context.logOfProduct(context.specialPrimes); + double logProd = context.logOfProduct(context.getSpecialPrimes()); Ctxt tmp(pubKey, ptxtSpace); // an empty ciphertext, same plaintext space tmp.intFactor = intFactor; // same intFactor, too tmp.ptxtMag = ptxtMag; // same CKKS plaintext size tmp.noiseBound = noiseBound * NTL::xexp(logProd); // The noise after mod-up - tmp.primeSet = primeSet | context.specialPrimes; + tmp.primeSet = primeSet | context.getSpecialPrimes(); // VJS-NOTE: added this to make addPart work tmp.ratFactor = ratFactor * NTL::xexp(logProd); // CKKS factor after mod-up @@ -703,7 +748,7 @@ void Ctxt::reLinearize(long keyID) for (CtxtPart& part : parts) { // For a part relative to 1 or base, only scale and add if (part.skHandle.isOne() || part.skHandle.isBase(keyID)) { - part.addPrimesAndScale(context.specialPrimes); + part.addPrimesAndScale(context.getSpecialPrimes()); tmp.addPart(part, /*matchPrimeSet=*/true); continue; } @@ -730,8 +775,8 @@ Ctxt& Ctxt::cleanUp() { reLinearize(); // reduce(); - if (!primeSet.disjointFrom(context.specialPrimes) || - !primeSet.disjointFrom(context.smallPrimes)) { + if (!primeSet.disjointFrom(context.getSpecialPrimes()) || + !primeSet.disjointFrom(context.getSmallPrimes())) { dropSmallAndSpecialPrimes(); } return *this; @@ -749,13 +794,13 @@ void Ctxt::keySwitchPart(const CtxtPart& p, const KeySwitch& W) // no special primes in the input part assertTrue( - context.specialPrimes.disjointFrom(p.getIndexSet()), + context.getSpecialPrimes().disjointFrom(p.getIndexSet()), "Special primes and CtxtPart's index set have non-empty intersection"); // For parts p that point to 1 or s, only scale and add if (p.skHandle.isOne() || p.skHandle.isBase(W.toKeyID)) { CtxtPart pp = p; - pp.addPrimesAndScale(context.specialPrimes); + pp.addPrimesAndScale(context.getSpecialPrimes()); addPart(pp, /*matchPrimeSet=*/true); return; } @@ -848,7 +893,7 @@ void Ctxt::addConstant(const DoubleCRT& dcrt, double size) // that the coefficients are uniformly and independently distributed // over [-ptxtSpace/2, ptxtSpace/2] if (size < 0.0) - size = context.noiseBoundForMod(ptxtSpace, context.zMStar.getPhiM()); + size = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); // Scale the constant, then add it to the part that points to one long f = 1; @@ -878,7 +923,8 @@ void Ctxt::addConstant(const DoubleCRT& dcrt, double size) void Ctxt::addConstant(const NTL::ZZX& poly, double size) { if (size < 0 && !isCKKS()) { - size = NTL::conv(embeddingLargestCoeff(poly, getContext().zMStar)); + size = NTL::conv( + embeddingLargestCoeff(poly, getContext().getZMStar())); } addConstant(DoubleCRT(poly, context, primeSet), size); @@ -898,7 +944,7 @@ void Ctxt::addConstantCKKS(const DoubleCRT& dcrt, size = 1.0; if (factor <= 0) - conv(factor, getContext().ea->getCx().encodeScalingFactor() / size); + conv(factor, getContext().getEA().getCx().encodeScalingFactor() / size); // VJS-NOTE: I think we need to special case an empty ciphertext @@ -917,7 +963,7 @@ void Ctxt::addConstantCKKS(const DoubleCRT& dcrt, #endif // Check if you need to scale up to get target accuracy of 2^{-r} - if ((inaccuracy * getContext().alMod.getPPowR()) > 1.0) { + if ((inaccuracy * getContext().getAlMod().getPPowR()) > 1.0) { Warning("addSomePrimes called in Ctxt::addConstantCKKS(DoubleCRT)"); addSomePrimes(*this); // This increases ratFactor ratio = floor((ratFactor / factor) + 0.5); // re-compute the ratio @@ -1027,7 +1073,7 @@ void Ctxt::addConstantCKKS(const std::vector>& other) // be deprecated in favor of the new EncodedPtxt-based routines NTL::ZZX poly; - double factor = getContext().ea->getCx().encode(poly, other); + double factor = getContext().getEA().getCx().encode(poly, other); // VJS-NOTE: maybe this encdoing routine should also return // the rounding error...we kind of need this value @@ -1070,7 +1116,7 @@ void Ctxt::addConstantCKKS(std::pair num) NTL::xdouble ratio = floor((ratFactor / xb) + 0.5); // round to integer double inaccuracy = std::abs(NTL::conv(ratio * xb / ratFactor) - 1.0); - if ((inaccuracy * getContext().alMod.getPPowR()) > 1.0) { + if ((inaccuracy * getContext().getAlMod().getPPowR()) > 1.0) { Warning("addSomePrimes called in Ctxt::addConstantCKKS(pair"); addSomePrimes(*this); // This increases ratFactor } @@ -1102,20 +1148,20 @@ void addSomePrimes(Ctxt& c) assertNeq(s, context.allPrimes(), "Nothing left to add"); // Add a ctxt prime if possible - if (!s.contains(context.ctxtPrimes)) { - IndexSet delta = context.ctxtPrimes / s; // set minus - long idx = delta.first(); // We know that |delta| >= 1 + if (!s.contains(context.getCtxtPrimes())) { + IndexSet delta = context.getCtxtPrimes() / s; // set minus + long idx = delta.first(); // We know that |delta| >= 1 s.insert(idx); } // else, add a small prime if possible - else if (!s.contains(context.smallPrimes)) { - IndexSet delta = context.smallPrimes / s; // set minus - long idx = delta.first(); // We know that |delta| >= 1 + else if (!s.contains(context.getSmallPrimes())) { + IndexSet delta = context.getSmallPrimes() / s; // set minus + long idx = delta.first(); // We know that |delta| >= 1 s.insert(idx); } else // otherwise, insert all the special primes - s.insert(context.specialPrimes); + s.insert(context.getSpecialPrimes()); c.modUpToSet(s); } @@ -1151,7 +1197,7 @@ void Ctxt::equalizeRationalFactors(Ctxt& c1, Ctxt& c2) NTL::xdouble x = big.ratFactor / small.ratFactor; // std::cerr << "=== equalize: " << x << "\n"; - long r = c1.getContext().getDefaultPrecision(); + long r = c1.getContext().getPrecision(); NTL::ZZ denomBound = NTL::ZZ(1L) << (r + 1); // NOTE: With the new early termination logic, it is very unlikely that // we will ever stop by exceeding denomBound. @@ -1291,7 +1337,7 @@ void Ctxt::equalizeRationalFactors(Ctxt& c1, Ctxt& c2) void Ctxt::equalizeRationalFactors(Ctxt& c1, Ctxt& c2) { // VJS-NOTE: need to rethink this - long targetPrecision = c1.getContext().alMod.getPPowR() * 2; + long targetPrecision = c1.getContext().getAlMod().getPPowR() * 2; Ctxt& big = (c1.ratFactor > c2.ratFactor) ? c1 : c2; Ctxt& small = (c1.ratFactor > c2.ratFactor) ? c2 : c1; NTL::xdouble ratio = big.ratFactor / small.ratFactor; @@ -1396,7 +1442,7 @@ void Ctxt::addCtxt(const Ctxt& other, bool negative) // and I also call it unconditionally, so as to ensure the // noiseBound is actually computed accurately. // if (isCKKS() && !closeToOne(ratFactor / other_pt->ratFactor, - // getContext().alMod.getPPowR() * 2)) { + // getContext().getAlMod().getPPowR() * 2)) { if (isCKKS()) { if (other_pt != &tmp) { tmp = other; @@ -1426,7 +1472,7 @@ void Ctxt::addCtxt(const Ctxt& other, bool negative) long e1_best = r1, e2_best = t1; NTL::xdouble noise_best = NoiseNorm(noise1, noise2, e1_best, e2_best, ptxtSpace); - long p = context.zMStar.getP(); + long p = context.getP(); while (r1 != 0) { long q = r0 / r1; @@ -1607,9 +1653,7 @@ IndexSet Ctxt::naturalPrimeSet() const { double lo, hi; computeIntervalForSqr(lo, hi, *this); - - IndexSet retval = context.modSizes.getSet4Size(lo, hi, primeSet, isCKKS()); - return retval; + return context.getModSizeTable().getSet4Size(lo, hi, primeSet, isCKKS()); } // Low-level multiply routine. It does not include re-linearization. @@ -1668,11 +1712,12 @@ void Ctxt::multLowLvl(const Ctxt& other_orig, bool destructive) // We then compute commonPrimeSet in a way that minimizes // the computational cost of dropping to it - IndexSet commonPrimeSet = context.modSizes.getSet4Size(lo, - hi, - primeSet, - other_pt->primeSet, - isCKKS()); + IndexSet commonPrimeSet = + context.getModSizeTable().getSet4Size(lo, + hi, + primeSet, + other_pt->primeSet, + isCKKS()); // drop the prime sets of *this and other bringToSet(commonPrimeSet); @@ -1779,7 +1824,7 @@ void Ctxt::multByConstant(const DoubleCRT& dcrt, double size) // If the size is not given, we use the default value corresponding // to uniform distribution on [-ptxtSpace/2, ptxtSpace/2]. if (size < 0.0) { - size = context.noiseBoundForMod(ptxtSpace, getContext().zMStar.getPhiM()); + size = context.noiseBoundForMod(ptxtSpace, getContext().getPhiM()); } // multiply all the parts by this constant @@ -1796,7 +1841,8 @@ void Ctxt::multByConstant(const NTL::ZZX& poly, double size) return; if (size < 0 && !isCKKS()) { // VJS-NOTE: should this be done also for CKKS? - size = NTL::conv(embeddingLargestCoeff(poly, getContext().zMStar)); + size = NTL::conv( + embeddingLargestCoeff(poly, getContext().getZMStar())); } DoubleCRT dcrt(poly, context, primeSet); multByConstant(dcrt, size); @@ -1808,7 +1854,7 @@ void Ctxt::multByConstant(const zzX& poly, double size) if (this->isEmpty()) return; if (size < 0 && !isCKKS()) { - size = embeddingLargestCoeff(poly, getContext().zMStar); + size = embeddingLargestCoeff(poly, getContext().getZMStar()); } DoubleCRT dcrt(poly, context, primeSet); multByConstant(dcrt, size); @@ -1821,7 +1867,7 @@ void Ctxt::multByConstantCKKS(const std::vector>& other) // NOTE: some replicated logic here and in addConstantCKKS... NTL::ZZX poly; - double factor = getContext().ea->getCx().encode(poly, other); + double factor = getContext().getEA().getCx().encode(poly, other); // VJS-NOTE: why does encode with ZZX not require a size arg? double size = Norm(other); @@ -1851,10 +1897,10 @@ void Ctxt::multByConstantCKKS(const DoubleCRT& dcrt, size = 1.0; if (factor <= 0) // if not specified, assume default value - factor = getContext().ea->getCx().encodeScalingFactor() / size; + factor = getContext().getEA().getCx().encodeScalingFactor() / size; if (roundingErr < 0) - roundingErr = getContext().ea->getCx().encodeRoundingError(); + roundingErr = getContext().getEA().getCx().encodeRoundingError(); // This statement must come first! noiseBound = noiseBound * factor * size + roundingErr * ratFactor * ptxtMag + @@ -2145,7 +2191,7 @@ void Ctxt::addConstant(const EncodedPtxt_BGV& ptxt, bool neg) balanced_MulMod(poly, poly, f, ptxtSpace); DoubleCRT dcrt(poly, context, primeSet); - NTL::xdouble size = embeddingLargestCoeff(poly, context.zMStar); + NTL::xdouble size = embeddingLargestCoeff(poly, context.getZMStar()); noiseBound += size; @@ -2241,7 +2287,7 @@ void Ctxt::addConstant(NTL::xdouble c, bool neg) // f is to chosen to be of the form 2^k*ratFactor, // where k >= 0 is as small as possible. - long r = context.getDefaultPrecision(); + long r = context.getPrecision(); NTL::xdouble thresh{std::ldexp(1.0, -(r + 1))}; if (thresh < ratFactor / noiseBound) @@ -2347,7 +2393,7 @@ void Ctxt::divideByP() if (this->isEmpty()) return; - long p = getContext().zMStar.getP(); + long p = getContext().getP(); assertEq(ptxtSpace % p, 0l, "p must divide ptxtSpace"); assertTrue(ptxtSpace > p, "ptxtSpace must be strictly greater than p"); @@ -2371,8 +2417,8 @@ void Ctxt::automorph(long k) // Apply automorphism F(X)->F(X^k) (gcd(k,m)=1) return; // Sanity check: verify that k \in Zm* - assertTrue(context.zMStar.inZmStar(k), "k must be in Zm*"); - long m = context.zMStar.getM(); + assertTrue(context.getZMStar().inZmStar(k), "k must be in Zm*"); + long m = context.getM(); // Apply this automorphism to all the parts for (auto& part : parts) { @@ -2399,14 +2445,14 @@ void Ctxt::smartAutomorph(long k) } // Sanity check: verify that k \in Zm* - long m = context.zMStar.getM(); + long m = context.getM(); k = mcMod(k, m); // Special cases if (this->isEmpty() || k == 1) return; - assertTrue(context.zMStar.inZmStar(k), "k must be in Zm*"); + assertTrue(context.getZMStar().inZmStar(k), "k must be in Zm*"); long keyID = getKeyID(); // must have key-switching matrices for it @@ -2442,9 +2488,9 @@ void Ctxt::smartAutomorph(long k) // std::cerr << "\n"; HELIB_TIMER_STOP; } - + // Complex conjugate, same as automorph(m-1) -void Ctxt::complexConj() +void Ctxt::complexConj() { HELIB_TIMER_START; @@ -2461,11 +2507,11 @@ void Ctxt::frobeniusAutomorph(long j) if (isCKKS()) { // For CKKS compute complex conjugate if (j & 1) - smartAutomorph(-1); // If j is even do nothing - } else { // For BGV compute frobenius - long m = context.zMStar.getM(); - long p = context.zMStar.getP(); - long d = context.zMStar.getOrdP(); + complexConj(); // If j is even do nothing + } else { // For BGV compute frobenius + long m = context.getM(); + long p = context.getP(); + long d = context.getOrdP(); j = mcMod(j, d); long val = NTL::PowerMod(p % m, j, m); @@ -2503,15 +2549,17 @@ NTL::xdouble Ctxt::modSwitchAddedNoiseBound() const } } - double roundingNoise = context.noiseBoundForUniform(double(ptxtSpace) / 2.0, - context.zMStar.getPhiM()); + double roundingNoise = + context.noiseBoundForUniform(double(ptxtSpace) / 2.0, + context.getZMStar().getPhiM()); return addedNoise * roundingNoise; } -void Ctxt::write(std::ostream& str) const +void Ctxt::writeTo(std::ostream& str) const { - writeEyeCatcher(str, BINIO_EYE_CTXT_BEGIN); + SerializeHeader().writeTo(str); + writeEyeCatcher(str, EyeCatcher::CTXT_BEGIN); /* Writing out in binary: 1. long ptxtSpace @@ -2525,93 +2573,207 @@ void Ctxt::write(std::ostream& str) const write_raw_xdouble(str, ptxtMag); write_raw_xdouble(str, ratFactor); write_raw_xdouble(str, noiseBound); - primeSet.write(str); + primeSet.writeTo(str); write_raw_vector(str, parts); - writeEyeCatcher(str, BINIO_EYE_CTXT_END); + writeEyeCatcher(str, EyeCatcher::CTXT_END); +} + +Ctxt Ctxt::readFrom(std::istream& str, const PubKey& pubKey) +{ + // We rely here on Ctxt's in place read function. + Ctxt res(pubKey); + res.read(str); + return res; } void Ctxt::read(std::istream& str) { - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CTXT_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-ciphertext eye catcher"); + const auto header = SerializeHeader::readFrom(str); + assertEq(header.version, + Binio::VERSION_0_0_1_0, + "Header: version " + header.versionString() + + " not supported"); + + bool eyeCatcherFound = readEyeCatcher(str, EyeCatcher::CTXT_BEGIN); + assertTrue(eyeCatcherFound, + "Could not find pre-ciphertext eye catcher"); ptxtSpace = read_raw_int(str); intFactor = read_raw_int(str); ptxtMag = read_raw_xdouble(str); ratFactor = read_raw_xdouble(str); noiseBound = read_raw_xdouble(str); - primeSet.read(str); + primeSet = IndexSet::readFrom(str); + // Using inplace parts deserialization as read_raw_vector will do a resize, + // then reads the parts in-place, so may re-use memory. CtxtPart blankCtxtPart(context, IndexSet::emptySet()); read_raw_vector(str, parts, blankCtxtPart); - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_CTXT_END); - assertEq(eyeCatcherFound, 0, "Could not find post-ciphertext eye catcher"); + eyeCatcherFound = readEyeCatcher(str, EyeCatcher::CTXT_END); + assertTrue(eyeCatcherFound, + "Could not find post-ciphertext eye catcher"); +} + +void Ctxt::writeToJSON(std::ostream& str) const +{ + executeRedirectJsonError([&]() { str << writeToJSON(); }); +} + +JsonWrapper Ctxt::writeToJSON() const +{ + auto body = [this]() { + json j = {{"ptxtSpace", this->ptxtSpace}, + {"noiseBound", this->noiseBound}, + {"primeSet", unwrap(this->primeSet.writeToJSON())}, + {"intFactor", this->intFactor}, + {"ptxtMag", this->ptxtMag}, + {"ratFactor", this->ratFactor}, + {"parts", writeVectorToJSON(this->parts)}}; + + return wrap(toTypedJson(j)); + }; + return executeRedirectJsonError(body); +} + +Ctxt Ctxt::readFromJSON(std::istream& str, const PubKey& pubKey) +{ + return executeRedirectJsonError([&]() { + json j; + str >> j; + return Ctxt::readFromJSON(wrap(j), pubKey); + }); +} + +Ctxt Ctxt::readFromJSON(const JsonWrapper& j, const PubKey& pubKey) +{ + Ctxt ret(pubKey); + ret.readJSON(j); + return ret; +} + +void Ctxt::readJSON(std::istream& str) +{ + executeRedirectJsonError([&]() { + json j; + str >> j; + this->readJSON(wrap(j)); + }); } -void CtxtPart::write(std::ostream& str) const +void Ctxt::readJSON(const JsonWrapper& jw) { - this->DoubleCRT::write(str); // CtxtPart is a child. - skHandle.write(str); + auto body = [&]() { + json j = fromTypedJson(unwrap(jw)); + this->ptxtSpace = j.at("ptxtSpace"); + this->intFactor = j.at("intFactor"); + this->ptxtMag = j.at("ptxtMag").get(); + this->ratFactor = j.at("ratFactor").get(); + this->noiseBound = j.at("noiseBound").get(); + this->primeSet = IndexSet::readFromJSON(wrap(j.at("primeSet"))); + // Using inplace parts deserialization as read_raw_vector will do a + // resize, then reads the parts in-place, so may re-use memory. + CtxtPart blankCtxtPart(context, IndexSet::emptySet()); + readVectorFromJSON(j.at("parts"), this->parts, blankCtxtPart); + + // sanity-check + for (const auto& part : this->parts) { + assertEq(part.getIndexSet(), + this->primeSet, + "Ciphertext part's index set does not match prime set"); + } + }; + + executeRedirectJsonError(body); +} + +void CtxtPart::writeTo(std::ostream& str) const +{ + this->DoubleCRT::writeTo(str); // CtxtPart is a child. + skHandle.writeTo(str); +} + +CtxtPart CtxtPart::readFrom(std::istream& str, const Context& context) +{ + CtxtPart ret(DoubleCRT(context, IndexSet::emptySet())); + ret.read(str); + return ret; } void CtxtPart::read(std::istream& str) { this->DoubleCRT::read(str); // CtxtPart is a child. - skHandle.read(str); + skHandle = SKHandle::readFrom(str); +} + +void CtxtPart::writeToJSON(std::ostream& str) const +{ + str << this->writeToJSON(); +} + +JsonWrapper CtxtPart::writeToJSON() const +{ + json j = {{"DoubleCRT", unwrap(this->DoubleCRT::writeToJSON())}, + {"skHandle", unwrap(skHandle.writeToJSON())}}; + return wrap(j); +} + +CtxtPart CtxtPart::readFromJSON(std::istream& str, const Context& context) +{ + json j; + str >> j; + return CtxtPart::readFromJSON(wrap(j), context); +} + +CtxtPart CtxtPart::readFromJSON(const JsonWrapper& j, const Context& context) +{ + CtxtPart ret(DoubleCRT(context, IndexSet::emptySet())); + ret.readJSON(j); + return ret; +} + +void CtxtPart::readJSON(std::istream& str) +{ + json j; + str >> j; + this->readJSON(wrap(j)); +} + +void CtxtPart::readJSON(const JsonWrapper& jw) +{ + json inner = unwrap(jw); + this->DoubleCRT::readJSON( + wrap(inner.at("DoubleCRT"))); // CtxtPart is a child. + this->skHandle = SKHandle::readFromJSON(wrap(inner.at("skHandle"))); } std::istream& operator>>(std::istream& str, SKHandle& handle) { - seekPastChar(str, '['); // defined in NumbTh.cpp - str >> handle.powerOfS; - str >> handle.powerOfX; - str >> handle.secretKeyID; - seekPastChar(str, ']'); + handle.readFrom(str); return str; } std::ostream& operator<<(std::ostream& str, const CtxtPart& p) { - return str << "[" << ((const DoubleCRT&)p) << std::endl << p.skHandle << "]"; + p.writeToJSON(str); + return str; } std::istream& operator>>(std::istream& str, CtxtPart& p) { - seekPastChar(str, '['); // defined in NumbTh.cpp - str >> (DoubleCRT&)p; - str >> p.skHandle; - seekPastChar(str, ']'); + p.readJSON(str); return str; } std::ostream& operator<<(std::ostream& str, const Ctxt& ctxt) { - str << "[" << ctxt.ptxtSpace << " " << ctxt.noiseBound << " " << ctxt.primeSet - << ctxt.intFactor << " " << ctxt.ptxtMag << " " << ctxt.ratFactor << " " - << ctxt.parts.size() << std::endl; - for (auto& part : ctxt.parts) - str << part << std::endl; - return str << "]"; + ctxt.writeToJSON(str); + return str; } std::istream& operator>>(std::istream& str, Ctxt& ctxt) { - seekPastChar(str, '['); // defined in NumbTh.cpp - str >> ctxt.ptxtSpace >> ctxt.noiseBound >> ctxt.primeSet >> ctxt.intFactor >> - ctxt.ptxtMag >> ctxt.ratFactor; - long nParts; - str >> nParts; - ctxt.parts.resize(nParts, CtxtPart(ctxt.context, IndexSet::emptySet())); - for (auto& part : ctxt.parts) { - str >> part; - // sanity-check - assertEq( - part.getIndexSet(), - ctxt.primeSet, - "Ciphertext part's index set does not match prime set"); // sanity-check - } - seekPastChar(str, ']'); + ctxt.readJSON(str); return str; } @@ -2790,7 +2952,7 @@ double Ctxt::rawModSwitch(std::vector& zzParts, long q) const // Scale and round all the integers in all the parts zzParts.resize(parts.size()); - const PowerfulDCRT& p2d_conv = *context.rcData.p2dConv; + const PowerfulDCRT& p2d_conv = *context.getRcData().p2dConv; for (long i : range(parts.size())) { NTL::Vec pwrfl; @@ -2867,7 +3029,7 @@ void Ctxt::addedNoiseForCKKSDecryption(const SecKey& sk, { assertTrue(&sk.getContext() == &context, "context mismatch"); - double sigma_min = to_double(context.stdev) * 2; + double sigma_min = to_double(context.getStdev()) * 2; // NOTE: the RLWE sampler multiplies by sqrt(m) if m is // not a power of 2, but that should never happen for CKKS // NOTE: we multiply by two just for extra safety diff --git a/src/DoubleCRT.cpp b/src/DoubleCRT.cpp index cdcdf9252..f5dff38b4 100644 --- a/src/DoubleCRT.cpp +++ b/src/DoubleCRT.cpp @@ -21,8 +21,10 @@ #include #include +#include "binio.h" +#include "io.h" + #include -#include #include #include #include @@ -91,14 +93,15 @@ void DoubleCRT::FFT(const zzX& poly, const IndexSet& s) // moduli chain an error is raised if they are not consistent void DoubleCRT::verify() { - assertTrue(map.getIndexSet() <= (context.smallPrimes | context.specialPrimes | - context.ctxtPrimes), + assertTrue(map.getIndexSet() <= + (context.getSmallPrimes() | context.getSpecialPrimes() | + context.getCtxtPrimes()), "Index set must be a subset of the union of small primes, special " "primes, and ctxt primes"); const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); // check that the content of i'th row is in [0,pi) for all i for (long i : s) { @@ -159,7 +162,7 @@ DoubleCRT& DoubleCRT::Op(const DoubleCRT& other, Fun fun, bool matchIndexSets) } const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); // add/sub/mul the data, element by element, modulo the respective primes for (long i : s) { @@ -218,7 +221,7 @@ DoubleCRT& DoubleCRT::do_mul(const DoubleCRT& other, bool matchIndexSets) } const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); // add/sub/mul the data, element by element, modulo the respective primes for (long i : s) { @@ -254,7 +257,7 @@ DoubleCRT& DoubleCRT::Op(const NTL::ZZ& num, Fun fun) return *this; const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { long pi = context.ithPrime(i); @@ -287,7 +290,7 @@ DoubleCRT& DoubleCRT::Negate(const DoubleCRT& other) map = other.map; // copy the data } const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { long pi = context.ithPrime(i); NTL::vec_long& row = map[i]; @@ -325,27 +328,26 @@ NTL::xdouble DoubleCRT::breakIntoDigits(std::vector& digits) const { HELIB_TIMER_START; - const PAlgebra& palg = context.zMStar; - long phim = palg.getPhiM(); + long phim = context.getPhiM(); IndexSet remainingPrimes = getIndexSet(); long n = 0; for (; !empty(remainingPrimes); n++) { - IndexSet digitPrimes = context.digits.at(n); + IndexSet digitPrimes = context.getDigits().at(n); digitPrimes.retain(remainingPrimes); - remainingPrimes.remove(context.digits.at(n)); + remainingPrimes.remove(context.getDigits().at(n)); } - IndexSet allPrimes = getIndexSet() | context.specialPrimes; + IndexSet allPrimes = getIndexSet() | context.getSpecialPrimes(); - assertTrue(getIndexSet() <= context.ctxtPrimes, + assertTrue(getIndexSet() <= context.getCtxtPrimes(), "Index set must be a subset of ctxt primes"); // the calling routine should ensure that the index set // contains only ctxt primes - assertTrue(n <= (long)context.digits.size(), + assertTrue(n <= (long)context.getDigits().size(), "n cannot be larger than the size of context.digits"); digits.resize(n, DoubleCRT(context, IndexSet::emptySet())); @@ -354,7 +356,7 @@ NTL::xdouble DoubleCRT::breakIntoDigits(std::vector& digits) const for (long i : range(n)) { digits[i] = *this; - IndexSet notInDigit = digits[i].getIndexSet() / context.digits[i]; + IndexSet notInDigit = digits[i].getIndexSet() / context.getDigit(i); digits[i].removePrimes(notInDigit); // reduce modulo the digit primes } @@ -385,7 +387,7 @@ NTL::xdouble DoubleCRT::breakIntoDigits(std::vector& digits) const digits[i].addPrimes(notInDigit, &poly); // add back all the primes HELIB_NTIMER_START(NORM_VAL); - NTL::xdouble norm_val = embeddingLargestCoeff(poly, palg); + NTL::xdouble norm_val = embeddingLargestCoeff(poly, context.getZMStar()); HELIB_NTIMER_STOP(NORM_VAL); noise += norm_val; @@ -395,7 +397,7 @@ NTL::xdouble DoubleCRT::breakIntoDigits(std::vector& digits) const #endif - NTL::ZZ pi = context.productOfPrimes(context.digits[i]); + NTL::ZZ pi = context.productOfPrimes(context.getDigit(i)); for (long j : range(i + 1, digits.size())) { digits[j].Sub(digits[i], /*matchIndexSets=*/false); digits[j] /= pi; @@ -469,7 +471,7 @@ double DoubleCRT::addPrimesAndScale(const IndexSet& s1) } // scale existing rows - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); const IndexSet& iSet = map.getIndexSet(); for (long i : iSet) { long qi = context.ithPrime(i); @@ -495,7 +497,7 @@ double DoubleCRT::addPrimesAndScale(const IndexSet& s1) // ***************************************************** DoubleCRTHelper::DoubleCRTHelper(const Context& context) { - val = context.zMStar.getPhiM(); + val = context.getPhiM(); } DoubleCRT::DoubleCRT(const NTL::ZZX& poly, @@ -627,7 +629,7 @@ DoubleCRT::DoubleCRT(const Context& _context, const IndexSet& s) : if (isDryRun()) return; - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { NTL::vec_long& row = map[i]; @@ -649,7 +651,7 @@ DoubleCRT::DoubleCRT(const Context &_context) map.insert(s); if (isDryRun()) return; - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i = s.first(); i <= s.last(); i = s.next(i)) { NTL::vec_long& row = map[i]; @@ -671,7 +673,7 @@ DoubleCRT& DoubleCRT::operator=(const DoubleCRT& other) map = other.map; // copy the data } else { const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { NTL::vec_long& row = map[i]; const NTL::vec_long& other_row = other.map[i]; @@ -715,7 +717,7 @@ DoubleCRT& DoubleCRT::operator=(const NTL::ZZ& num) if (isDryRun()) return *this; - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { NTL::vec_long& row = map[i]; @@ -759,7 +761,7 @@ long DoubleCRT::getOneRow(NTL::Vec& row, long idx, bool positive) const // By default, integers are in [0,q). // If we need the symmetric interval then make it so. if (!positive) { - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long j : range(phim)) if (row[j] > q / 2) row[j] -= q; @@ -796,7 +798,7 @@ void DoubleCRT::toPoly(NTL::ZZX& poly, const IndexSet& s, bool positive) const NTL::Vec& tmpvec = tls_tmpvec; // initialize the ivec vector, ivec[j] = index of j'th active prime - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); long icard = MakeIndexVector(s1, ivec); // icard = how many active primes // Which primes are handled by what thread @@ -971,7 +973,7 @@ DoubleCRT& DoubleCRT::operator/=(const NTL::ZZ& num) return *this; const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { long pi = context.ithPrime(i); @@ -991,7 +993,7 @@ void DoubleCRT::Exp(long e) return; const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); for (long i : s) { long pi = context.ithPrime(i); @@ -1008,12 +1010,12 @@ void DoubleCRT::automorph(long k) if (isDryRun()) return; - const PAlgebra& zMStar = context.zMStar; + const PAlgebra& zMStar = context.getZMStar(); if (!zMStar.inZmStar(k)) throw RuntimeError("DoubleCRT::automorph: k not in Zm*"); long m = zMStar.getM(); - long phim = zMStar.getPhiM(); + long phim = context.getPhiM(); std::vector tmp(m); // temporary array of size m NTL::mulmod_precon_t precon = NTL::PrepMulModPrecon(k, m); @@ -1053,11 +1055,11 @@ void DoubleCRT::automorph(long k) { if (isDryRun()) return; - const PAlgebra& zMStar = context.zMStar; + const PAlgebra& zMStar = context.getZMStar(); if (!zMStar.inZmStar(k)) throw RuntimeError("DoubleCRT::automorph: k not in Zm*"); long m = zMStar.getM(); - long phim = zMStar.getPhiM(); + long phim = getPhiM(); std::vector tmp(phim); // temporary array of size m k = NTL::InvMod(k, m); @@ -1088,9 +1090,7 @@ void DoubleCRT::complexConj() if (isDryRun()) return; - const PAlgebra& zMStar = context.zMStar; - long phim = zMStar.getPhiM(); - + long phim = context.getPhiM(); const IndexSet& s = map.getIndexSet(); // go over the rows, permute them one at a time @@ -1114,7 +1114,7 @@ void DoubleCRT::randomize(const NTL::ZZ* seed) SetSeed(*seed); const IndexSet& s = map.getIndexSet(); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); NTL::RandomStream& stream = NTL::GetCurrentRandomStream(); const long bufsz = 2048; @@ -1266,7 +1266,7 @@ double DoubleCRT::sampleHWtBounded(long Hwt) double DoubleCRT::sampleGaussian(double stdev) { if (stdev == 0.0) - stdev = to_double(context.stdev); + stdev = to_double(context.getStdev()); zzX poly; double retval = ::helib::sampleGaussian(poly, context, stdev); *this = poly; // convert to DoubleCRT @@ -1276,7 +1276,7 @@ double DoubleCRT::sampleGaussian(double stdev) double DoubleCRT::sampleGaussianBounded(double stdev) { if (stdev == 0.0) - stdev = to_double(context.stdev); + stdev = to_double(context.getStdev()); zzX poly; double retval = ::helib::sampleGaussianBounded(poly, context, stdev); *this = poly; // convert to DoubleCRT @@ -1365,59 +1365,21 @@ void DoubleCRT::scaleDownToSet(const IndexSet& s, std::ostream& operator<<(std::ostream& str, const DoubleCRT& d) { - const IndexSet& set = d.map.getIndexSet(); - - // check that the content of i'th row is in [0,pi) for all i - str << "[" << set << std::endl; - for (long i : set) - str << " " << d.map[i] << "\n"; - str << "]"; + str << d.writeToJSON(); return str; } std::istream& operator>>(std::istream& str, DoubleCRT& d) { - // std::cerr << "DoubleCRT["; - // Advance str beyond first '[' - seekPastChar(str, '['); // this function is defined in NumbTh.cpp - - IndexSet set; - const Context& context = d.context; - long phim = context.zMStar.getPhiM(); - - str >> set; // read in the indexSet - assertTrue( - set <= (context.smallPrimes | context.specialPrimes | context.ctxtPrimes), - "Stream does not contain subset of the context's primes"); - d.map.clear(); - d.map.insert(set); // fix the index set for the data - - for (long i : set) { - str >> d.map[i]; // read the actual data - - // verify that the data is valid - assertEq(d.map[i].length(), - phim, - "Data not valid: d.map[i].length() != phim"); - for (long j : range(phim)) - assertInRange( - d.map[i][j], - 0l, - context.ithPrime(i), - "d.map[i][j] invalid: must be between 0 and context.ithPrime(i)"); - } - - // Advance str beyond closing ']' - seekPastChar(str, ']'); - // std::cerr << "]"; + d.readJSON(str); return str; } -void DoubleCRT::write(std::ostream& str) const +void DoubleCRT::writeTo(std::ostream& str) const { const IndexSet& set = map.getIndexSet(); // std::cerr << "[DCRT::write] set: " << set << std::endl; - set.write(str); + set.writeTo(str); for (long i : set) { write_ntl_vec_long(str, map[i]); @@ -1425,10 +1387,17 @@ void DoubleCRT::write(std::ostream& str) const } } +DoubleCRT DoubleCRT::readFrom(std::istream& str, const Context& context) +{ + DoubleCRT ret(context, IndexSet::emptySet()); + ret.read(str); + + return ret; +} + void DoubleCRT::read(std::istream& str) { - IndexSet set; - set.read(str); // read in the indexSet + IndexSet set = IndexSet::readFrom(str); // read in the indexSet map.clear(); map.insert(set); // fix the index set for the data // std::cerr << "[DCRT::read] set: " << set << std::endl; @@ -1439,4 +1408,76 @@ void DoubleCRT::read(std::istream& str) } } +void DoubleCRT::writeToJSON(std::ostream& str) const +{ + str << this->writeToJSON(); +} + +JsonWrapper DoubleCRT::writeToJSON() const +{ + const IndexSet& set = this->map.getIndexSet(); + std::vector> map_cnt; + + // check that the content of i'th row is in [0,pi) for all i + for (long i : set) + map_cnt.emplace_back(this->map[i]); + + json j = {{"set", unwrap(set.writeToJSON())}, {"map", map_cnt}}; + return wrap(j); +} + +DoubleCRT DoubleCRT::readFromJSON(std::istream& str, const Context& context) +{ + json j; + str >> j; + return DoubleCRT::readFromJSON(wrap(j), context); +} + +DoubleCRT DoubleCRT::readFromJSON(const JsonWrapper& j, const Context& context) +{ + DoubleCRT ret{context, IndexSet::emptySet()}; + ret.readJSON(j); + return ret; +} + +void DoubleCRT::readJSON(std::istream& str) +{ + json j; + str >> j; + return this->readJSON(wrap(j)); +} + +void DoubleCRT::readJSON(const JsonWrapper& jw) +{ + json j = unwrap(jw); + + const Context& context = this->context; + long phim = context.getPhiM(); + + IndexSet set = IndexSet::readFromJSON(wrap(j.at("set"))); + assertTrue(set <= (context.getSmallPrimes() | context.getSpecialPrimes() | + context.getCtxtPrimes()), + "Stream does not contain subset of the context's primes"); + this->map.clear(); + this->map.insert(set); // fix the index set for the data + + std::vector> map_cnt = j.at("map"); + + std::size_t cnt = 0; + for (long i : set) { + this->map[i] = map_cnt[cnt++]; // read the actual data + + // verify that the data is valid + assertEq(this->map[i].length(), + phim, + "Data not valid: d.map[i].length() != phim"); + for (long j : range(phim)) + assertInRange( + this->map[i][j], + 0l, + context.ithPrime(i), + "this->map[i][j] invalid: must be between 0 and context.ithPrime(i)"); + } +} + } // namespace helib diff --git a/src/EncryptedArray.cpp b/src/EncryptedArray.cpp index 9f578143c..33083c44e 100644 --- a/src/EncryptedArray.cpp +++ b/src/EncryptedArray.cpp @@ -181,7 +181,6 @@ void EncryptedArrayDerived::rotate(Ctxt& ctxt, long amt) const HELIB_TIMER_START; const PAlgebra& al = getPAlgebra(); - const std::vector>& maskTable = tab.getMaskTable(); RBak bak; diff --git a/src/IndexSet.cpp b/src/IndexSet.cpp index 730000167..bd07014ba 100644 --- a/src/IndexSet.cpp +++ b/src/IndexSet.cpp @@ -11,7 +11,8 @@ */ #include -#include +#include "binio.h" +#include "io.h" namespace helib { @@ -284,36 +285,7 @@ bool operator>(const IndexSet& s1, const IndexSet& s2) return card(s2) < card(s1) && s1.contains(s2); } -std::ostream& operator<<(std::ostream& str, const IndexSet& set) -{ - if (set.card() == 0) { - str << "[]"; - } else if (set.card() == 1) { - str << "[" << set.first() << "]"; - } else { - str << "[" << set.first(); - for (long i = set.next(set.first()); i <= set.last(); i = set.next(i)) - str << " " << i; - str << "]"; - } - - return str; -} - -std::istream& operator>>(std::istream& str, IndexSet& set) -{ - NTL::vec_long v; - str >> v; // read in the set as a vector - - // insert all these indexes into the set - set.clear(); - for (long i = 0; i < v.length(); i++) - set.insert(v[i]); - - return str; -} - -void IndexSet::write(std::ostream& str) const +void IndexSet::writeTo(std::ostream& str) const { // Size of Set write_raw_int(str, this->card()); @@ -324,19 +296,71 @@ void IndexSet::write(std::ostream& str) const } } -void IndexSet::read(std::istream& str) +IndexSet IndexSet::readFrom(std::istream& str) { + IndexSet res; // Size of Set long sizeOfS = read_raw_int(str); // insert all these indexes into the set - this->clear(); + res.clear(); // The data itself for (long i = 0, n; i < sizeOfS; i++) { n = read_raw_int(str); - this->insert(n); + res.insert(n); + } + + return res; +} + +void IndexSet::writeToJSON(std::ostream& str) const { str << writeToJSON(); } + +JsonWrapper IndexSet::writeToJSON() const +{ + // TODO: I'm sure there is a better way to do this + std::vector content; + for (long n = this->first(); n <= this->last(); n = this->next(n)) { + content.emplace_back(n); } + + json j = content; + + return wrap(j); +} + +IndexSet IndexSet::readFromJSON(std::istream& str) +{ + json j; + str >> j; + return readFromJSON(wrap(j)); +} + +IndexSet IndexSet::readFromJSON(const JsonWrapper& jw) +{ + std::vector content = unwrap(jw); + + IndexSet res; + res.clear(); + + // The data itself + for (const auto& n : content) { + res.insert(n); + } + + return res; +} + +std::ostream& operator<<(std::ostream& str, const IndexSet& set) +{ + set.writeToJSON(str); + return str; +} + +std::istream& operator>>(std::istream& str, IndexSet& set) +{ + set = IndexSet::readFromJSON(str); + return str; } } // namespace helib diff --git a/src/JsonWrapper.cpp b/src/JsonWrapper.cpp new file mode 100644 index 000000000..c37aebd3c --- /dev/null +++ b/src/JsonWrapper.cpp @@ -0,0 +1,47 @@ +#include +#include +#include + +#include "io.h" + +#include +using json = ::nlohmann::json; + +namespace helib { + +std::string JsonWrapper::pretty(long indent) const +{ + try { + auto j = std::any_cast(this->json_obj); + return j.dump(indent); + } catch (const std::bad_any_cast& e) { + throw LogicError(std::string("Bad cast to a JSON object: \n\t") + e.what()); + } +} + +std::string JsonWrapper::toString() const +{ + try { + auto j = std::any_cast(this->json_obj); + return j.dump(); + } catch (const std::bad_any_cast& e) { + throw LogicError(std::string("Bad cast to a JSON object: \n\t") + e.what()); + } +} + +JsonWrapper JsonWrapper::at(const std::string& key) const +{ + try { + auto j = std::any_cast(this->json_obj); + return wrap(j.at(key)); + } catch (const std::bad_any_cast& e) { + throw LogicError(std::string("Bad cast to a JSON object: \n\t") + e.what()); + } +} + +std::ostream& operator<<(std::ostream& str, const JsonWrapper& wrapper) +{ + return str << wrapper.toString(); +} + +} // namespace helib diff --git a/src/NumbTh.cpp b/src/NumbTh.cpp index 959ab1eb6..4d6595493 100644 --- a/src/NumbTh.cpp +++ b/src/NumbTh.cpp @@ -1081,138 +1081,6 @@ void seekPastChar(std::istream& str, int cc) } } -// Advance the input stream `str` beyond white spaces and a single -// `separator` in the region-of-interest delimited by `begin_char` and -// `end_char`. -bool iterateInterestRegion(std::istream& str, - int begin_char, - int separator, - int end_char) -{ - int c = str.get(); - while (isspace(c)) { - c = str.get(); - } - if (c == begin_char || c == separator) { - // Reached beginning of region or reached a separator. Return true - return true; - } else if (c == end_char) { - // Reached end_char. Return false - return false; - } else { - // Reached something different. Throw - std::stringstream ss; - ss << "Iterating on region found a non-delimiting " - << "character='" << static_cast(c) << "' (ascii " << c << "). " - << "Delimiters: " - << "begin_char='" << static_cast(begin_char) << "' (ascii " - << begin_char << "), " - << "separator='" << static_cast(separator) << "' (ascii " - << separator << "), or " - << "end_char='" << static_cast(end_char) << "' (ascii " << end_char - << ")"; - throw IOError(ss.str()); - } -} - -// Advance the input stream `str` beyond white spaces and then split the -// region-of-interest delimited by `begin_char` and `end_char` at every -// top-level occurrence of `separator`. -std::vector extractTokenizeRegion(std::istream& istr, - char begin_char, - char end_char, - char separator, - bool skip_space) -{ - // Check if the arguments are valid. - assertNeq(begin_char, - ' ', - "Invalid begin_char. " - "Should be different from ' ' (space)."); - assertNeq(begin_char, - end_char, - "Invalid begin_char. " - "Should be different from end_char."); - assertNeq(begin_char, - separator, - "Invalid begin_char. " - "Should be different from separator."); - assertNeq(end_char, - ' ', - "Invalid end_char. " - "Should be different from ' ' (space)."); - assertNeq(end_char, - separator, - "Invalid end_char. " - "Should be different from separator."); - assertNeq(separator, - ' ', - "Invalid separator. " - "Should be different from ' ' (space)."); - int ch = istr.get(); - // Skip leading whitespaces - while (isspace(ch)) { - ch = istr.get(); - } - // Fail if the input is not starting with a '[' - if (ch != begin_char) { - std::stringstream ss; - ss << "Extract and tokenization of stream failed with: Region beginning " - "with character='" - << static_cast(ch) << "' (ascii " << ch << "). " - << "Delimiters: " - << "begin_char='" << static_cast(begin_char) << "' (ascii " - << begin_char << "), " - << "separator='" << static_cast(separator) << "' (ascii " - << separator << "), or " - << "end_char='" << static_cast(end_char) << "' (ascii " << end_char - << ")"; - throw IOError(ss.str()); - } - std::vector res; - std::stringstream current_stream; - int depth = 0; - - while (istr.peek() != EOF) { - ch = istr.get(); - if (ch == ' ' && skip_space) { - // Skip whitespaces - continue; - } else if (ch == end_char && depth == 0) { - // We found the section closure - if (!current_stream.str().empty()) { - // If something is in the stream add it to the returns - res.emplace_back(std::move(current_stream)); - } - return res; - } else if (ch == end_char && depth > 0) { - // We found the end of an inner section - depth--; - current_stream << static_cast(ch); - } else if (ch == begin_char) { - // We found the begin of an inner section - depth++; - current_stream << static_cast(ch); - } else if (ch == separator && depth == 0) { - res.emplace_back(std::move(current_stream)); - current_stream = std::stringstream(); - } else { - current_stream << static_cast(ch); - } - } - // Throw as the section was not closed - std::stringstream ss; - ss << "Extract and tokenization of stream failed with: Region not closed. " - << "Delimiters: " - << "begin_char='" << static_cast(begin_char) << "' (ascii " - << begin_char << "), " - << "separator='" << static_cast(separator) << "' (ascii " - << separator << "), or " - << "end_char='" << static_cast(end_char) << "' (ascii " << end_char - << ")"; - throw IOError(ss.str()); -} - // stuff added relating to linearized polynomials and support routines // Builds the matrix defining the linearized polynomial transformation. diff --git a/src/PolyMod.cpp b/src/PolyMod.cpp index c1dece5b9..c07c96ee6 100644 --- a/src/PolyMod.cpp +++ b/src/PolyMod.cpp @@ -17,6 +17,8 @@ #include #include +#include "io.h" + namespace helib { PolyMod::PolyMod() : ringDescriptor(nullptr) {} @@ -284,60 +286,79 @@ PolyMod& PolyMod::operator-=(const NTL::ZZX& otherPoly) return *this; } -void deserialize(std::istream& is, PolyMod& poly) +void PolyMod::writeToJSON(std::ostream& os) const { - PolyMod::assertValidity(poly); - std::vector parts = - extractTokenizeRegion(is, '[', ']', ','); - - long degree = NTL::deg(poly.ringDescriptor->G); - if (lsize(parts) > degree) { - // Too many elements. Raising an error. - std::stringstream err_msg; - err_msg << "Cannot deserialize to PolyMod: Degree is too small. " - << "Trying to deserialize " << parts.size() << " coefficients. " - << "Degree is " << degree << "."; - throw IOError(err_msg.str()); - } + PolyMod::assertValidity(*this); + executeRedirectJsonError([&]() { os << writeToJSON(); }); +} - // Actual parsing and setup - NTL::clear(poly.data); // Make sure higher-degree terms don't remain - for (std::size_t i = 0; i < parts.size(); ++i) { - long tmp; - parts[i] >> tmp; - NTL::SetCoeff(poly.data, i, tmp); - } +JsonWrapper PolyMod::writeToJSON() const +{ + PolyMod::assertValidity(*this); - // Normalization (removal of leading zeros) is done by modularReduce. - poly.modularReduce(); + return executeRedirectJsonError( + [&]() { return wrap(this->data); }); } -void serialize(std::ostream& os, const PolyMod& poly) +PolyMod PolyMod::readFromJSON( + std::istream& is, + const std::shared_ptr& ringDescriptor) { - PolyMod::assertValidity(poly); - if (poly.data == NTL::ZZX::zero()) { - // Avoid string "[]" for zero ZZX. - os << "[0]"; - return; - } + PolyMod poly(ringDescriptor); + poly.readJSON(is); + return poly; +} + +PolyMod PolyMod::readFromJSON( + const JsonWrapper& jw, + const std::shared_ptr& ringDescriptor) +{ + PolyMod poly(ringDescriptor); + poly.readJSON(jw); + return poly; +} + +void PolyMod::readJSON(std::istream& is) +{ + executeRedirectJsonError([&]() { + json j; + is >> j; + this->readJSON(wrap(j)); + }); +} + +void PolyMod::readJSON(const JsonWrapper& jw) +{ + auto body = [&]() { + PolyMod::assertValidity(*this); + + NTL::ZZX poly = unwrap(jw); - // TODO: Add stream modifier option for separator - std::string sep = ", "; - os << "["; - for (auto ite = poly.data.rep.begin(); ite != poly.data.rep.end(); ++ite) { - os << *ite; - if (ite + 1 != poly.data.rep.end()) { - os << ", "; + long g_degree = NTL::deg(this->ringDescriptor->G); + if (deg(poly) >= g_degree) { + // Too many elements. Raising an error. + std::stringstream err_msg; + err_msg << "Cannot deserialize to PolyMod: Degree is too small. " + << "Trying to deserialize " << deg(poly) + 1 << " coefficients. " + << "Slot modulus degree is " << g_degree << "."; + throw IOError(err_msg.str()); } - } - os << "]"; + + NTL::clear(this->data); // Make sure higher-degree terms don't remain + this->data = poly; + + // Normalization (removal of leading zeros) is done by modularReduce. + this->modularReduce(); + }; + + executeRedirectJsonError(body); } std::istream& operator>>(std::istream& is, PolyMod& poly) { PolyMod::assertValidity(poly); - deserialize(is, poly); + poly.readJSON(is); return is; } @@ -345,7 +366,7 @@ std::ostream& operator<<(std::ostream& os, const PolyMod& poly) { PolyMod::assertValidity(poly); - serialize(os, poly); + poly.writeToJSON(os); return os; } diff --git a/src/Ptxt.cpp b/src/Ptxt.cpp index 155c9160f..17e8da55e 100644 --- a/src/Ptxt.cpp +++ b/src/Ptxt.cpp @@ -14,58 +14,14 @@ #include #include -namespace helib { - -void deserialize(std::istream& is, std::complex& num) -{ - std::vector parts = - extractTokenizeRegion(is, '[', ']', ','); - if (parts.empty()) { - // Empty section. Use default value. - num = 0; - return; - } - - if (parts.size() > 2) { - // Too many elements. - throw IOError( - "CKKS expects maximum of 2 values per slot (real, imag). Got " + - std::to_string(parts.size()) + " instead."); - } - - // Actual parsing and setup - double tmp; - parts[0] >> tmp; - num.real(tmp); - if (parts.size() == 2) { - // If more than 1 part, set also real value; - parts[1] >> tmp; - num.imag(tmp); - } -} +#include "io.h" -void serialize(std::ostream& os, const std::complex& num) -{ - struct stream_modifier - { - explicit stream_modifier(std::ostream& os) : os(os), ss(os.precision()) - { - os << std::setprecision(std::numeric_limits::digits10); - }; - ~stream_modifier() { os << std::setprecision(ss); }; - std::ostream& os; - std::streamsize ss; - }; - - stream_modifier sm(os); - - os << "[" << num.real() << ", " << num.imag() << "]"; -} +namespace helib { template <> PolyMod Ptxt::convertToSlot(const Context& context, long slot) { - PolyMod data(NTL::ZZX(slot), context.slotRing); + PolyMod data(NTL::ZZX(slot), context.getSlotRing()); return data; } @@ -82,14 +38,14 @@ Ptxt::Ptxt() : context(nullptr) template Ptxt::Ptxt(const Context& context) : context(&context), - slots(context.ea->size(), + slots(context.getEA().size(), SlotType{Ptxt::convertToSlot(*(this->context), 0L)}) {} template Ptxt::Ptxt(const Context& context, const SlotType& value) : context(std::addressof(context)), - slots(context.ea->size(), + slots(context.getEA().size(), SlotType{Ptxt::convertToSlot(*(this->context), 0L)}) { setData(value); @@ -101,8 +57,8 @@ void Ptxt::setData(const NTL::ZZX& value) { assertTrue(isValid(), "Cannot call setData on default-constructed Ptxt"); - PolyMod poly(value, context->slotRing); - std::vector poly_vec(context->ea->size(), poly); + PolyMod poly(value, context->getSlotRing()); + std::vector poly_vec(context->getEA().size(), poly); setData(poly_vec); } @@ -110,7 +66,7 @@ template <> template <> Ptxt::Ptxt(const Context& context, const NTL::ZZX& value) : context(&context), - slots(context.ea->size(), + slots(context.getEA().size(), SlotType{Ptxt::convertToSlot(*(this->context), 0L)}) { setData(value); @@ -119,7 +75,7 @@ Ptxt::Ptxt(const Context& context, const NTL::ZZX& value) : template Ptxt::Ptxt(const Context& context, const std::vector& data) : context(std::addressof(context)), - slots(context.ea->size(), + slots(context.getEA().size(), SlotType{Ptxt::convertToSlot(*(this->context), 0L)}) { setData(data); @@ -152,15 +108,15 @@ void Ptxt::setData(const std::vector& data) { assertTrue(isValid(), "Cannot call setData on default-constructed Ptxt"); - assertTrue(helib::lsize(data) <= context->ea->size(), + assertTrue(helib::lsize(data) <= context->getEA().size(), "Cannot setData to Ptxt: not enough slots"); // Need to verify that they all match assertSlotsCompatible(data); slots = data; - if (helib::lsize(slots) < context->ea->size()) { - slots.resize(context->ea->size(), + if (helib::lsize(slots) < context->getEA().size()) { + slots.resize(context->getEA().size(), SlotType{Ptxt::convertToSlot(*(this->context), 0L)}); } } @@ -170,7 +126,7 @@ void Ptxt::setData(const SlotType& value) { assertTrue(isValid(), "Cannot call setData on default-constructed Ptxt"); - setData(std::vector(context->ea->size(), value)); + setData(std::vector(context->getEA().size(), value)); } template <> @@ -180,10 +136,10 @@ void Ptxt::decodeSetData(const NTL::ZZX& data) assertTrue( isValid(), "Cannot call decodeSetData on default-constructed Ptxt"); - PolyMod poly(context->slotRing); - std::vector poly_vec(context->ea->size(), poly); - std::vector ptxt(context->ea->size()); - context->ea->decode(ptxt, data); + PolyMod poly(context->getSlotRing()); + std::vector poly_vec(context->getEA().size(), poly); + std::vector ptxt(context->getEA().size()); + context->getEA().decode(ptxt, data); for (std::size_t i = 0; i < ptxt.size(); ++i) { poly_vec[i] = ptxt[i]; } @@ -204,9 +160,11 @@ typename Scheme::SlotType randomSlot(const Context& context); template <> BGV::SlotType randomSlot(const Context& context) { - std::vector coeffs(context.zMStar.getOrdP()); - NTL::VectorRandomBnd(coeffs.size(), coeffs.data(), context.slotRing->p2r); - return PolyMod(coeffs, context.slotRing); + std::vector coeffs(context.getOrdP()); + NTL::VectorRandomBnd(coeffs.size(), + coeffs.data(), + context.getSlotRing()->p2r); + return PolyMod(coeffs, context.getSlotRing()); } template <> @@ -250,11 +208,11 @@ NTL::ZZX Ptxt::getPolyRepr() const assertTrue(isValid(), "Cannot call getPolyRepr on default-constructed Ptxt"); NTL::ZZX repr; - std::vector slots_data(context->ea->size()); + std::vector slots_data(context->getEA().size()); for (std::size_t i = 0; i < slots_data.size(); ++i) { slots_data[i] = slots[i].getData(); } - context->ea->encode(repr, slots_data); + context->getEA().encode(repr, slots_data); return repr; } @@ -267,12 +225,12 @@ void Ptxt::encode(EncodedPtxt& eptxt, double mag, OptLong prec) const assertTrue(mag < 0 && !prec.isDefined(), "mag,prec must be defaulted for BGV"); - std::vector slots_data(context->ea->size()); + std::vector slots_data(context->getEA().size()); for (std::size_t i = 0; i < slots_data.size(); ++i) { slots_data[i] = slots[i].getData(); } - context->ea->encode(eptxt, slots_data); + context->getEA().encode(eptxt, slots_data); } /** @@ -285,7 +243,7 @@ void Ptxt::encode(EncodedPtxt& eptxt, double mag, OptLong prec) const { assertTrue(isValid(), "Cannot call encode on default-constructed Ptxt"); - context->ea->encode(eptxt, slots, mag, prec); + context->getEA().encode(eptxt, slots, mag, prec); } template @@ -604,7 +562,7 @@ Ptxt& Ptxt::rotate1D(long dim, long amount) "Cannot call rotate1D on default-constructed Ptxt"); if (slots.size() == 1) return *this; // Nothing to do (only one slot) - const PAlgebra& zMStar = context->zMStar; + const PAlgebra& zMStar = context->getZMStar(); long num_gens = zMStar.numOfGens(); assertInRange(dim, 0l, @@ -613,7 +571,7 @@ Ptxt& Ptxt::rotate1D(long dim, long amount) "number of generators"); // Copying in slots to avoid default PolyMod issues. std::vector new_slots(slots); - long ord = context->ea->sizeOfDimension(dim); + long ord = context->getEA().sizeOfDimension(dim); amount = mcMod(amount, ord); // Make amount smallest positive integer < ord if (amount == 0) return *this; // Nothing to do @@ -668,12 +626,12 @@ Ptxt& Ptxt::shift1D(long dim, long amount) if (amount == 0) return *this; if (slots.size() == 1 || - std::abs(amount) >= context->ea->sizeOfDimension(dim)) { + std::abs(amount) >= context->getEA().sizeOfDimension(dim)) { clear(); return *this; } // NOTE: There is some code duplication here and in rotate1D - const PAlgebra& zMStar = context->zMStar; + const PAlgebra& zMStar = context->getZMStar(); long num_gens = zMStar.numOfGens(); assertInRange(dim, 0l, @@ -682,7 +640,7 @@ Ptxt& Ptxt::shift1D(long dim, long amount) "number of generators"); // Copying in slots to avoid default PolyMod issues. std::vector new_slots(slots); - long ord = context->ea->sizeOfDimension(dim); + long ord = context->getEA().sizeOfDimension(dim); // This for loop performs similar logic in rotate1D to obtain the new index // post shift via the conversion to and from the corresponding coordinate @@ -713,10 +671,10 @@ Ptxt& Ptxt::automorph(long k) { assertTrue(isValid(), "Cannot call automorph on default-constructed Ptxt"); - assertTrue(context->zMStar.inZmStar(k), + assertTrue(context->getZMStar().inZmStar(k), "k must be an element in Zm*"); NTL::ZZX poly; - switch (context->ea->getTag()) { + switch (context->getEA().getTag()) { case PA_GF2_tag: { decodeSetData(automorph_internal(k)); break; @@ -736,9 +694,9 @@ Ptxt& Ptxt::automorph(long k) { assertTrue(isValid(), "Cannot call automorph on default-constructed Ptxt"); - assertTrue(context->zMStar.inZmStar(k), + assertTrue(context->getZMStar().inZmStar(k), "k must be an element in Zm*"); - return rotate(context->zMStar.indexOfRep(k)); + return rotate(context->getZMStar().indexOfRep(k)); } template <> @@ -748,11 +706,12 @@ Ptxt& Ptxt::frobeniusAutomorph(long j) assertTrue(isValid(), "Cannot call frobeniusAutomorph on " "default-constructed Ptxt"); - long d = context->zMStar.getOrdP(); + long d = context->getOrdP(); if (d == 1) return *this; // Nothing to do. - long exponent = - NTL::PowerMod(context->slotRing->p, mcMod(j, d), context->zMStar.getM()); + long exponent = NTL::PowerMod(context->getSlotRing()->p, + mcMod(j, d), + context->getZMStar().getM()); return automorph(exponent); } @@ -880,7 +839,7 @@ Ptxt& Ptxt::mapTo01() template long Ptxt::coordToIndex(const std::vector& coords) { - const PAlgebra& zMStar = context->zMStar; + const PAlgebra& zMStar = context->getZMStar(); assertEq(coords.size(), static_cast(zMStar.numOfGens()), "Coord must have same size as hypercube structure"); @@ -903,7 +862,7 @@ long Ptxt::coordToIndex(const std::vector& coords) template std::vector Ptxt::indexToCoord(long index) { - const PAlgebra& zMStar = context->zMStar; + const PAlgebra& zMStar = context->getZMStar(); long num_gens = zMStar.numOfGens(); assertInRange(index, 0l, lsize(), "Index out of range"); std::vector coords(num_gens); @@ -929,7 +888,7 @@ template <> template <> PA_GF2::RX Ptxt::slotsToRX() const { - assertEq(context->alMod.getPPowR(), + assertEq(context->getAlMod().getPPowR(), 2l, "Plaintext modulus p^r must be equal to 2^1"); return NTL::conv(getPolyRepr()); @@ -939,7 +898,7 @@ template <> template <> PA_zz_p::RX Ptxt::slotsToRX() const { - assertNeq(context->alMod.getPPowR(), + assertNeq(context->getAlMod().getPPowR(), 2l, "Plaintext modulus p^r must not be equal to 2^1"); return NTL::conv(getPolyRepr()); @@ -949,9 +908,9 @@ template <> void Ptxt::assertSlotsCompatible(const std::vector& slots) const { for (const auto& slot : slots) { - if (slot.getp2r() != context->slotRing->p2r) + if (slot.getp2r() != context->getSlotRing()->p2r) throw RuntimeError("Mismatching p^r found"); - if (slot.getG() != context->slotRing->G) + if (slot.getG() != context->getSlotRing()->G) throw RuntimeError("Mismatching G found"); } } @@ -968,69 +927,135 @@ NTL::ZZX Ptxt::automorph_internal(long k) { NTL::zz_pContext pContext; pContext.save(); - NTL::zz_p::init(context->slotRing->p2r); - long m = context->zMStar.getM(); + NTL::zz_p::init(context->getSlotRing()->p2r); + long m = context->getM(); auto old_slots = slotsToRX(); decltype(old_slots) new_slots; plaintextAutomorph(new_slots, old_slots, k, m, - context->alMod.getDerived(type()).getPhimXMod()); + context->getAlMod().getDerived(type()).getPhimXMod()); NTL::ZZX ret = NTL::conv(new_slots); pContext.restore(); return ret; } template -void deserialize(std::istream& is, Ptxt& ptxt) +void Ptxt::writeToJSON(std::ostream& os) const { - assertTrue(ptxt.isValid(), + // TODO: add JSON try-catch wrapper + assertTrue(this->isValid(), "Cannot operate on invalid " "(default constructed) Ptxt"); - std::vector parts = - extractTokenizeRegion(is, '[', ']', ','); - - if (helib::lsize(parts) > ptxt.context->ea->size()) { - std::stringstream err_msg; - err_msg << "Cannot deserialize to Ptxt: not enough slots. " - << "Trying to deserialize " << parts.size() << " elements. " - << "Got " << ptxt.context->ea->size() << " slots."; - throw IOError(err_msg.str()); - } - std::vector data(parts.size()); - for (std::size_t i = 0; i < parts.size(); ++i) { - typename Scheme::SlotType slot( - Ptxt::convertToSlot(*ptxt.context, 0L)); - deserialize(parts[i], slot); - data[i] = std::move(slot); - } + executeRedirectJsonError([&]() { os << this->writeToJSON(); }); +} + +template +JsonWrapper Ptxt::writeToJSON() const +{ + assertTrue(this->isValid(), + "Cannot operate on invalid " + "(default constructed) Ptxt"); + auto body = [this]() { + json jslots; + + if constexpr (std::is_same_v) { + jslots = slots; + } else { + jslots = writeVectorToJSON(slots); + } + + json j{{"scheme", Scheme::schemeName}, {"slots", jslots}}; - is.clear(); - ptxt.setData(data); + return wrap(toTypedJson>(j)); + }; + + return executeRedirectJsonError(body); } -// Explicit function instantiation -template void deserialize(std::istream& is, Ptxt& ptxt); -template void deserialize(std::istream& is, Ptxt& ptxt); +template +Ptxt Ptxt::readFromJSON(std::istream& is, + const Context& context) +{ + Ptxt ret{context}; + ret.readJSON(is); + return ret; +} template -void serialize(std::ostream& os, const Ptxt& ptxt) +Ptxt Ptxt::readFromJSON(const JsonWrapper& tjw, + const Context& context) { - os << "["; - for (std::size_t i = 0; i < ptxt.slots.size(); ++i) { - serialize(os, ptxt.slots[i]); - if (i != ptxt.slots.size() - 1) { - os << ", "; - } - } - os << "]"; + Ptxt ret{context}; + ret.readJSON(tjw); + return ret; } -// Explicit function instantiation -template void serialize(std::ostream& os, const Ptxt& ptxt); -template void serialize(std::ostream& os, const Ptxt& ptxt); +template +void Ptxt::readJSON(std::istream& is) +{ + assertTrue(this->isValid(), + "Cannot operate on invalid " + "(default constructed) Ptxt"); + executeRedirectJsonError([&]() { + json j; + is >> j; + this->readJSON(wrap(j)); + }); +} + +template +void Ptxt::readJSON(const JsonWrapper& tjw) +{ + assertTrue(this->isValid(), + "Cannot operate on invalid " + "(default constructed) Ptxt"); + auto body = [&]() { + json tj = unwrap(tjw); + json jslots; + // if the input is just an array short-circuit to slot deserialization + // (assuming there is no type-header). + if (tj.is_array()) { + jslots = tj; + + } else { + json j = fromTypedJson>(tj); + + std::string expected_scheme{j.at("scheme").get()}; + assertTrue( + Scheme::schemeName == expected_scheme, + "Scheme mismatch in deserialization.\nExpected: " + expected_scheme + + ", actual: " + std::string(Scheme::schemeName) + "."); + + jslots = j.at("slots"); + + if (!jslots.is_array()) { + throw IOError("Slot content is not a JSON array"); + } + } + + if (static_cast(jslots.size()) > this->context->getEA().size()) { + std::stringstream err_msg; + err_msg << "Cannot deserialize to Ptxt: not enough slots. " + << "Trying to deserialize " << jslots.size() << " elements. " + << "Got " << this->context->getEA().size() << " slots."; + throw IOError(err_msg.str()); + } + + if constexpr (std::is_same_v) { + // Scheme is CKKS + this->setData(jslots.get>>()); + } else { + // Scheme is BGV + this->setData( + readVectorFromJSON(jslots, context->getSlotRing())); + } + }; + + executeRedirectJsonError(body); +} template std::istream& operator>>(std::istream& is, Ptxt& ptxt) @@ -1038,7 +1063,7 @@ std::istream& operator>>(std::istream& is, Ptxt& ptxt) assertTrue(ptxt.isValid(), "Cannot operate on invalid " "(default constructed) Ptxt"); - deserialize(is, ptxt); + ptxt.readJSON(is); return is; } @@ -1053,7 +1078,7 @@ std::ostream& operator<<(std::ostream& os, const Ptxt& ptxt) "Cannot operate on invalid " "(default constructed) Ptxt"); - serialize(os, ptxt); + ptxt.writeToJSON(os); return os; } diff --git a/src/binaryArith.cpp b/src/binaryArith.cpp index 845a8087c..6b90c34a6 100644 --- a/src/binaryArith.cpp +++ b/src/binaryArith.cpp @@ -486,7 +486,7 @@ void packedRecrypt(const CtPtrs& a, }; const CtPtrs_pair ab(a, b); - packedRecrypt(ab, *unpackSlotEncoding, *(ct->getContext().ea)); + packedRecrypt(ab, *unpackSlotEncoding, ct->getContext().getEA()); } // Return a number as a vector of bits with little endian-ness @@ -913,7 +913,7 @@ void addManyNumbers(CtPtrs& sum, } bool bootstrappable = ct_ptr->getPubKey().isBootstrappable(); - const EncryptedArray& ea = *(ct_ptr->getContext().ea); + const EncryptedArray& ea = ct_ptr->getContext().getEA(); long leftInQ = lsize(numbers); std::vector numPtrs(leftInQ); diff --git a/src/binio.cpp b/src/binio.cpp index 8a00c6c78..2b9db8420 100644 --- a/src/binio.cpp +++ b/src/binio.cpp @@ -9,27 +9,25 @@ * See the License for the specific language governing permissions and * limitations under the License. See accompanying LICENSE file. */ -#include +#include "binio.h" #include -#include #include // byte order macros in a platform-independent way. namespace helib { /* Some utility functions for binary IO */ - -int readEyeCatcher(std::istream& str, const char* expect) +bool readEyeCatcher(std::istream& str, + const std::array& expect) { - char eye[BINIO_EYE_SIZE]; - str.read(eye, BINIO_EYE_SIZE); - return memcmp(eye, expect, BINIO_EYE_SIZE); + std::array eye; + str.read(eye.data(), EyeCatcher::SIZE); + return eye == expect; } -void writeEyeCatcher(std::ostream& str, const char* eyeStr) +void writeEyeCatcher(std::ostream& str, + const std::array& eye) { - char eye[BINIO_EYE_SIZE]; - memcpy(eye, eyeStr, BINIO_EYE_SIZE); - str.write(eye, BINIO_EYE_SIZE); + str.write(eye.data(), eye.size()); } // compile only 64-bit (-m64) therefore long must be at least 64-bit @@ -37,13 +35,13 @@ long read_raw_int(std::istream& str) { #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ long result = 0; - str.read((char*)&result, BINIO_64BIT); + str.read(reinterpret_cast(&result), Binio::BIT64); return result; #else long result = 0; char byte; - for (long i = 0; i < BINIO_64BIT; i++) { + for (long i = 0; i < Binio::BIT64; i++) { str.read(&byte, 1); // read a byte result |= (static_cast(byte) & 0xff) << i * 8; // must be in little endian @@ -57,13 +55,13 @@ int read_raw_int32(std::istream& str) { #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ int result = 0; - str.read((char*)&result, BINIO_32BIT); + str.read(reinterpret_cast(&result), Binio::BIT32); return result; #else int result = 0; char byte; - for (long i = 0; i < BINIO_32BIT; i++) { + for (long i = 0; i < Binio::BIT32; i++) { str.read(&byte, 1); // read a byte result |= (static_cast(byte) & 0xff) << i * 8; // must be in little endian @@ -77,11 +75,11 @@ int read_raw_int32(std::istream& str) void write_raw_int(std::ostream& str, long num) { #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ - str.write((const char*)&num, BINIO_64BIT); + str.write(reinterpret_cast(&num), Binio::BIT64); #else char byte; - for (long i = 0; i < BINIO_64BIT; i++) { + for (long i = 0; i < Binio::BIT64; i++) { byte = num >> 8 * i; // serializing in little endian str.write(&byte, 1); // write byte out } @@ -91,11 +89,11 @@ void write_raw_int(std::ostream& str, long num) void write_raw_int32(std::ostream& str, int num) { #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ - str.write((const char*)&num, BINIO_32BIT); + str.write(reinterpret_cast(&num), Binio::BIT32); #else char byte; - for (long i = 0; i < BINIO_32BIT; i++) { + for (long i = 0; i < Binio::BIT32; i++) { byte = num >> 8 * i; // serializing in little endian str.write(&byte, 1); // write byte out } @@ -106,12 +104,13 @@ void write_ntl_vec_long(std::ostream& str, const NTL::vec_long& vl, long intSize) { - assertTrue(intSize == BINIO_64BIT || intSize == BINIO_32BIT, + assertTrue(intSize == Binio::BIT64 || + intSize == Binio::BIT32, "intSize must be 32 or 64 bit for binary IO"); write_raw_int32(str, vl.length()); write_raw_int32(str, intSize); - if (intSize == BINIO_64BIT) { + if (intSize == Binio::BIT64) { for (long i = 0; i < vl.length(); i++) { write_raw_int(str, vl[i]); } @@ -126,7 +125,8 @@ void read_ntl_vec_long(std::istream& str, NTL::vec_long& vl) { int sizeOfVL = read_raw_int32(str); int intSize = read_raw_int32(str); - assertTrue(intSize == BINIO_64BIT || intSize == BINIO_32BIT, + assertTrue(intSize == Binio::BIT64 || + intSize == Binio::BIT32, "intSize must be 32 or 64 bit for binary IO"); // Remember to check and increase Vec before trying to fill it. @@ -134,7 +134,7 @@ void read_ntl_vec_long(std::istream& str, NTL::vec_long& vl) vl.SetLength(sizeOfVL); } - if (intSize == BINIO_64BIT) { + if (intSize == Binio::BIT64) { for (long i = 0; i < sizeOfVL; i++) { vl[i] = read_raw_int(str); } diff --git a/src/binio.h b/src/binio.h new file mode 100644 index 000000000..4170b7239 --- /dev/null +++ b/src/binio.h @@ -0,0 +1,235 @@ +/* Copyright (C) 2012-2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ +#ifndef HELIB_BINIO_H +#define HELIB_BINIO_H +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +namespace helib { + +struct Binio +{ + static constexpr int BIT32 = 4; + static constexpr int BIT64 = 8; + + static constexpr std::array VERSION_0_0_1_0 = {0, 0, 1, 0}; +}; + +struct EyeCatcher +{ + static constexpr int SIZE = 4; + // clang-format off + static constexpr std::array HEADER_BEGIN = {'|','H','E','['}; + static constexpr std::array HEADER_END = {']','H','E','|'}; + static constexpr std::array CONTEXT_BEGIN = {'|','C','N','['}; + static constexpr std::array CONTEXT_END = {']','C','N','|'}; + static constexpr std::array CTXT_BEGIN = {'|','C','X','['}; + static constexpr std::array CTXT_END = {']','C','X','|'}; + static constexpr std::array PK_BEGIN = {'|','P','K','['}; + static constexpr std::array PK_END = {']','P','K','|'}; + static constexpr std::array SK_BEGIN = {'|','S','K','['}; + static constexpr std::array SK_END = {']','S','K','|'}; + static constexpr std::array SKM_BEGIN = {'|','K','M','['}; + static constexpr std::array SKM_END = {']','K','M','|'}; + // clang-format on +}; + +template +inline constexpr char nameToStructId() +{ + static_assert(true, "Type without a struct id."); + return 0; // Should not reach. +} + +class Context; +class PubKey; +class SecKey; +class Ctxt; + +template <> +inline constexpr char nameToStructId() +{ + return 5; +} +template <> +inline constexpr char nameToStructId() +{ + return 10; +} +template <> +inline constexpr char nameToStructId() +{ + return 15; +} +template <> +inline constexpr char nameToStructId() +{ + return 20; +} + +// Already broken into bytes, thus should be the same written and read in bog +// or little endian. +template +struct SerializeHeader +{ + // Header eye catcher + const std::array beginCatcher = + EyeCatcher::HEADER_BEGIN; + // 32 bit number: 8 bits for major, minor, patch, fix + const std::array version = Binio::VERSION_0_0_1_0; + // The helib version that output this header. + const std::array helibVersion = {version::major, + version::minor, + version::patch, + 0}; + // ObjectType + char structId = nameToStructId(); + // Reserved for future use + const char reserved[7] = {0, 0, 0, 0, 0, 0, 0}; + // End + const std::array endCatcher = EyeCatcher::HEADER_END; + + void writeTo(std::ostream& os) + { + os.write(reinterpret_cast(this), sizeof(*this)); + } + + static SerializeHeader readFrom(std::istream& is) + { + SerializeHeader header; + + // Broken in bytes, should be the same written and read in bog or little + // endian. + is.read(reinterpret_cast(&header), sizeof(header)); + + // Checks + if (header.beginCatcher != EyeCatcher::HEADER_BEGIN || + header.endCatcher != EyeCatcher::HEADER_END) { + + std::ostringstream oss; + oss << "Eye catchers for header mismatch '"; + oss.write(header.beginCatcher.data(), EyeCatcher::SIZE); + oss << ", "; + oss.write(header.endCatcher.data(), EyeCatcher::SIZE); + oss << "' (begin, end)."; + throw IOError(oss.str()); + } + + return header; + } + + std::string versionString() const + { + // version has only 4 numbers. + return std::to_string(version[0]) + "." + std::to_string(version[1]) + "." + + std::to_string(version[2]) + "." + std::to_string(version[3]); + } +}; + +/* Some utility functions for binary IO */ + +bool readEyeCatcher(std::istream& str, + const std::array& expect); +void writeEyeCatcher(std::ostream& str, + const std::array& eye); + +void write_ntl_vec_long(std::ostream& str, + const NTL::vec_long& vl, + long intSize = Binio::BIT64); +void read_ntl_vec_long(std::istream& str, NTL::vec_long& vl); + +long read_raw_int(std::istream& str); +int read_raw_int32(std::istream& str); +void write_raw_int(std::ostream& str, long num); +void write_raw_int32(std::ostream& str, int num); + +void write_raw_double(std::ostream& str, const double d); +double read_raw_double(std::istream& str); + +void write_raw_xdouble(std::ostream& str, const NTL::xdouble xd); +NTL::xdouble read_raw_xdouble(std::istream& str); + +void write_raw_ZZ(std::ostream& str, const NTL::ZZ& zz); +void read_raw_ZZ(std::istream& str, NTL::ZZ& zz); + +template +void write_raw_vector(std::ostream& str, const std::vector& v) +{ + write_raw_int(str, v.size()); + + for (const T& n : v) { + n.writeTo(str); + } +} + +// vector has a different implementation, since long.write does not work +template <> +void write_raw_vector(std::ostream& str, const std::vector& v); + +// vector has a different implementation, since double.write does not +// work +template <> +void write_raw_vector(std::ostream& str, const std::vector& v); + +template +void read_raw_vector(std::istream& str, std::vector& v, T& init) +{ + long sz = read_raw_int(str); + v.resize(sz, init); // Make space in vector + + for (auto& n : v) { + n.read(str); + } +} + +// FIXME: Change other method adding _inplace or this to read_return to +// distinguish them +template +std::vector read_raw_vector(std::istream& str, const CTy& ctx) +{ + std::vector v; + long sz = read_raw_int(str); + v.reserve(sz); // Make space in vector + + for (long i = 0; i < sz; i++) { + v.emplace_back(T::readFrom(str, ctx)); + } + + return v; +} + +template +void read_raw_vector(std::istream& str, std::vector& v) +{ + read_raw_vector(str, v, T()); +} + +// vector has a different implementation, since long.read does not work +template <> +void read_raw_vector(std::istream& str, std::vector& v); + +// vector has a different implementation, since double.read does not +// work +template <> +void read_raw_vector(std::istream& str, std::vector& v); + +} // namespace helib +#endif // ifndef HELIB_BINIO_H diff --git a/src/debugging.cpp b/src/debugging.cpp index 709158654..c361fd62f 100644 --- a/src/debugging.cpp +++ b/src/debugging.cpp @@ -16,7 +16,6 @@ #include #include #include -//#include namespace helib { @@ -59,7 +58,7 @@ NTL::xdouble embeddingLargestCoeff(const Ctxt& ctxt, const SecKey& sk) const Context& context = ctxt.getContext(); NTL::ZZX p, pp; sk.Decrypt(p, ctxt, pp); - return embeddingLargestCoeff(pp, context.zMStar); + return embeddingLargestCoeff(pp, context.getZMStar()); } void decryptAndPrint(std::ostream& s, @@ -75,7 +74,7 @@ void decryptAndPrint(std::ostream& s, NTL::xdouble modulus = NTL::xexp(context.logOfProduct(ctxt.getPrimeSet())); NTL::xdouble actualNoise = - embeddingLargestCoeff(pp, ctxt.getContext().zMStar); + embeddingLargestCoeff(pp, ctxt.getContext().getZMStar()); NTL::xdouble noiseEst = ctxt.totalNoiseBound(); s << "plaintext space mod " << ctxt.getPtxtSpace() diff --git a/src/extractDigits.cpp b/src/extractDigits.cpp index 4caa8eefc..c2a484a68 100644 --- a/src/extractDigits.cpp +++ b/src/extractDigits.cpp @@ -74,7 +74,7 @@ void extractDigits(std::vector& digits, const Ctxt& c, long r) if (r <= 0 || r > rr) r = rr; // how many digits to extract - long p = context.zMStar.getP(); + long p = context.getP(); NTL::ZZX x2p; if (p > 3) { @@ -229,7 +229,7 @@ void extendExtractDigits(std::vector& digits, { const Context& context = c.getContext(); - long p = context.zMStar.getP(); + long p = context.getP(); NTL::ZZX x2p; if (p > 3) { buildDigitPolynomial(x2p, p, r); diff --git a/src/io.cpp b/src/io.cpp new file mode 100644 index 000000000..27d902fce --- /dev/null +++ b/src/io.cpp @@ -0,0 +1,83 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include +#include +#include "io.h" +#include + +namespace NTL { + +void to_json(json& j, const NTL::xdouble& num) +{ + // e.g. 'stdev': {'mantissa': 10, 'exponent': 9 } + j = {{"mantissa", num.mantissa()}, {"exponent", num.exponent()}}; +} + +void from_json(const json& j, NTL::xdouble& num) +{ + num.x = j.at("mantissa"); + num.e = j.at("exponent"); +} + +void to_json(json& j, const NTL::ZZ& num) +{ + std::stringstream str; + str << num; + j = {{"number", str.str()}}; +} + +void from_json(const json& j, NTL::ZZ& num) +{ + std::stringstream str; + str << j.at("number").get(); + str >> num; +} + +void to_json(json& j, const NTL::Vec& vec) +{ + j = helib::convert>(vec); +} + +void from_json(const json& j, NTL::Vec& vec) +{ + std::vector repr = j; + vec = helib::convert>(repr); +} + +void to_json(json& j, const NTL::ZZX& poly) +{ + if (poly == NTL::ZZX::zero()) { + // Avoid string "[]" for zero ZZX. + j = std::vector(1, 0); + } else { + j = helib::convert>(poly.rep); + } +} + +void from_json(const json& j, NTL::ZZX& poly) +{ + if (j.is_number()) { + poly = j.get(); + return; + } else { + for (std::size_t i = 0; i < j.size(); ++i) { + if (j[i].is_number_float()) { + throw helib::IOError("Bad NTL::ZZX JSON serialization. Expected an " + "integer number, got a floating-point."); + } + NTL::SetCoeff(poly, i, j[i].get()); + } + } +} + +} // namespace NTL diff --git a/src/io.h b/src/io.h new file mode 100644 index 000000000..7878e3589 --- /dev/null +++ b/src/io.h @@ -0,0 +1,210 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#ifndef HELIB_IO_H +#define HELIB_IO_H +/** + * @file IO.h + * @brief - Internal header (not installed) containing convenience functions for + * ASCII serialization (using JSON). + * + * Copyright IBM Corporation 2020 All rights reserved. + */ + +#include + +#include +using json = ::nlohmann::json; + +#include +#include + +#include +#include +#include + +// For our convenience, this helps us. +namespace NTL { +void to_json(json& j, const NTL::xdouble& num); +void from_json(const json& j, NTL::xdouble& num); + +void to_json(json& j, const NTL::ZZ& num); +void from_json(const json& j, NTL::ZZ& num); + +void to_json(json& j, const NTL::Vec& vec); +void from_json(const json& j, NTL::Vec& vec); + +void to_json(json& j, const NTL::ZZX& poly); +void from_json(const json& j, NTL::ZZX& poly); +} // namespace NTL + +namespace std { +template +inline void to_json(json& j, const std::complex& num) +{ + // e.g. 'stdev': {'real': 10.1, 'imag': 9.3 } + j = {num.real(), num.imag()}; +} + +// Permissive JSON to std::complex function. I accepts single numbers, +// or a JSON object containing a real and/or imag part. +// Fails if the json value is not convertible to the type T. +template +inline void from_json(const json& j, std::complex& num) +{ + num.real(0); + num.imag(0); + + if (j.is_number()) { + // Set only the imaginary part + num.real(j.get()); + return; + } else { + if (j.size() > 2) { + throw helib::IOError("Bad complex JSON serialization. Expected a maximum " + "of 2 elements, recieved " + + std::to_string(j.size())); + } + if (j.size() == 0) { + return; + } + num.real(j[0].get()); + if (j.size() == 2) { + num.imag(j[1].get()); + } + } +} +} // namespace std + +namespace helib { + +class Context; + +inline const std::string_view jsonSerializationVersion = "0.0.1"; + +inline JsonWrapper wrap(const json& j) +{ + return JsonWrapper(std::make_any(j)); +} + +inline json unwrap(const JsonWrapper& jwrap) +{ + try { + return std::any_cast(jwrap.getJSONobj()); + } catch (const std::bad_any_cast& e) { + throw LogicError(std::string("Cannot unwrap wrapper. Bad cast ") + + e.what()); + } +} + +template +inline std::vector readVectorFromJSON(const json::array_t& j) +{ + std::vector v; + v.reserve(j.size()); + + for (const auto& e : j) { + v.emplace_back(T::readFromJSON(wrap(e))); + } + + return v; +} + +template +inline std::vector readVectorFromJSON(const json::array_t& j, + const TArgs&... args) +{ + std::vector v; + v.reserve(j.size()); + + for (const auto& e : j) { + v.emplace_back(T::readFromJSON(wrap(e), args...)); + } + + return v; +} + +template +inline void readVectorFromJSON(const json::array_t& j, + std::vector& v, + T& init) +{ + std::vector jvec = j; + + v.resize(jvec.size(), init); // Make space in vector + + for (std::size_t i = 0; i < jvec.size(); i++) { + v[i].readJSON(wrap(jvec[i])); + } +} + +template +inline json writeVectorToJSON(const std::vector& ts) +{ + std::vector js; + for (const auto& t : ts) { + js.emplace_back(unwrap(t.writeToJSON())); + } + return js; +} + +template +static inline json toTypedJson(const json& tc) +{ + return {{"type", T::typeName}, + {"HElibVersion", version::asString}, + {"serializationVersion", jsonSerializationVersion}, + {"content", tc}}; +} + +template +static inline json fromTypedJson(const json& j) +{ + std::string obj_ser_ver = j.at("serializationVersion").get(); + if (obj_ser_ver != jsonSerializationVersion) { + std::stringstream sstr; + sstr << "Serialization version mismatch. Expected: " + << jsonSerializationVersion << " actual: " << obj_ser_ver; + throw IOError(sstr.str()); + } + + std::string obj_helib_ver = j.at("HElibVersion").get(); + if (obj_helib_ver != version::asString) { + std::stringstream sstr; + sstr << "HElib version mismatch. Expected: " << version::asString + << " actual: " << obj_helib_ver; + throw IOError(sstr.str()); + } + + std::string obj_ty = j.at("type").get(); + if (obj_ty != T::typeName) { + std::stringstream fmt; + fmt << "Type mismatch deserializing json object." + << " Expected: " << T::typeName << " actual: " << obj_ty; + throw IOError(fmt.str()); + } + return j.at("content"); +} + +template +inline T executeRedirectJsonError(const TCALL& f) +{ + try { + return f(); + } catch (const nlohmann::detail::exception& e) { + throw IOError(std::string("Error with JSON IO. ") + e.what()); + } +} + +} // namespace helib + +#endif // HELIB_IO_H diff --git a/src/keySwitching.cpp b/src/keySwitching.cpp index 202998bdf..d2604f0e4 100644 --- a/src/keySwitching.cpp +++ b/src/keySwitching.cpp @@ -19,7 +19,9 @@ #include #include -#include +#include "binio.h" +#include "io.h" + #include #include #include @@ -102,13 +104,13 @@ void KeySwitch::verify(SecKey& sk) std::cout << "KeySwitch::verify: bad context " << i << "\n"; } - std::cout << "context.ctxtPrimes = " << context.ctxtPrimes << "\n"; - std::cout << "context.specialPrimes = " << context.specialPrimes << "\n"; + std::cout << "context.ctxtPrimes = " << context.getCtxtPrimes() << "\n"; + std::cout << "context.specialPrimes = " << context.getSpecialPrimes() << "\n"; IndexSet fullPrimes = context.fullPrimes(); // ctxtPrimes | specialPrimes; std::cout << "digits: "; for (long i = 0; i < n; i++) - std::cout << context.digits[i] << " "; + std::cout << context.getDigit(i) << " "; std::cout << "\n"; std::cout << "IndexSets of b: "; @@ -151,9 +153,9 @@ void KeySwitch::verify(SecKey& sk) _toKey.toPoly(ToKey, fullPrimes); NTL::ZZ Q = context.productOfPrimes(fullPrimes); - NTL::ZZ prod = context.productOfPrimes(context.specialPrimes); + NTL::ZZ prod = context.productOfPrimes(context.getSpecialPrimes()); NTL::ZZX C, D; - NTL::ZZX PhimX = context.zMStar.getPhimX(); + NTL::ZZX PhimX = context.getZMStar().getPhimX(); long nb = 0; for (long i = 0; i < n; i++) { @@ -166,7 +168,7 @@ void KeySwitch::verify(SecKey& sk) if (NumBits(coeff(D, j)) > nb) nb = NumBits(coeff(D, j)); } - prod *= context.productOfPrimes(context.digits[i]); + prod *= context.productOfPrimes(context.getDigit(i)); } std::cout << "error ratio: " << ((double)nb) / ((double)NumBits(Q)) << "\n"; @@ -180,11 +182,7 @@ const KeySwitch& KeySwitch::dummy() std::ostream& operator<<(std::ostream& str, const KeySwitch& matrix) { - str << "[" << matrix.fromKey << " " << matrix.toKeyID << " " - << matrix.ptxtSpace << " " << matrix.b.size() << std::endl; - for (long i = 0; i < (long)matrix.b.size(); i++) - str << matrix.b[i] << std::endl; - str << matrix.prgSeed << " " << matrix.noiseBound << "]"; + matrix.writeToJSON(str); return str; } @@ -192,24 +190,12 @@ std::ostream& operator<<(std::ostream& str, const KeySwitch& matrix) // matrix) void KeySwitch::readMatrix(std::istream& str, const Context& context) { - seekPastChar(str, '['); // defined in NumbTh.cpp - str >> fromKey; - str >> toKeyID; - str >> ptxtSpace; - - long nDigits; - str >> nDigits; - b.resize(nDigits, DoubleCRT(context, IndexSet::emptySet())); - for (long i = 0; i < nDigits; i++) - str >> b[i]; - str >> prgSeed; - str >> noiseBound; - seekPastChar(str, ']'); + this->readJSON(str, context); } -void KeySwitch::write(std::ostream& str) const +void KeySwitch::writeTo(std::ostream& str) const { - writeEyeCatcher(str, BINIO_EYE_SKM_BEGIN); + writeEyeCatcher(str, EyeCatcher::SKM_BEGIN); /* Write out raw 1. SKHandle fromKey; @@ -220,7 +206,7 @@ void KeySwitch::write(std::ostream& str) const 6. xdouble noiseBound; */ - fromKey.write(str); + fromKey.writeTo(str); write_raw_int(str, toKeyID); write_raw_int(str, ptxtSpace); @@ -229,24 +215,83 @@ void KeySwitch::write(std::ostream& str) const write_raw_ZZ(str, prgSeed); write_raw_xdouble(str, noiseBound); - writeEyeCatcher(str, BINIO_EYE_SKM_END); + writeEyeCatcher(str, EyeCatcher::SKM_END); +} + +KeySwitch KeySwitch::readFrom(std::istream& str, const Context& context) +{ + bool eyeCatcherFound = readEyeCatcher(str, EyeCatcher::SKM_BEGIN); + assertTrue(eyeCatcherFound, "Could not find pre-secret key eyecatcher"); + + KeySwitch ret; + + ret.fromKey = SKHandle::readFrom(str); + ret.toKeyID = read_raw_int(str); + ret.ptxtSpace = read_raw_int(str); + ret.b = read_raw_vector(str, context); + read_raw_ZZ(str, ret.prgSeed); + ret.noiseBound = read_raw_xdouble(str); + + eyeCatcherFound = readEyeCatcher(str, EyeCatcher::SKM_END); + assertTrue(eyeCatcherFound, "Could not find post-secret key eyecatcher"); + + return ret; +} + +void KeySwitch::writeToJSON(std::ostream& str) const { str << writeToJSON(); } + +JsonWrapper KeySwitch::writeToJSON() const +{ + /* + * Write out raw + * 1. SKHandle fromKey; + * 2. long toKeyID; + * 3. long ptxtSpace; + * 4. vector b; + * 5. ZZ prgSeed; + * 6. xdouble noiseBound; + */ + json j = {{"fromKey", unwrap(this->fromKey.writeToJSON())}, + {"toKeyID", this->toKeyID}, + {"ptxtSpace", this->ptxtSpace}, + {"b", writeVectorToJSON(b)}, + {"prgSeed", prgSeed}, + {"noiseBound", noiseBound}}; + + return wrap(toTypedJson(j)); } -void KeySwitch::read(std::istream& str, const Context& context) +KeySwitch KeySwitch::readFromJSON(std::istream& str, const Context& context) { - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_SKM_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-secret key eyecatcher"); - - fromKey.read(str); - toKeyID = read_raw_int(str); - ptxtSpace = read_raw_int(str); - DoubleCRT blankDCRT(context, IndexSet::emptySet()); - read_raw_vector(str, b, blankDCRT); - read_raw_ZZ(str, prgSeed); - noiseBound = read_raw_xdouble(str); - - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_SKM_END); - assertEq(eyeCatcherFound, 0, "Could not find post-secret key eyecatcher"); + json j; + str >> j; + return KeySwitch::readFromJSON(wrap(j), context); +} + +KeySwitch KeySwitch::readFromJSON(const JsonWrapper& jw, const Context& context) +{ + KeySwitch res; + res.readJSON(jw, context); + return res; +} + +void KeySwitch::readJSON(std::istream& str, const Context& context) +{ + json j; + str >> j; + this->readJSON(wrap(j), context); +} + +void KeySwitch::readJSON(const JsonWrapper& jw, const Context& context) +{ + json j = fromTypedJson(unwrap(jw)); + + this->fromKey = SKHandle::readFromJSON(wrap(j.at("fromKey"))); + this->toKeyID = j.at("toKeyID"); + this->ptxtSpace = j.at("ptxtSpace"); + this->b = readVectorFromJSON(j.at("b"), context); + this->prgSeed = j.at("prgSeed").get(); + this->noiseBound = j.at("noiseBound").get(); } long KSGiantStepSize(long D) @@ -262,11 +307,11 @@ long KSGiantStepSize(long D) void addAllMatrices(SecKey& sKey, long keyID) { const Context& context = sKey.getContext(); - long m = context.zMStar.getM(); + long m = context.getM(); // key-switching matrices for the automorphisms for (long i = 0; i < m; i++) { - if (!context.zMStar.inZmStar(i)) + if (!context.getZMStar().inZmStar(i)) continue; sKey.GenKeySWmatrix(1, i, keyID, keyID); } @@ -303,7 +348,7 @@ void addAllMatrices(SecKey& sKey, long keyID) static void add1Dmats4dim(SecKey& sKey, long i, long keyID) { const Context &context = sKey.getContext(); - long m = context.zMStar.getM(); + long m = context.getM(); computeParams(context,m,i); // defines vars: native, ord, gi, g2md, giminv, g2mdminv /* MAUTO std::vector vals; */ @@ -335,7 +380,7 @@ static void add1Dmats4dim(SecKey& sKey, long i, long keyID) // so it is best to avoid that). static void add1Dmats4dim(SecKey& sKey, long i, long keyID) { - const PAlgebra& zMStar = sKey.getContext().zMStar; + const PAlgebra& zMStar = sKey.getContext().getZMStar(); long ord; bool native; @@ -485,7 +530,7 @@ static void addSome1Dmats4dim(SecKey& sKey, UNUSED long bound, long keyID) { - const PAlgebra& zMStar = sKey.getContext().zMStar; + const PAlgebra& zMStar = sKey.getContext().getZMStar(); long ord; bool native; @@ -530,9 +575,9 @@ void addSome1DMatrices(SecKey& sKey, long bound, long keyID) const Context& context = sKey.getContext(); // key-switching matrices for the automorphisms - for (long i : range(context.zMStar.numOfGens())) { + for (long i : range(context.getZMStar().numOfGens())) { // For generators of small order, add all the powers - if (bound >= context.zMStar.OrderOf(i)) + if (bound >= context.getZMStar().OrderOf(i)) add1Dmats4dim(sKey, i, keyID); else // For generators of large order, add only some of the powers addSome1Dmats4dim(sKey, i, bound, keyID); @@ -554,7 +599,7 @@ void addBSGS1DMatrices(SecKey& sKey, long keyID) void addSomeFrbMatrices(SecKey& sKey, long bound, long keyID) { const Context& context = sKey.getContext(); - if (bound >= LONG(context.zMStar.getOrdP())) + if (bound >= LONG(context.getOrdP())) add1Dmats4dim(sKey, -1, keyID); else // For generators of large order, add only some of the powers addSome1Dmats4dim(sKey, -1, bound, keyID); @@ -574,7 +619,7 @@ void addBSGSFrbMatrices(SecKey& sKey, long keyID) static void addMinimal1Dmats4dim(SecKey& sKey, long i, long keyID) { - const PAlgebra& zMStar = sKey.getContext().zMStar; + const PAlgebra& zMStar = sKey.getContext().getZMStar(); long ord; bool native; @@ -605,7 +650,7 @@ void addMinimal1DMatrices(SecKey& sKey, long keyID) const Context& context = sKey.getContext(); // key-switching matrices for the automorphisms - for (long i : range(context.zMStar.numOfGens())) { + for (long i : range(context.getZMStar().numOfGens())) { addMinimal1Dmats4dim(sKey, i, keyID); } sKey.setKeySwitchMap(); // re-compute the key-switching map @@ -622,12 +667,12 @@ void addMinimalFrbMatrices(SecKey& sKey, long keyID) void addMatrices4Network(SecKey& sKey, const PermNetwork& net, long keyID) { const Context& context = sKey.getContext(); - long m = context.zMStar.getM(); + long m = context.getM(); for (long i = 0; i < net.depth(); i++) { long e = net.getLayer(i).getE(); long gIdx = net.getLayer(i).getGenIdx(); - long g = context.zMStar.ZmStarGen(gIdx); + long g = context.getZMStar().ZmStarGen(gIdx); long g2e = NTL::PowerMod(g, e, m); // g^e mod m const NTL::Vec& shamts = net.getLayer(i).getShifts(); for (long j = 0; j < shamts.length(); j++) { diff --git a/src/keys.cpp b/src/keys.cpp index 8d31e59b2..7d3a2dfd3 100644 --- a/src/keys.cpp +++ b/src/keys.cpp @@ -15,7 +15,7 @@ #include #include #include -#include +#include "binio.h" #include #include #include @@ -23,6 +23,8 @@ #include #include "internal_symbols.h" // DECRYPT_ON_PWFL_BASIS +#include "io.h" + namespace helib { /******** Utility function to generate RLWE instances *********/ @@ -38,10 +40,10 @@ double RLWE1(DoubleCRT& c0, const DoubleCRT& c1, const DoubleCRT& s, long p) "Cannot generate RLWE instance with nonpositive p"); // Used with p=1 for // CKKS, p>=2 for BGV const Context& context = s.getContext(); - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); // choose a short error e - double stdev = to_double(context.stdev); + double stdev = to_double(context.getStdev()); if (palg.getPow2() == 0) // not power of two stdev *= sqrt(palg.getM()); double bound = c0.sampleGaussianBounded(stdev); @@ -79,12 +81,6 @@ double RLWE(DoubleCRT& c0, /********************************************************************/ // Computes the keySwitchMap pointers, using breadth-first search (BFS) -PubKey::PubKey() : - context(*activeContext), pubEncrKey(*this), recryptEkey(*this) -{ - recryptKeyID = -1; -} - PubKey::PubKey(const Context& _context) : context(_context), pubEncrKey(*this), recryptEkey(*this) { @@ -123,7 +119,7 @@ void PubKey::setKeySwitchMap(long keyId) 0l, (long)skBounds.size(), "No such key found"); // Sanity-check, do we have such a key? - long m = context.zMStar.getM(); + long m = context.getM(); // Initialize an array of "edges" (this is easier than searching through // all the matrices for every step). This is a list of all the powers n @@ -395,8 +391,8 @@ long PubKey::Encrypt(Ctxt& ctxt, // that the coefficients of the ciphertext are uniformly // and independently chosen from the interval [-p/2, p/2]. - DoubleCRT e(context, context.ctxtPrimes); - DoubleCRT r(context, context.ctxtPrimes); + DoubleCRT e(context, context.getCtxtPrimes()); + DoubleCRT r(context, context.getCtxtPrimes()); double r_bound = r.sampleSmallBounded(); ctxt.noiseBound += r_bound * pubEncrKey.noiseBound; @@ -404,9 +400,9 @@ long PubKey::Encrypt(Ctxt& ctxt, // std::cerr << "*** r_bound*pubEncrKey.noiseBound " << r_bound * // pubEncrKey.noiseBound << "\n"; - double stdev = to_double(context.stdev); - if (context.zMStar.getPow2() == 0) // not power of two - stdev *= sqrt(context.zMStar.getM()); + double stdev = to_double(context.getStdev()); + if (context.getZMStar().getPow2() == 0) // not power of two + stdev *= sqrt(context.getM()); for (size_t i = 0; i < ctxt.parts.size(); i++) { // add noise to all the parts ctxt.parts[i] *= r; @@ -417,7 +413,7 @@ long PubKey::Encrypt(Ctxt& ctxt, // [-Q/(8*ptxtSpace)..Q/(8*ptxtSpace)] NTL::ZZ B; - B = context.productOfPrimes(context.ctxtPrimes); + B = context.productOfPrimes(context.getCtxtPrimes()); B /= (ptxtSpace * 8); e_bound = e.sampleUniform(B); @@ -454,14 +450,13 @@ long PubKey::Encrypt(Ctxt& ctxt, // NOTE: this is a heuristic, as the ptxt is not really random. // although, when ptxtSpace == 2, the balanced_MulMod will // randomize it - double ptxt_bound = - context.noiseBoundForMod(ptxtSpace, context.zMStar.getPhiM()); + double ptxt_bound = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); // FIXME: for now, we print out a warning, but we can consider // implementing a more robust randomization and rejection sampling // strategy. double ptxt_sz = - NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.zMStar)); + NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.getZMStar())); if (ptxt_sz > ptxt_bound) { Warning("noise bound exceeded in encryption"); @@ -509,10 +504,10 @@ void PubKey::CKKSencrypt(Ctxt& ctxt, if (ptxtSize <= 0) ptxtSize = 1.0; if (scaling <= 0) // assume the default scaling factor - scaling = getContext().ea->getCx().encodeScalingFactor() / ptxtSize; + scaling = getContext().getEA().getCx().encodeScalingFactor() / ptxtSize; - long m = context.zMStar.getM(); - long prec = getContext().alMod.getPPowR(); + long m = context.getM(); + long prec = getContext().getAlMod().getPPowR(); // generate a random encryption of zero from the public encryption key ctxt = pubEncrKey; // already an encryption of zero, just not a random one @@ -535,16 +530,16 @@ void PubKey::CKKSencrypt(Ctxt& ctxt, // factor. The extra factor ef is set as ceil(error_bound*prec/f), // so that we have ef*f >= error_bound*prec. - DoubleCRT e(context, context.ctxtPrimes); - DoubleCRT r(context, context.ctxtPrimes); + DoubleCRT e(context, context.getCtxtPrimes()); + DoubleCRT r(context, context.getCtxtPrimes()); double r_bound = r.sampleSmallBounded(); // r is a {0,+-1} polynomial NTL::xdouble error_bound = r_bound * pubEncrKey.noiseBound; // VJS-NOTE: why don't the error bounds include the encoding error? - double stdev = to_double(context.stdev); - if (context.zMStar.getPow2() == 0) // not power of two + double stdev = to_double(context.getStdev()); + if (context.getZMStar().getPow2() == 0) // not power of two stdev *= sqrt(m); for (size_t i = 0; i < ctxt.parts.size(); i++) { @@ -561,6 +556,7 @@ void PubKey::CKKSencrypt(Ctxt& ctxt, } error_bound += e_bound; } + // Compute the extra scaling factor, if needed long ef = NTL::conv(ceil(error_bound * prec / (scaling * ptxtSize))); if (ef > 1) { // scale up some more @@ -569,6 +565,7 @@ void PubKey::CKKSencrypt(Ctxt& ctxt, } else { // no need for extra scaling ctxt.parts[0] += ptxt; } + // Round size to next power of two so as not to leak too much ctxt.ptxtMag = EncryptedArrayCx::roundedSize(ptxtSize); ctxt.ratFactor = scaling; @@ -593,6 +590,7 @@ long PubKey::Encrypt(Ctxt& ciphertxt, { return Encrypt(ciphertxt, plaintxt, ptxtSpace, /*highNoise=*/false); } + long PubKey::Encrypt(Ctxt& ciphertxt, const zzX& plaintxt, long ptxtSpace) const { return Encrypt(ciphertxt, plaintxt, ptxtSpace, /*highNoise=*/false); @@ -680,8 +678,8 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_BGV& eptxt) const // that the coefficients of the ciphertext are uniformly // and independently chosen from the interval [-p/2, p/2]. - DoubleCRT e(context, context.ctxtPrimes); - DoubleCRT r(context, context.ctxtPrimes); + DoubleCRT e(context, context.getCtxtPrimes()); + DoubleCRT r(context, context.getCtxtPrimes()); double r_bound = r.sampleSmallBounded(); ctxt.noiseBound += r_bound * pubEncrKey.noiseBound; @@ -689,9 +687,9 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_BGV& eptxt) const // std::cerr << "*** r_bound*pubEncrKey.noiseBound " << r_bound * // pubEncrKey.noiseBound << "\n"; - double stdev = to_double(context.stdev); - if (context.zMStar.getPow2() == 0) // not power of two - stdev *= sqrt(context.zMStar.getM()); + double stdev = to_double(context.getStdev()); + if (context.getZMStar().getPow2() == 0) // not power of two + stdev *= sqrt(context.getM()); for (size_t i = 0; i < ctxt.parts.size(); i++) { // add noise to all the parts ctxt.parts[i] *= r; @@ -726,14 +724,13 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_BGV& eptxt) const // NOTE: this is a heuristic, as the ptxt is not really random. // although, when ptxtSpace == 2, the balanced_MulMod will // randomize it - double ptxt_bound = - context.noiseBoundForMod(ptxtSpace, context.zMStar.getPhiM()); + double ptxt_bound = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); // FIXME: for now, we print out a warning, but we can consider // implementing a more robust randomization and rejection sampling // strategy. double ptxt_sz = - NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.zMStar)); + NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.getZMStar())); if (ptxt_sz > ptxt_bound) { Warning("noise bound exceeded in encryption"); @@ -772,7 +769,7 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_CKKS& eptxt) const assertTrue(scale > 0, "CKKS encryption: scale <= 0"); assertTrue(err > 0, "CKKS encryption: err <= 0"); - long m = context.zMStar.getM(); + long m = context.getM(); // generate a random encryption of zero from the public encryption key ctxt = pubEncrKey; // already an encryption of zero, just not a random one @@ -797,17 +794,17 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_CKKS& eptxt) const // the scaled noise added by encryption is less than the scaled // noise already present in the encoded ptxt. - DoubleCRT e(context, context.ctxtPrimes); - DoubleCRT r(context, context.ctxtPrimes); + DoubleCRT e(context, context.getCtxtPrimes()); + DoubleCRT r(context, context.getCtxtPrimes()); double r_bound = r.sampleSmallBounded(); // r is a {0,+-1} polynomial NTL::xdouble error_bound = r_bound * pubEncrKey.noiseBound; - double stdev = to_double(context.stdev); + double stdev = to_double(context.getStdev()); // VJS-NOTE: this should never happen for CKKS - if (context.zMStar.getPow2() == 0) // not power of two + if (context.getZMStar().getPow2() == 0) // not power of two stdev *= sqrt(m); for (size_t i = 0; i < ctxt.parts.size(); i++) { @@ -860,7 +857,7 @@ void PubKey::Encrypt(Ctxt& ctxt, const EncodedPtxt& eptxt) const bool PubKey::isCKKS() const { - return (getContext().alMod.getTag() == PA_cx_tag); + return (getContext().getAlMod().getTag() == PA_cx_tag); } // NOTE: Is taking the alMod from the context the right thing to do? @@ -868,101 +865,23 @@ bool PubKey::isBootstrappable() const { return (recryptKeyID >= 0); } std::ostream& operator<<(std::ostream& str, const PubKey& pk) { - str << "["; - writeContextBase(str, pk.getContext()); - - // output the public encryption key itself - str << pk.pubEncrKey << std::endl; - - // output skBounds in the same format as vec_double - str << "["; - for (long i = 0; i < (long)pk.skBounds.size(); i++) - str << pk.skBounds[i] << " "; - str << "]\n"; - - // output the key-switching matrices - str << pk.keySwitching.size() << std::endl; - for (long i = 0; i < (long)pk.keySwitching.size(); i++) - str << pk.keySwitching[i] << std::endl; - - // output keySwitchMap in the same format as vec_vec_long - str << "["; - for (long i = 0; i < (long)pk.keySwitchMap.size(); i++) { - str << "["; - for (long j = 0; j < (long)pk.keySwitchMap[i].size(); j++) - str << pk.keySwitchMap[i][j] << " "; - str << "]\n "; - } - str << "]\n"; - - str << pk.KS_strategy << "\n"; - - // output the bootstrapping key, if any - str << pk.recryptKeyID << " "; - if (pk.recryptKeyID >= 0) - str << pk.recryptEkey << std::endl; - return str << "]"; + pk.writeToJSON(str); + return str; } std::istream& operator>>(std::istream& str, PubKey& pk) { pk.clear(); - // std::cerr << "PubKey["; - seekPastChar(str, '['); // defined in NumbTh.cpp - - // sanity check, verify that basic context parameters are correct - unsigned long m, p, r; - std::vector gens, ords; - readContextBase(str, m, p, r, gens, ords); - assertTrue(comparePAlgebra(pk.getContext().zMStar, m, p, r, gens, ords), - "PAlgebra mismatch"); - - // Get the public encryption key itself - str >> pk.pubEncrKey; - - // Get the vector of secret-key Hamming-weights - NTL::Vec vl; - str >> vl; - pk.skBounds.resize(vl.length()); - for (long i = 0; i < (long)pk.skBounds.size(); i++) - pk.skBounds[i] = vl[i]; - - // Get the key-switching matrices - long nMatrices; - str >> nMatrices; - pk.keySwitching.resize(nMatrices); - for (long i = 0; i < nMatrices; i++) // read the matrix from input str - pk.keySwitching[i].readMatrix(str, pk.getContext()); - - // Get the key-switching map - NTL::Vec> vvl; - str >> vvl; - pk.keySwitchMap.resize(vvl.length()); - for (long i = 0; i < (long)pk.keySwitchMap.size(); i++) { - pk.keySwitchMap[i].resize(vvl[i].length()); - for (long j = 0; j < (long)pk.keySwitchMap[i].size(); j++) - pk.keySwitchMap[i][j] = vvl[i][j]; - } - - // build the key-switching map for all keys - for (long i = pk.skBounds.size() - 1; i >= 0; i--) - pk.setKeySwitchMap(i); - - str >> pk.KS_strategy; - // Get the bootstrapping key, if any - str >> pk.recryptKeyID; - if (pk.recryptKeyID >= 0) - str >> pk.recryptEkey; + pk.readJSON(str); - seekPastChar(str, ']'); return str; } -void writePubKeyBinary(std::ostream& str, const PubKey& pk) +void PubKey::writeTo(std::ostream& str) const { - - writeEyeCatcher(str, BINIO_EYE_PK_BEGIN); + SerializeHeader().writeTo(str); + writeEyeCatcher(str, EyeCatcher::PK_BEGIN); // Write out for PubKey // 1. Context Base @@ -974,65 +893,171 @@ void writePubKeyBinary(std::ostream& str, const PubKey& pk) // 7. long recryptKeyID; // 8. Ctxt recryptEkey; - writeContextBaseBinary(str, pk.getContext()); - pk.pubEncrKey.write(str); - write_raw_vector(str, pk.skBounds); + this->getContext().writeTo(str); + this->pubEncrKey.writeTo(str); + write_raw_vector(str, this->skBounds); // Keyswitch Matrices - write_raw_vector(str, pk.keySwitching); + write_raw_vector(str, this->keySwitching); - long sz = pk.keySwitchMap.size(); + long sz = this->keySwitchMap.size(); write_raw_int(str, sz); - for (auto v : pk.keySwitchMap) + for (auto v : this->keySwitchMap) write_raw_vector(str, v); - write_ntl_vec_long(str, pk.KS_strategy); + write_ntl_vec_long(str, this->KS_strategy); - write_raw_int(str, pk.recryptKeyID); - pk.recryptEkey.write(str); + write_raw_int(str, this->recryptKeyID); + this->recryptEkey.writeTo(str); - writeEyeCatcher(str, BINIO_EYE_PK_END); + writeEyeCatcher(str, EyeCatcher::PK_END); } -void readPubKeyBinary(std::istream& str, PubKey& pk) +PubKey PubKey::readFrom(std::istream& str, const Context& context) { - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_PK_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-public key eyecatcher"); + const auto header = SerializeHeader::readFrom(str); + assertEq(header.version, + Binio::VERSION_0_0_1_0, + "Header: version " + header.versionString() + + " not supported"); + + bool eyeCatcherFound = readEyeCatcher(str, EyeCatcher::PK_BEGIN); + assertTrue(eyeCatcherFound, + "Could not find pre-public key eyecatcher"); // TODO code to check context object is what it should be same as the text IO. // May be worth putting it in helper func. // std::unique_ptr dummy = buildContextFromBinary(str); - unsigned long m, p, r; - std::vector gens, ords; - readContextBaseBinary(str, m, p, r, gens, ords); - assertTrue(comparePAlgebra(pk.getContext().zMStar, m, p, r, gens, ords), - "PAlgebra mismatch"); + + Context ser_context = Context::readFrom(str); + assertEq(context, ser_context, "Context mismatch"); + + PubKey ret(context); // Read in the rest - pk.pubEncrKey.read(str); - read_raw_vector(str, pk.skBounds); + ret.pubEncrKey.read(str); // Using in-place ctxt read function for performance + read_raw_vector(str, ret.skBounds); // Using in-place function for performance // Keyswitch Matrices - read_raw_vector(str, pk.keySwitching, pk.getContext()); + ret.keySwitching = read_raw_vector(str, context); long sz = read_raw_int(str); - pk.keySwitchMap.clear(); - pk.keySwitchMap.resize(sz); - for (auto& v : pk.keySwitchMap) + ret.keySwitchMap.clear(); + ret.keySwitchMap.resize(sz); + for (auto& v : ret.keySwitchMap) { read_raw_vector(str, v); + } - read_ntl_vec_long(str, pk.KS_strategy); + // TODO: Check with VJS if the following loop is really needed + for (long i = ret.skBounds.size() - 1; i >= 0; i--) { + ret.setKeySwitchMap(i); + } + + read_ntl_vec_long(str, ret.KS_strategy); + + ret.recryptKeyID = read_raw_int(str); + ret.recryptEkey.read(str); // Using in-place ctxt read function for + // performance + + eyeCatcherFound = readEyeCatcher(str, EyeCatcher::PK_END); + assertTrue(eyeCatcherFound, + "Could not find post-public key eyecatcher"); + + return ret; +} + +void PubKey::writeToJSON(std::ostream& str) const +{ + executeRedirectJsonError([&]() { str << writeToJSON(); }); +} + +JsonWrapper PubKey::writeToJSON() const +{ + auto body = [this]() { + json j = {{"context", unwrap(this->getContext().writeToJSON())}, + {"pubEncrKey", unwrap(this->pubEncrKey.writeToJSON())}, + {"skBounds", this->skBounds}, + {"keySwitching", writeVectorToJSON(keySwitching)}, + {"keySwitchMap", this->keySwitchMap}, + {"KS_strategy", this->KS_strategy}, + {"recryptKeyID", this->recryptKeyID}, + {"recryptEkey", + this->recryptKeyID >= 0 ? unwrap(this->recryptEkey.writeToJSON()) + : "nullptr"}}; + return wrap(toTypedJson(j)); + }; + return executeRedirectJsonError(body); +} + +PubKey PubKey::readFromJSON(std::istream& str, const Context& context) +{ + return executeRedirectJsonError([&]() { + json j; + str >> j; + return readFromJSON(wrap(j), context); + }); +} - pk.recryptKeyID = read_raw_int(str); - pk.recryptEkey.read(str); +PubKey PubKey::readFromJSON(const JsonWrapper& jw, const Context& context) +{ + PubKey pk{context}; + pk.readJSON(jw); + return pk; +} - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_PK_END); - assertEq(eyeCatcherFound, 0, "Could not find post-public key eyecatcher"); +void PubKey::readJSON(std::istream& str) +{ + executeRedirectJsonError([&]() { + json j; + str >> j; + readJSON(wrap(j)); + }); +} + +void PubKey::readJSON(const JsonWrapper& tjw) +{ + auto body = [&, this]() { + json j = fromTypedJson(unwrap(tjw)); + Context ser_context = Context::readFromJSON(wrap(j.at("context"))); + assertEq(context, ser_context, "Context mismatch"); + + this->clear(); + // std::cerr << "PubKey["; + + // Get the public encryption key itself + this->pubEncrKey.readJSON(wrap(j.at("pubEncrKey"))); + + // Get the vector of secret-key Hamming-weights + j.at("skBounds").get_to(this->skBounds); + + keySwitching = readVectorFromJSON(j.at("keySwitching"), context); + + // Get the key-switching map + this->keySwitchMap = + j.at("keySwitchMap").get>>(); + + // TODO: Check with VJS if the following loop is really needed + // build the key-switching map for all keys + for (long i = this->skBounds.size() - 1; i >= 0; i--) + this->setKeySwitchMap(i); + + this->KS_strategy = j.at("KS_strategy"); + + // Get the bootstrapping key, if any + this->recryptKeyID = j.at("recryptKeyID"); + if (this->recryptKeyID >= 0) { + this->recryptEkey.readJSON(wrap(j.at("recryptEkey"))); + } + }; + + executeRedirectJsonError(body); } /******************** SecKey implementation **********************/ /********************************************************************/ +SecKey::SecKey(const PubKey& pk) : PubKey(pk) {} + SecKey::SecKey(const Context& _context) : PubKey(_context) {} bool SecKey::operator==(const SecKey& other) const @@ -1071,18 +1096,18 @@ long SecKey::ImportSecKey(const DoubleCRT& sKey, { if (sKeys.empty()) { // 1st secret-key, generate corresponding public key if (ptxtSpace < 2) - ptxtSpace = isCKKS() ? 1 : context.alMod.getPPowR(); + ptxtSpace = isCKKS() ? 1 : context.getAlMod().getPPowR(); // default plaintext space is p^r for BGV, 1 for CKKS // allocate space, the parts are DoubleCRTs with all the ctxtPrimes - pubEncrKey.parts.assign(2, CtxtPart(context, context.ctxtPrimes)); + pubEncrKey.parts.assign(2, CtxtPart(context, context.getCtxtPrimes())); // Choose a new RLWE instance pubEncrKey.noiseBound = RLWE(pubEncrKey.parts[0], pubEncrKey.parts[1], sKey, ptxtSpace); if (isCKKS()) { pubEncrKey.ptxtMag = 0.0; pubEncrKey.ratFactor = pubEncrKey.noiseBound * - getContext().ea->getCx().encodeScalingFactor(); + getContext().getEA().getCx().encodeScalingFactor(); } // make parts[0],parts[1] point to (1,s) @@ -1090,7 +1115,7 @@ long SecKey::ImportSecKey(const DoubleCRT& sKey, pubEncrKey.parts[1].skHandle.setBase(); // Set the other Ctxt bookeeping parameters in pubEncrKey - pubEncrKey.primeSet = context.ctxtPrimes; + pubEncrKey.primeSet = context.getCtxtPrimes(); pubEncrKey.ptxtSpace = ptxtSpace; } skBounds.push_back(bound); // record the size of the new secret-key @@ -1106,9 +1131,10 @@ long SecKey::ImportSecKey(const DoubleCRT& sKey, long SecKey::GenSecKey(long ptxtSpace, long maxDegKswitch) { - long hwt = context.hwt_param; + long hwt = context.getHwt(); - DoubleCRT newSk(context, context.ctxtPrimes | context.specialPrimes); + DoubleCRT newSk(context, + context.getCtxtPrimes() | context.getSpecialPrimes()); if (hwt > 0) { // sample a Hamming-weight-hwt polynomial @@ -1155,15 +1181,17 @@ void SecKey::GenKeySWmatrix(long fromSPower, KeySwitch ksMatrix(fromSPower, fromXPower, fromIdx, toIdx); RandomBits(ksMatrix.prgSeed, 256); // a random 256-bit seed - long n = context.digits.size(); + long n = context.getDigits().size(); // size-n vector ksMatrix.b.resize( n, - DoubleCRT(context, context.ctxtPrimes | context.specialPrimes)); + DoubleCRT(context, context.getCtxtPrimes() | context.getSpecialPrimes())); std::vector a; - a.resize(n, DoubleCRT(context, context.ctxtPrimes | context.specialPrimes)); + a.resize( + n, + DoubleCRT(context, context.getCtxtPrimes() | context.getSpecialPrimes())); { RandomState state; @@ -1179,7 +1207,7 @@ void SecKey::GenKeySWmatrix(long fromSPower, if (p < 2) { if (context.isBootstrappable()) { // use larger bootstrapping plaintext space - p = context.rcData.alMod->getPPowR(); + p = context.getRcData().alMod->getPPowR(); } else { p = pubEncrKey.ptxtSpace; // default plaintext space from public key } @@ -1200,10 +1228,10 @@ void SecKey::GenKeySWmatrix(long fromSPower, ksMatrix.noiseBound = RLWE1(ksMatrix.b[i], a[i], toKey, p); } // Add in the multiples of the fromKey secret key - fromKey *= context.productOfPrimes(context.specialPrimes); + fromKey *= context.productOfPrimes(context.getSpecialPrimes()); for (long i = 0; i < n; i++) { ksMatrix.b[i] += fromKey; - fromKey *= context.productOfPrimes(context.digits[i]); + fromKey *= context.productOfPrimes(context.getDigit(i)); } // Push the new matrix onto our list @@ -1247,7 +1275,7 @@ void SecKey::Decrypt(Ptxt& plaintxt, assertTrue(&context == &plaintxt.getContext(), "Decrypt: inconsistent contexts"); - const View& view = context.getDefaultView(); + const View& view = context.getView(); std::vector> ptxt; view.decrypt(ciphertxt, *this, ptxt, prec); plaintxt.setData(ptxt); @@ -1308,7 +1336,8 @@ void SecKey::Decrypt(NTL::ZZX& plaintxt, if (!ciphertxt.isCorrect()) { std::string message = "Decrypting with too much noise"; - // TODO: Turn the following preprocessor logics into a warnOrThrow function + +// TODO: Turn the following preprocessor logics into a warnOrThrow function #ifdef HELIB_DEBUG Warning(message); #else @@ -1348,8 +1377,8 @@ void SecKey::Decrypt(NTL::ZZX& plaintxt, } // convert to coefficient representation & reduce modulo the plaintext space - if (DECRYPT_ON_PWFL_BASIS && !getContext().zMStar.getPow2()) { - const PowerfulDCRT& pwfl_converter = *getContext().pwfl_converter; + if (DECRYPT_ON_PWFL_BASIS && !getContext().getZMStar().getPow2()) { + const PowerfulDCRT& pwfl_converter = getContext().getPowerfulConverter(); NTL::Vec pwfl; pwfl_converter.dcrtToPowerful(pwfl, ptxt); @@ -1411,9 +1440,9 @@ long SecKey::skEncrypt(Ctxt& ctxt, } ctxt.ptxtSpace = ptxtSpace; - ctxt.primeSet = context.ctxtPrimes; // initialize the primeSet + ctxt.primeSet = context.getCtxtPrimes(); // initialize the primeSet { - CtxtPart tmpPart(context, context.ctxtPrimes); + CtxtPart tmpPart(context, context.getCtxtPrimes()); ctxt.parts.assign(2, tmpPart); } // allocate space @@ -1435,8 +1464,8 @@ long SecKey::skEncrypt(Ctxt& ctxt, if (isCKKS()) { - double f = getContext().ea->getCx().encodeScalingFactor() / ptxtSize; - long prec = getContext().alMod.getPPowR(); + double f = getContext().getEA().getCx().encodeScalingFactor() / ptxtSize; + long prec = getContext().getAlMod().getPPowR(); long ef = NTL::conv(ceil(prec * ctxt.noiseBound / (f * ptxtSize))); if (ef > 1) { // scale up some more ctxt.parts[0] += ptxt * ef; @@ -1470,14 +1499,13 @@ long SecKey::skEncrypt(Ctxt& ctxt, // NOTE: this is a heuristic, as the ptxt is not really random, // although, when ptxtSpace == 2, the balanced_MulMod will // randomize it - double ptxt_bound = - context.noiseBoundForMod(ptxtSpace, context.zMStar.getPhiM()); + double ptxt_bound = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); // FIXME: for now, we print out a warning, but we can consider // implementing a more robust randomization and rejection sampling // strategy. - double ptxt_sz = - NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.zMStar)); + double ptxt_sz = NTL::conv( + embeddingLargestCoeff(ptxt_fixed, context.getZMStar())); if (ptxt_sz > ptxt_bound) { Warning("noise bound exceeded in encryption"); @@ -1541,10 +1569,10 @@ void SecKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_BGV& eptxt) const long skIdx = 0; // in case we eventually want to generalize ctxt.ptxtSpace = ptxtSpace; - ctxt.primeSet = context.ctxtPrimes; + ctxt.primeSet = context.getCtxtPrimes(); ctxt.intFactor = 1; ctxt.ratFactor = ctxt.ptxtMag = 1.0; - ctxt.parts.assign(2, CtxtPart(context, context.ctxtPrimes)); + ctxt.parts.assign(2, CtxtPart(context, context.getCtxtPrimes())); // make parts[0],parts[1] point to (1,s) ctxt.parts[0].skHandle.setOne(); @@ -1571,14 +1599,13 @@ void SecKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_BGV& eptxt) const // NOTE: this is a heuristic, as the ptxt is not really random, // although, when ptxtSpace == 2, the balanced_MulMod will // randomize it - double ptxt_bound = - context.noiseBoundForMod(ptxtSpace, context.zMStar.getPhiM()); + double ptxt_bound = context.noiseBoundForMod(ptxtSpace, context.getPhiM()); // FIXME: for now, we print out a warning, but we can consider // implementing a more robust randomization and rejection sampling // strategy. double ptxt_sz = - NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.zMStar)); + NTL::conv(embeddingLargestCoeff(ptxt_fixed, context.getZMStar())); if (ptxt_sz > ptxt_bound) { Warning("noise bound exceeded in encryption"); @@ -1606,7 +1633,7 @@ void SecKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_CKKS& eptxt) const long skIdx = 0; // in case we eventually want to generalize - ctxt.parts.assign(2, CtxtPart(context, context.ctxtPrimes)); + ctxt.parts.assign(2, CtxtPart(context, context.getCtxtPrimes())); // make parts[0],parts[1] point to (1,s) ctxt.parts[0].skHandle.setOne(); @@ -1630,7 +1657,7 @@ void SecKey::Encrypt(Ctxt& ctxt, const EncodedPtxt_CKKS& eptxt) const // VJS-NOTE: we no longer round to the next power of two: // Then encoding routine should take care of setting mag correctly. - ctxt.primeSet = context.ctxtPrimes; + ctxt.primeSet = context.getCtxtPrimes(); ctxt.ptxtMag = mag; ctxt.ratFactor = scale; ctxt.noiseBound = error_bound + err; @@ -1650,15 +1677,17 @@ long SecKey::genRecryptData() assertTrue(context.isBootstrappable(), "Cannot generate recrypt data for non-bootstrappable context"); - long p2ePr = context.rcData.alMod->getPPowR(); // p^{e-e'+r} - long p2r = context.alMod.getPPowR(); // p^r + long p2ePr = context.getRcData().alMod->getPPowR(); // p^{e-e'+r} + long p2r = context.getAlMod().getPPowR(); // p^r // Generate a new bootstrapping key zzX keyPoly; - long hwt = context.rcData.skHwt; + long hwt = context.getRcData().skHwt; double bound = sampleHWtBounded(keyPoly, context, hwt); - DoubleCRT newSk(keyPoly, context, context.ctxtPrimes | context.specialPrimes); + DoubleCRT newSk(keyPoly, + context, + context.getCtxtPrimes() | context.getSpecialPrimes()); // defined relative to all primes long keyID = ImportSecKey(newSk, bound, p2r, /*maxDegKswitch=*/1); @@ -1678,13 +1707,11 @@ long SecKey::genRecryptData() std::ostream& operator<<(std::ostream& str, const SecKey& sk) { - str << "[" << ((const PubKey&)sk) << std::endl - << sk.sKeys.size() << std::endl; - for (long i = 0; i < (long)sk.sKeys.size(); i++) - str << sk.sKeys[i] << std::endl; - return str << "]"; + sk.writeToJSON(str); + return str; } +// FIXME: For consistency we should change this to write in json format too. std::ostream& SecKey::writeSecKeyDerivedASCII(std::ostream& str) const { str << "[" << sKeys.size() << std::endl; @@ -1695,49 +1722,104 @@ std::ostream& SecKey::writeSecKeyDerivedASCII(std::ostream& str) const std::istream& operator>>(std::istream& str, SecKey& sk) { - sk.clear(); - // std::cerr << "SecKey["; - seekPastChar(str, '['); // defined in NumbTh.cpp - str >> (PubKey&)sk; - - long nKeys; - str >> nKeys; - sk.sKeys.resize(nKeys, DoubleCRT(sk.getContext(), IndexSet::emptySet())); - for (long i = 0; i < nKeys; i++) - str >> sk.sKeys[i]; - seekPastChar(str, ']'); - // std::cerr << "]\n"; + sk.readJSON(str); return str; } -void writeSecKeyBinary(std::ostream& str, const SecKey& sk) +void SecKey::writeTo(std::ostream& str) const { - writeEyeCatcher(str, BINIO_EYE_SK_BEGIN); + SerializeHeader().writeTo(str); + writeEyeCatcher(str, EyeCatcher::SK_BEGIN); // Write out the public key part first. - writePubKeyBinary(str, sk); + this->PubKey::writeTo(str); // Write out // 1. vector sKeys - write_raw_vector(str, sk.sKeys); + write_raw_vector(str, this->sKeys); + + writeEyeCatcher(str, EyeCatcher::SK_END); +} + +SecKey SecKey::readFrom(std::istream& str, const Context& context) +{ + const auto header = SerializeHeader::readFrom(str); + assertEq(header.version, + Binio::VERSION_0_0_1_0, + "Header: version " + header.versionString() + + " not supported"); + + bool eyeCatcherFound = readEyeCatcher(str, EyeCatcher::SK_BEGIN); + assertTrue(eyeCatcherFound, + "Could not find pre-secret key eyecatcher"); + + // Create a secret key from its public part. + SecKey ret(PubKey::readFrom(str, context)); + + // Set the secret part of the secret key. + ret.sKeys = read_raw_vector(str, context); + + eyeCatcherFound = readEyeCatcher(str, EyeCatcher::SK_END); + assertTrue(eyeCatcherFound, + "Could not find post-secret key eyecatcher"); + + return ret; +} + +void SecKey::writeToJSON(std::ostream& str) const +{ + executeRedirectJsonError([&]() { str << writeToJSON(); }); +} + +JsonWrapper SecKey::writeToJSON() const +{ + auto body = [this]() { + json j = {{"PubKey", unwrap(this->PubKey::writeToJSON())}, + {"sKeys", writeVectorToJSON(this->sKeys)}}; + return wrap(toTypedJson(j)); + }; + + return executeRedirectJsonError(body); +} + +SecKey SecKey::readFromJSON(std::istream& str, const Context& context) +{ + auto body = [&]() { + json j; + str >> j; + return SecKey::readFromJSON(wrap(j), context); + }; - writeEyeCatcher(str, BINIO_EYE_SK_END); + return executeRedirectJsonError(body); } -void readSecKeyBinary(std::istream& str, SecKey& sk) +SecKey SecKey::readFromJSON(const JsonWrapper& jw, const Context& context) { - int eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_SK_BEGIN); - assertEq(eyeCatcherFound, 0, "Could not find pre-secret key eyecatcher"); + SecKey ret{context}; + ret.readJSON(jw); + return ret; +} - // Read in the public key part first. - readPubKeyBinary(str, sk); +void SecKey::readJSON(std::istream& str) +{ + executeRedirectJsonError([&]() { + json j; + str >> j; + this->readJSON(wrap(j)); + }); +} + +void SecKey::readJSON(const JsonWrapper& tjw) +{ + executeRedirectJsonError([&]() { + json j = fromTypedJson(unwrap(tjw)); + this->clear(); - DoubleCRT blankDCRT(sk.getContext(), IndexSet::emptySet()); - read_raw_vector(str, sk.sKeys, blankDCRT); + this->PubKey::readJSON(wrap(j.at("PubKey"))); - eyeCatcherFound = readEyeCatcher(str, BINIO_EYE_SK_END); - assertEq(eyeCatcherFound, 0, "Could not find post-secret key eyecatcher"); + this->sKeys = readVectorFromJSON(j.at("sKeys"), context); + }); } } // namespace helib diff --git a/src/matmul.cpp b/src/matmul.cpp index d89ade435..8952c9d83 100644 --- a/src/matmul.cpp +++ b/src/matmul.cpp @@ -96,7 +96,7 @@ class BasicAutomorphPrecon } addedNoise *= max_ks_noise; - double logProd = context.logOfProduct(context.specialPrimes); + double logProd = context.logOfProduct(context.getSpecialPrimes()); noise = ctxt.getNoiseBound() * NTL::xexp(logProd); double ratio = NTL::conv(addedNoise / noise); @@ -133,19 +133,19 @@ class BasicAutomorphPrecon result->noiseBound = noise; // noise estimate result->intFactor = ctxt.intFactor; - result->primeSet = ctxt.primeSet | context.specialPrimes; + result->primeSet = ctxt.primeSet | context.getSpecialPrimes(); // VJS-NOTE: added this to make addPart work if (ctxt.isCKKS()) { result->ptxtMag = ctxt.ptxtMag; - double logProd = context.logOfProduct(context.specialPrimes); + double logProd = context.logOfProduct(context.getSpecialPrimes()); result->ratFactor = ctxt.ratFactor * NTL::xexp(logProd); } if (ctxt.parts.size() == 1) { // only constant part, no need to key-switch CtxtPart tmpPart = ctxt.parts[0]; tmpPart.automorph(k); - tmpPart.addPrimesAndScale(context.specialPrimes); + tmpPart.addPrimesAndScale(context.getSpecialPrimes()); result->addPart(tmpPart, /*matchPrimeSet=*/true); return result; } @@ -164,7 +164,7 @@ class BasicAutomorphPrecon // Start by rotating the constant part, no need to key-switch it CtxtPart tmpPart = ctxt.parts[0]; tmpPart.automorph(amt); - tmpPart.addPrimesAndScale(context.specialPrimes); + tmpPart.addPrimesAndScale(context.getSpecialPrimes()); result->addPart(tmpPart, /*matchPrimeSet=*/true); // Then rotate the digits and key-switch them @@ -174,7 +174,7 @@ class BasicAutomorphPrecon result->keySwitchDigits(W, tmpDigits); // key-switch the digits - long m = context.zMStar.getM(); + long m = context.getM(); if ((amt - k) % m != 0) { // amt != k (mod m), more automorphisms to do k = NTL::MulMod(k, NTL::InvMod(amt, m), m); // k *= amt^{-1} mod m result->smartAutomorph(k); // call usual smartAutomorph @@ -355,7 +355,7 @@ struct ConstMultiplier_zzX : ConstMultiplier std::shared_ptr upgrade( const Context& context) const override { - double sz = embeddingLargestCoeff(data, context.zMStar); + double sz = embeddingLargestCoeff(data, context.getZMStar()); return std::make_shared( DoubleCRT(data, context, context.fullPrimes()), @@ -939,7 +939,7 @@ void GenBabySteps(std::vector>& v, return; } - const PAlgebra& zMStar = ctxt.getContext().zMStar; + const PAlgebra& zMStar = ctxt.getContext().getZMStar(); // std::cerr << "*** STRATEGY FOR dim " << dim << " = " << // ctxt.getPubKey().getKSStrategy(dim) << "\n"; @@ -2645,7 +2645,7 @@ struct mul_MatMul1D_impl std::vector& data = pa.getData(); for (long i : range(n)) { long k, j; - std::tie(k, j) = ea.getContext().zMStar.breakIndexByDim(i, dim); + std::tie(k, j) = ea.getContext().getZMStar().breakIndexByDim(i, dim); data1[k][j] = data[i]; // k= along dim, j = the rest of i } @@ -2653,7 +2653,7 @@ struct mul_MatMul1D_impl for (long k : range(n / D)) { for (long j : range(D)) { // simple matrix-vector multiplication std::pair p(k, j); - long idx = ea.getContext().zMStar.assembleIndexByDim(p, dim); + long idx = ea.getContext().getZMStar().assembleIndexByDim(p, dim); RX acc, val, tmp; acc = 0; @@ -2865,8 +2865,8 @@ void mul(PlaintextArray& pa, const BlockMatMulFull& mat) void traceMap(Ctxt& ctxt) { const Context& context = ctxt.getContext(); - const PAlgebra& zMStar = context.zMStar; - long d = context.zMStar.getOrdP(); + const PAlgebra& zMStar = context.getZMStar(); + long d = context.getOrdP(); if (d == 1) return; diff --git a/src/permutations.cpp b/src/permutations.cpp index 8dec4318c..27c7b1ade 100644 --- a/src/permutations.cpp +++ b/src/permutations.cpp @@ -529,7 +529,7 @@ std::ostream& operator<<(std::ostream& s, const GeneratorTrees& trees) } PermIndepPrecomp::PermIndepPrecomp(const Context& context, long depthBound) : - PermIndepPrecomp(context.getDefaultView(), depthBound) + PermIndepPrecomp(context.getView(), depthBound) {} PermIndepPrecomp::PermIndepPrecomp(const EncryptedArray& _ea, long depthBound) : diff --git a/src/powerful.cpp b/src/powerful.cpp index 82f1cc5be..f0e5e38b0 100644 --- a/src/powerful.cpp +++ b/src/powerful.cpp @@ -253,16 +253,16 @@ PowerfulDCRT::PowerfulDCRT(const Context& _context, if (triv) return; - double polyNormBnd = context.zMStar.getPolyNormBnd(); + double polyNormBnd = context.getZMStar().getPolyNormBnd(); - // double normBnd = context.zMStar.getNormBnd(); + // double normBnd = context.getNormBnd(); // we compute this from the given factorization, just in case // it is not a prime-power factorization double normBnd = 1.0; for (long fac : mvec) normBnd *= calcPolyNormBnd(fac); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); to_pwfl_excess_bits = long((log(normBnd) + log(double(phim))) / log(2.0)) + 5; to_poly_excess_bits = @@ -309,7 +309,7 @@ PowerfulDCRT::PowerfulDCRT(const Context& _context, void PowerfulDCRT::ZZXtoPowerful(NTL::Vec& out, const NTL::ZZX& poly) const { - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); if (triv) { NTL::VectorCopy(out, poly, phim); @@ -397,7 +397,7 @@ void PowerfulDCRT::dcrtToPowerful(NTL::Vec& powerful, dcrt.toPoly(poly); if (triv) { - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); NTL::VectorCopy(powerful, poly, phim); return; } diff --git a/src/primeChain.cpp b/src/primeChain.cpp index ad1d76d5c..f0ee23a6e 100644 --- a/src/primeChain.cpp +++ b/src/primeChain.cpp @@ -19,10 +19,12 @@ #include #include #include -#include +#include "binio.h" #include #include +#include "io.h" + namespace helib { inline bool operator>(const ModuliSizes::Entry& a, const ModuliSizes::Entry& b) @@ -32,32 +34,40 @@ inline bool operator>(const ModuliSizes::Entry& a, const ModuliSizes::Entry& b) std::ostream& operator<<(std::ostream& s, const ModuliSizes::Entry& e) { - return s << '[' << e.first << ' ' << e.second << "]\n"; + executeRedirectJsonError([&]() { + json j{{"first", e.first}, {"second", unwrap(e.second.writeToJSON())}}; + s << j.dump() << std::endl; + }); + return s; } + std::istream& operator>>(std::istream& s, ModuliSizes::Entry& e) { - seekPastChar(s, '['); // defined in NumbTh.cpp - s >> e.first; - s >> e.second; - seekPastChar(s, ']'); + executeRedirectJsonError([&]() { + json j; + s >> j; + e.first = j.at("first").get(); + e.second = IndexSet::readFromJSON(wrap(j.at("second"))); + }); return s; } + void write(std::ostream& s, const ModuliSizes::Entry& e) { write_raw_double(s, e.first); - e.second.write(s); + e.second.writeTo(s); } void read(std::istream& s, ModuliSizes::Entry& e) { e.first = read_raw_double(s); - e.second.read(s); + e.second = IndexSet::readFrom(s); } // initialize helper table for a given chain void ModuliSizes::init(const Context& context) { - if (context.zMStar.getPow2()) + if (context.getZMStar().getPow2()) iFFT_cost = 0; // iFFT cost is same as FFT cost else iFFT_cost = 20; // iFFT cost is 1.20 times FFT cost. @@ -66,7 +76,8 @@ void ModuliSizes::init(const Context& context) // FIXME: should allow use to override // this default value. - long n = (1L << context.smallPrimes.card()) * (context.ctxtPrimes.card() + 1); + long n = (1L << context.getSmallPrimes().card()) * + (context.getCtxtPrimes().card() + 1); sizes.reserve(n); // allocate space // each entry of sizes is a pair=(size, set-of-primes) @@ -75,7 +86,7 @@ void ModuliSizes::init(const Context& context) sizes.push_back(std::make_pair(0.0, IndexSet::emptySet())); // the empty set long idx = 1; // first index that's still not set - for (long i : context.smallPrimes) { // add i to all sets upto idx-1 + for (long i : context.getSmallPrimes()) { // add i to all sets upto idx-1 double sizeOfQi = std::log(context.ithModulus(i).getQ()); for (long j = idx; j < 2 * idx; j++) { sizes.push_back(sizes[j - idx]); // make a copy @@ -90,8 +101,8 @@ void ModuliSizes::init(const Context& context) IndexSet s; // empty set double intervalSize = 0.0; - for (long i : context.ctxtPrimes) { // add i to all sets upto idx-1 - s.insert(i); // add prime to the interval + for (long i : context.getCtxtPrimes()) { // add i to all sets upto idx-1 + s.insert(i); // add prime to the interval intervalSize += std::log(context.ithModulus(i).getQ()); // add its size to intervalSize for (long j = 0; j < idx; j++) { @@ -327,6 +338,7 @@ std::ostream& operator<<(std::ostream& s, const ModuliSizes& szs) { return s << '[' << szs.sizes.size() << ' ' << szs.sizes << ']'; } + std::istream& operator>>(std::istream& s, ModuliSizes& szs) { long n; @@ -354,487 +366,4 @@ void ModuliSizes::read(std::istream& str) ::helib::read(str, sizes[i]); } -// You initialize a PrimeGenerator as follows: -// PrimeGenerator gen(len, m); -// Each call to gen.next() generates a prime p with -// (1-1/2^B)*2^len <= p < 2^len and p = 2^k*t*m + 1, -// where t is odd and k is as large as possible -// and B is a small constant (typically, B in {2,3,4}). -// If no such prime is found, then an error is raised. - -struct PrimeGenerator -{ - const static long B = 3; - long len, m; - long k, t; - - PrimeGenerator(long _len, long _m) : len(_len), m(_m) - { - assertInRange(len, - long(B), - static_cast(NTL_SP_NBITS), - "PrimeGenerator: len is not " - "in [B, NTL_SP_NBITS]", - true); - assertInRange(m, - 1l, - static_cast(NTL_SP_BOUND), - "PrimeGenerator: m is " - "not in [1, NTL_SP_BOUND)"); - - // compute k as smallest non-negative integer such that - // 2^{len-B} < 2^k*m - k = 0; - while ((m << k) <= (1L << (len - B))) - k++; - - t = divc((1L << len) - 1, m << k); - // this ensures the fist call to next will trigger a new k-value - } - - long next() - { - // we consider all odd t in the interval - // [ (1-1/2^B)*2^len-1)/(2^k*m), (2^len-1)/(2^k*m) ). - // For k satisfying 2^{len-B} >= 2^k*m, this interval is - // contains at least one integer. - // It is equivalent to consider the interval - // of integers [tlb, tub), where tlb = ceil(((1-1/2^B)*2^len-1)/(2^k*m)) - // and tub = ceil((2^len-1)/(2^k*m)). - - long tub = divc((1L << len) - 1, m << k); - - for (;;) { - - t++; - - if (t >= tub) { - // move to smaller value of k, reset t and tub - - k--; - - long klb; - if (m % 2 == 0) - klb = 0; - else - klb = 1; - - // we run k down to 0 if m is even, and down to 1 - // if m is odd. - - if (k < klb) - throw RuntimeError("Prime generator ran out of primes"); - - t = divc((1L << len) - (1L << (len - B)) - 1, m << k); - tub = divc((1L << len) - 1, m << k); - } - - if (t % 2 == 0) - continue; // we only want to consider odd t - - long cand = ((t * m) << k) + 1; // = 2^k*t*m + 1 - - // double check that cand is in the prescribed interval - assertInRange(cand, - (1L << len) - (1L << (len - B)), - 1L << len, - "Candidate cand is not in the prescribed interval"); - - if (NTL::ProbPrime(cand, 60)) - return cand; - // iteration count == 60 implies 2^{-120} error probability - } - } -}; - -void Context::AddSmallPrime(long q) -{ - assertFalse(inChain(q), "Small prime q is already in the prime chain"); - long i = moduli.size(); // The index of the new prime in the list - moduli.push_back(Cmodulus(zMStar, q, 0)); - smallPrimes.insert(i); -} - -void Context::AddCtxtPrime(long q) -{ - assertFalse(inChain(q), "Prime q is already in the prime chain"); - long i = moduli.size(); // The index of the new prime in the list - moduli.push_back(Cmodulus(zMStar, q, 0)); - ctxtPrimes.insert(i); -} - -void Context::AddSpecialPrime(long q) -{ - assertFalse(inChain(q), "Special prime q is already in the prime chain"); - long i = moduli.size(); // The index of the new prime in the list - moduli.push_back(Cmodulus(zMStar, q, 0)); - specialPrimes.insert(i); -} - -//! @brief Add small primes to get target resolution -// FIXME: there is some black magic here. -// we need to better document the strategy. -static void addSmallPrimes(Context& context, long resolution, long cpSize) -{ - // cpSize is the size of the ciphertext primes - // Sanity-checks, cpSize \in [0.9*NTL_SP_NBITS, NTL_SP_NBITS] - assertTrue(cpSize >= 30, "cpSize is too small (minimum is 30)"); - assertInRange(cpSize * 10, - 9l * NTL_SP_NBITS, - 10l * NTL_SP_NBITS, - "cpSize not in [0.9*NTL_SP_NBITS, NTL_SP_NBITS]", - true); - - long m = context.zMStar.getM(); - if (m <= 0 || m > (1 << 20)) // sanity checks - throw RuntimeError("addSmallPrimes: m undefined or larger than 2^20"); - // NOTE: Below we are ensured that 16m*log(m) << NTL_SP_BOUND - - if (resolution < 1 || resolution > 10) // set to default of 3-bit resolution - resolution = 3; - - std::vector sizes; - long smallest; // size of the smallest of the smallPrimes - // We need at least two of this size, maybe three - - if (cpSize >= 54) - smallest = divc(2 * cpSize, 3); - else if (cpSize >= 45) - smallest = divc(7 * cpSize, 10); - else { // Make the smallest ones at least 22-bit primes - smallest = divc(11 * cpSize, 15); - sizes.push_back(smallest); // need three of them - } - sizes.push_back(smallest); - sizes.push_back(smallest); - - // This ensures we can express everything to given resolution. - - // use sizes cpSize-r, cpSize-2r, cpSize-4r,... down to the sizes above - for (long delta = resolution; cpSize - delta > smallest; delta *= 2) - sizes.push_back(cpSize - delta); - - // This helps to minimize the number of small primes needed - // to express any particular resolution. - // This could be removed...need to experiment. - - // Special cases: add also cpSize-3*resolution, - // and for resolution=1 also cpSize-11 - if (cpSize - 3 * resolution > smallest) - sizes.push_back(cpSize - 3 * resolution); - if (resolution == 1 && cpSize - 11 > smallest) - sizes.push_back(cpSize - 11); - - std::sort(sizes.begin(), sizes.end()); // order by size - - long last_sz = 0; - std::unique_ptr gen; - for (long sz : sizes) { - if (sz != last_sz) - gen.reset(new PrimeGenerator(sz, m)); - long q = gen->next(); - context.AddSmallPrime(q); - last_sz = sz; - } -} - -// Determine the target size of the ctxtPrimes. The target size is -// set at 2^n, where n is at most NTL_SP_NBITS and at least least -// ceil(0.9*NTL_SP_NBITS), so that we don't overshoot nBits by too -// much. -// The reason that we do not allow to go below 0.9*NTL_SP_NBITS is -// that we need some of the smallPrimes to be sufficiently smaller -// than the ctxtPrimes, and still we need these smallPrimes to have -// m'th roots of unity. -static long ctxtPrimeSize(long nBits) -{ - double bit_loss = - -std::log1p(-1.0 / double(1L << PrimeGenerator::B)) / std::log(2.0); - // std::cerr << "*** bit_loss=" << bit_loss; - - // How many primes of size NTL_SP_NBITS it takes to get to nBits - double maxPsize = NTL_SP_NBITS - bit_loss; - // primes of length len are guaranteed to be at least (1-1/2^B)*2^len, - - long nPrimes = long(ceil(nBits / maxPsize)); - // this is sufficiently many primes - - // now we want to trim the size to avoid unnecssary overshooting - // so we decrease targetSize, while guaranteeing that - // nPrimes primes of length targetSize multiply out to - // at least nBits bits. - - long targetSize = NTL_SP_NBITS; - while (10 * (targetSize - 1) >= 9 * NTL_SP_NBITS && (targetSize - 1) >= 30 && - ((targetSize - 1) - bit_loss) * nPrimes >= nBits) - targetSize--; - - if (((targetSize - 1) - bit_loss) * nPrimes >= nBits) - Warning(__func__ + std::string(": non-optimal targetSize")); - - return targetSize; -} - -static void addCtxtPrimes(Context& context, long nBits, long targetSize) -{ - // We add enough primes of size targetSize until their product is - // at least 2^{nBits} - - // Sanity-checks, targetSize \in [0.9*NTL_SP_NBITS, NTL_SP_NBITS] - assertTrue(targetSize >= 30, - "Target prime is too small (minimum size is 30)"); - assertInRange(targetSize * 10, - 9l * NTL_SP_NBITS, - 10l * NTL_SP_NBITS, - "targetSize not in [0.9*NTL_SP_NBITS, NTL_SP_NBITS]", - true); - const PAlgebra& palg = context.zMStar; - long m = palg.getM(); - - PrimeGenerator gen(targetSize, m); - double bitlen = 0; // how many bits we already have - while (bitlen < nBits - 0.5) { - long q = gen.next(); // generate the next prime - context.AddCtxtPrime(q); // add it to the list - bitlen += std::log2(q); - } - - // std::cerr << "*** ctxtPrimes excess: " << (bitlen - nBits) << "\n"; - HELIB_STATS_UPDATE("excess-ctxtPrimes", bitlen - nBits); -} - -static void addSpecialPrimes(Context& context, - long nDgts, - bool willBeBootstrappable, - UNUSED long skHwt, - long bitsInSpecialPrimes) -{ - const PAlgebra& palg = context.zMStar; - long p = std::abs(palg.getP()); // for CKKS, palg.getP() == -1 - long m = palg.getM(); - long phim = palg.getPhiM(); - long p2r = context.isCKKS() ? 1 : context.alMod.getPPowR(); - - long p2e = p2r; - if (willBeBootstrappable && !context.isCKKS()) { - // bigger p^e for bootstrapping - long e, ePrime; - RecryptData::setAE(e, ePrime, context); - p2e *= NTL::power_long(p, e - ePrime); - - // initialize e and ePrime parameters in the context - context.e_param = e; - context.ePrime_param = ePrime; - } - - long nCtxtPrimes = context.ctxtPrimes.card(); - if (nDgts > nCtxtPrimes) - nDgts = nCtxtPrimes; // sanity checks - if (nDgts <= 0) - nDgts = 1; - - context.digits.resize(nDgts); // allocate space - - if (nDgts > 1) { // we break ciphertext into a few digits when key-switching - // NOTE: The code below assumes that all the ctxtPrimes have roughly the - // same size - - IndexSet remaining = context.ctxtPrimes; - for (long dgt = 0; dgt < nDgts - 1; dgt++) { - long digitCard = divc(remaining.card(), nDgts - dgt); - // ceiling(#-of-remaining-primes, #-or-remaining-digits) - - for (long i : remaining) { - context.digits[dgt].insert(i); - if (context.digits[dgt].card() >= digitCard) - break; - } - remaining.remove(context.digits[dgt]); // update the remaining set - } - // The last digit has everything else - if (empty(remaining)) { // sanity check, use one less digit - nDgts--; - context.digits.resize(nDgts); - } else - context.digits[nDgts - 1] = remaining; - } else { // only one digit - context.digits[0] = context.ctxtPrimes; - } - - double maxDigitLog = 0.0; - for (auto& digit : context.digits) { - double size = context.logOfProduct(digit); - if (size > maxDigitLog) - maxDigitLog = size; - } - - // Add special primes to the chain for the P factor of key-switching - double nBits; - - if (bitsInSpecialPrimes) - nBits = bitsInSpecialPrimes; - else { -#if 0 - nBits = (maxDigitLog + std::log(nDgts) + NTL::log(context.stdev * 2) + - std::log(p2e)) / - std::log(2.0); - // FIXME: Victor says: the above calculation does not make much sense to me -#else - double h; - if (context.hwt_param == 0) - h = phim / 2.0; - else - h = context.hwt_param; - - double log_phim = std::log(phim); - if (log_phim < 1) - log_phim = 1; - - if (context.isCKKS()) { - // This is based on a smaller noise estimate so as - // to better protext precision...this is based on - // a noise level equal to the mod switch added noise. - // Note that the relin_CKKS_adjust function in Ctxt.cpp - // depends on this estimate. - nBits = (maxDigitLog + NTL::log(context.stdev) + std::log(nDgts) - - 0.5 * std::log(h)) / - std::log(2.0); - } else if (palg.getPow2()) { - nBits = (maxDigitLog + std::log(p2e) + NTL::log(context.stdev) + - 0.5 * std::log(12.0) + std::log(nDgts) - - 0.5 * std::log(log_phim) - 2 * std::log(p) - std::log(h)) / - std::log(2.0); - } else { - nBits = - (maxDigitLog + std::log(m) + std::log(p2e) + NTL::log(context.stdev) + - 0.5 * std::log(12.0) + std::log(nDgts) - 0.5 * log_phim - - 0.5 * std::log(log_phim) - 2 * std::log(p) - std::log(h)) / - std::log(2.0); - } - - // Both of the above over-estimate nBits by a factor of log2(context.scale). - // That should provide a sufficient safety margin. - // See design document - -#endif - } - - if (nBits < 1) - nBits = 1; - - double bit_loss = - -std::log1p(-1.0 / double(1L << PrimeGenerator::B)) / std::log(2.0); - - // How many primes of size NTL_SP_NBITS it takes to get to nBits - double maxPsize = NTL_SP_NBITS - bit_loss; - // primes of length len are guaranteed to be at least (1-1/2^B)*2^len, - - long nPrimes = long(ceil(nBits / maxPsize)); - // this is sufficiently many prime - - // now we want to trim the size to avoid unnecssary overshooting - // so we decrease targetSize, while guaranteeing that - // nPrimes primes of length targetSize multiply out to - // at least nBits bits. - - long targetSize = NTL_SP_NBITS; - while ((targetSize - 1) >= 0.55 * NTL_SP_NBITS && (targetSize - 1) >= 30 && - ((targetSize - 1) - bit_loss) * nPrimes >= nBits) - targetSize--; - - if (((targetSize - 1) - bit_loss) * nPrimes >= nBits) - Warning(__func__ + std::string(": non-optimal targetSize")); - - PrimeGenerator gen(targetSize, m); - - while (nPrimes > 0) { - long q = gen.next(); - - if (context.inChain(q)) - continue; - // nbits could equal NTL_SP_BITS or the size of one - // of the small primes, so we have to check for duplicates here... - // this is not the most efficient way to do this, - // but it doesn't make sense to optimize this any further - - context.AddSpecialPrime(q); - nPrimes--; - } - - // std::cerr << "*** specialPrimes excess: " << - // (context.logOfProduct(context.specialPrimes)/std::log(2.0) - nBits) << - // "\n"; - HELIB_STATS_UPDATE( - "excess-specialPrimes", - context.logOfProduct(context.specialPrimes) / std::log(2.0) - nBits); -} - -void endBuildModChain(Context& context) -{ - context.setModSizeTable(); - - long m = context.zMStar.getM(); - std::vector mvec; - pp_factorize(mvec, m); - NTL::Vec mmvec; - convert(mmvec, mvec); - context.pwfl_converter = std::make_shared(context, mmvec); -} - -static void CheckPrimes(const Context& context, - const IndexSet& s, - const char* name) -{ - for (long i : s) { - NTL::zz_pPush push; - context.ithModulus(i).restoreModulus(); - if (!NTL::zz_p::IsFFTPrime()) { - Warning(__func__ + std::string(": non-FFT prime in ") + name); - } - } -} - -void buildModChain(Context& context, - long nBits, - long nDgts, - bool willBeBootstrappable, - long skHwt, - long resolution, - long bitsInSpecialPrimes) -{ - // Cannot build modulus chain with nBits < 0 - assertTrue(nBits > 0, - "Cannot initialise modulus chain with nBits < 1"); - - assertTrue(skHwt >= 0, "invalid skHwt parameter"); - - if (context.isCKKS()) - willBeBootstrappable = false; - // ignore for CKKS - - if (skHwt == 0) { - // default skHwt: if bootstrapping, set to BOOT_DFLT_SK_HWT - if (willBeBootstrappable) - skHwt = BOOT_DFLT_SK_HWT; - } - - // initialize hwt param in context - context.hwt_param = skHwt; - - long pSize = ctxtPrimeSize(nBits); - addSmallPrimes(context, resolution, pSize); - addCtxtPrimes(context, nBits, pSize); - addSpecialPrimes(context, - nDgts, - willBeBootstrappable, - skHwt, - bitsInSpecialPrimes); - - CheckPrimes(context, context.smallPrimes, "smallPrimes"); - CheckPrimes(context, context.ctxtPrimes, "ctxtPrimes"); - CheckPrimes(context, context.specialPrimes, "specialPrimes"); - - endBuildModChain(context); -} - } // namespace helib diff --git a/src/recryption.cpp b/src/recryption.cpp index 44975c873..3e7b49053 100644 --- a/src/recryption.cpp +++ b/src/recryption.cpp @@ -86,9 +86,9 @@ static void newMakeDivisible(NTL::ZZX& poly, assertEq(q % p2e, 1l, "q must equal 1 modulo p2e"); - long p = context.zMStar.getP(); + long p = context.getP(); - const RecryptData& rcData = context.rcData; + const RecryptData& rcData = context.getRcData(); const PowerfulDCRT& p2d_conv = *rcData.p2dConv; NTL::Vec pwrfl; @@ -203,9 +203,9 @@ void RecryptData::setAE(long& e, long& ePrime, const Context& context) // coeff_bound is ultimately a high prob bound on |w0+w1*s|, // the coeffs of w0, w1 are chosen uniformly on [-1/2,1/2] - long p = context.zMStar.getP(); - long p2r = context.alMod.getPPowR(); - long r = context.alMod.getR(); + long p = context.getP(); + long p2r = context.getAlMod().getPPowR(); + long r = context.getAlMod().getR(); long frstTerm = 2 * p2r + 2; long e_bnd = 0; @@ -277,13 +277,16 @@ void RecryptData::init(const Context& context, std::cerr << "@Warning: multiple calls to RecryptData::init\n"; return; } + + // sanity check assertEq(computeProd(mvec_), - (long)context.zMStar.getM(), - "Cyclotomic polynomial mismatch"); // sanity check + context.getM(), + "Cyclotomic polynomial mismatch"); // Record the arguments to this function mvec = mvec_; build_cache = build_cache_; + alsoThick = enableThick; bool mvec_ok = true; for (long i : range(mvec.length())) { @@ -297,14 +300,14 @@ void RecryptData::init(const Context& context, Warning("prime power factorization recommended for bootstrapping"); } - skHwt = context.hwt_param; - e = context.e_param; - ePrime = context.ePrime_param; + skHwt = context.getHwt(); + e = context.getE(); + ePrime = context.getEPrime(); - long r = context.alMod.getR(); + long r = context.getAlMod().getR(); // First part of Bootstrapping works wrt plaintext space p^{r'} - alMod = std::make_shared(context.zMStar, e - ePrime + r); + alMod = std::make_shared(context.getZMStar(), e - ePrime + r); ea = std::make_shared(context, *alMod); // Polynomial defaults to F0, PAlgebraMod explicitly given @@ -340,8 +343,11 @@ void RecryptData::init(const Context& context, ea->encode(unpackSlotEncoding[j], v); } firstMap = std::make_shared(*ea, minimal, mvec, true, build_cache); - secondMap = - std::make_shared(*context.ea, minimal, mvec, false, build_cache); + secondMap = std::make_shared(context.getEA(), + minimal, + mvec, + false, + build_cache); } /********************************************************************/ @@ -379,14 +385,14 @@ void PubKey::reCrypt(Ctxt& ctxt) const // check that we have bootstrapping data assertTrue(recryptKeyID >= 0l, "No bootstrapping data"); - long p = getContext().zMStar.getP(); - long r = getContext().alMod.getR(); - long p2r = getContext().alMod.getPPowR(); + long p = getContext().getP(); + long r = getContext().getAlMod().getR(); + long p2r = getContext().getAlMod().getPPowR(); long intFactor = ctxt.intFactor; // the bootstrapping key is encrypted relative to plaintext space p^{e-e'+r}. - const RecryptData& rcData = getContext().rcData; + const RecryptData& rcData = getContext().getRcData(); long e = rcData.e; long ePrime = rcData.ePrime; long p2ePrime = NTL::power_long(p, ePrime); @@ -415,8 +421,8 @@ void PubKey::reCrypt(Ctxt& ctxt) const ctxt.reLinearize(); // Mod-switch down if needed - IndexSet s = ctxt.getPrimeSet() / context.specialPrimes; - assertTrue(s <= context.ctxtPrimes, "prime set is messed up"); + IndexSet s = ctxt.getPrimeSet() / context.getSpecialPrimes(); + assertTrue(s <= context.getCtxtPrimes(), "prime set is messed up"); if (s.card() > 3) { // leave only first three ciphertext primes long first = s.first(); IndexSet s3(first, first + 2); @@ -434,7 +440,7 @@ void PubKey::reCrypt(Ctxt& ctxt) const // "raw mod-switch" to the bootstrapping modulus q=p^e+1. std::vector zzParts; // the mod-switched parts, in ZZX format - double mfac = ctxt.getContext().zMStar.getNormBnd(); + double mfac = ctxt.getContext().getZMStar().getNormBnd(); double noise_est = ctxt.rawModSwitch(zzParts, q) * mfac; // noise_est is an upper bound on the L-infty norm of the scaled noise // in the pwrfl basis @@ -507,7 +513,7 @@ void PubKey::reCrypt(Ctxt& ctxt) const // Move the powerful-basis coefficients to the plaintext slots HELIB_NTIMER_START(AAA_LinearTransform1); - ctxt.getContext().rcData.firstMap->apply(ctxt); + ctxt.getContext().getRcData().firstMap->apply(ctxt); HELIB_NTIMER_STOP(AAA_LinearTransform1); #ifdef HELIB_DEBUG @@ -520,7 +526,7 @@ void PubKey::reCrypt(Ctxt& ctxt) const e - ePrime, r, ePrime, - context.rcData.unpackSlotEncoding); + context.getRcData().unpackSlotEncoding); HELIB_NTIMER_STOP(AAA_extractDigitsPacked); #ifdef HELIB_DEBUG @@ -529,7 +535,7 @@ void PubKey::reCrypt(Ctxt& ctxt) const // Move the slots back to powerful-basis coefficients HELIB_NTIMER_START(AAA_LinearTransform2); - ctxt.getContext().rcData.secondMap->apply(ctxt); + ctxt.getContext().getRcData().secondMap->apply(ctxt); HELIB_NTIMER_STOP(AAA_LinearTransform2); #ifdef HELIB_DEBUG @@ -557,7 +563,7 @@ void extractDigitsPacked(Ctxt& ctxt, ctxt.cleanUp(); // Apply the d automorphisms and store them in scratch area - long d = ctxt.getContext().zMStar.getOrdP(); + long d = ctxt.getContext().getOrdP(); std::vector unpacked(d, Ctxt(ZeroCtxtLike, ctxt)); { // explicit scope to force all temporaries to be released @@ -571,9 +577,9 @@ void extractDigitsPacked(Ctxt& ctxt, coeff_vector[i] = std::make_shared(unpackSlotEncoding[i], ctxt.getContext(), ctxt.getPrimeSet()); - coeff_vector_sz[i] = - NTL::conv(embeddingLargestCoeff(unpackSlotEncoding[i], - ctxt.getContext().zMStar)); + coeff_vector_sz[i] = NTL::conv( + embeddingLargestCoeff(unpackSlotEncoding[i], + ctxt.getContext().getZMStar())); } HELIB_NTIMER_STOP(unpack1); @@ -622,7 +628,7 @@ void extractDigitsPacked(Ctxt& ctxt, // Step 3: re-pack the slots HELIB_NTIMER_START(repack); - const EncryptedArray& ea2 = *ctxt.getContext().ea; + const EncryptedArray& ea2 = ctxt.getContext().getEA(); NTL::ZZX xInSlots; std::vector xVec(ea2.size()); ctxt = unpacked[0]; @@ -653,7 +659,7 @@ void extractDigitsPacked(Ctxt& ctxt, ctxt.cleanUp(); // Apply the d automorphisms and store them in scratch area - long d = ctxt.getContext().zMStar.getOrdP(); + long d = ctxt.getContext().getOrdP(); std::vector unpacked(d, Ctxt(ZeroCtxtLike, ctxt)); { // explicit scope to force all temporaries to be released @@ -665,9 +671,9 @@ void extractDigitsPacked(Ctxt& ctxt, coeff_vector[i] = std::make_shared(unpackSlotEncoding[i], ctxt.getContext(), ctxt.getPrimeSet()); - coeff_vector_sz[i] = - NTL::conv(embeddingLargestCoeff(unpackSlotEncoding[i], - ctxt.getContext().zMStar)); + coeff_vector_sz[i] = NTL::conv( + embeddingLargestCoeff(unpackSlotEncoding[i], + ctxt.getContext().getZMStar())); } Ctxt tmp1(ZeroCtxtLike, ctxt); @@ -776,7 +782,7 @@ void ThinRecryptData::init(const Context& context, RecryptData::init(context, mvec_, alsoThick, build_cache_, minimal); coeffToSlot = std::make_shared(*ea, minimal, mvec, true, build_cache); - slotToCoeff = std::make_shared(*context.ea, + slotToCoeff = std::make_shared(context.getEA(), minimal, mvec, false, @@ -796,7 +802,7 @@ void extractDigitsThin(Ctxt& ctxt, long botHigh, long r, long ePrime) std::vector scratch; - long p = ctxt.getContext().zMStar.getP(); + long p = ctxt.getContext().getP(); long p2r = NTL::power_long(p, r); long topHigh = botHigh + r - 1; @@ -956,13 +962,13 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const // check that we have bootstrapping data assertTrue(recryptKeyID >= 0l, "Bootstrapping data not present"); - long p = ctxt.getContext().zMStar.getP(); - long r = ctxt.getContext().alMod.getR(); - long p2r = ctxt.getContext().alMod.getPPowR(); + long p = ctxt.getContext().getP(); + long r = ctxt.getContext().getAlMod().getR(); + long p2r = ctxt.getContext().getAlMod().getPPowR(); long intFactor = ctxt.intFactor; - const ThinRecryptData& trcData = ctxt.getContext().rcData; + const ThinRecryptData& trcData = ctxt.getContext().getRcData(); // the bootstrapping key is encrypted relative to plaintext space p^{e-e'+r}. long e = trcData.e; @@ -987,9 +993,9 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const #ifdef DROP_BEFORE_THIN_RECRYPT // experimental code...we should drop down to a reasonably low level // before doing the first linear map. - long first = context.ctxtPrimes.first(); - long last = - std::min(context.ctxtPrimes.last(), first + THIN_RECRYPT_NLEVELS - 1); + long first = context.getCtxtPrimes().first(); + long last = std::min(context.getCtxtPrimes().last(), + first + THIN_RECRYPT_NLEVELS - 1); ctxt.bringToSet(IndexSet(first, last)); #endif @@ -1013,8 +1019,8 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const ctxt.reLinearize(); // Mod-switch down if needed - IndexSet s = ctxt.getPrimeSet() / context.specialPrimes; - assertTrue(s <= context.ctxtPrimes, "prime set is messed up"); + IndexSet s = ctxt.getPrimeSet() / context.getSpecialPrimes(); + assertTrue(s <= context.getCtxtPrimes(), "prime set is messed up"); if (s.card() > 3) { // leave only first three ciphertext primes long first = s.first(); IndexSet s3(first, first + 2); @@ -1032,7 +1038,7 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const // "raw mod-switch" to the bootstrapping mosulus q=p^e+1. std::vector zzParts; // the mod-switched parts, in ZZX format - double mfac = ctxt.getContext().zMStar.getNormBnd(); + double mfac = ctxt.getContext().getZMStar().getNormBnd(); double noise_est = ctxt.rawModSwitch(zzParts, q) * mfac; // noise_est is an upper bound on the L-infty norm of the scaled noise // in the pwrfl basis @@ -1082,7 +1088,7 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const checkRecryptBounds_v(v, dbgKey->sKeys[recryptKeyID], ctxt.getContext(), q); checkCriticalValue(zzParts, dbgKey->sKeys[recryptKeyID], - ctxt.getContext().rcData, + ctxt.getContext().getRcData(), q); } #endif @@ -1160,9 +1166,9 @@ static void checkRecryptBounds(const std::vector& zzParts, const Context& context, long q) { - const RecryptData& rcData = context.rcData; + const RecryptData& rcData = context.getRcData(); double coeff_bound = context.boundForRecryption(); - long p2r = context.alMod.getPPowR(); + long p2r = context.getAlMod().getPPowR(); NTL::ZZX ptxt; rawDecrypt(ptxt, zzParts, sKey); // no mod q @@ -1198,12 +1204,12 @@ static void checkRecryptBounds_v(const std::vector& v, { const RecryptData& rcData = context.rcData; - long p = context.zMStar.getP(); + long p = context.getP(); long e = rcData.e; long p2e = NTL::power_long(p, e); long ePrime = rcData.ePrime; long p2ePrime = NTL::power_long(p, ePrime); - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); double fudge = compute_fudge(p2ePrime, p2e); @@ -1264,7 +1270,7 @@ static void checkRecryptBounds_v(const std::vector& v, #if 0 void fhe_stats_print(long iter, const Context& context) { - long phim = context.zMStar.getPhiM(); + long phim = context.getPhiM(); std::cerr << "||||| recryption stats ||||\n"; std::cerr << "**** averages ****\n"; diff --git a/src/sample.cpp b/src/sample.cpp index 0d9db0f38..53ad36811 100644 --- a/src/sample.cpp +++ b/src/sample.cpp @@ -240,7 +240,7 @@ void sampleUniform(NTL::ZZX& poly, long n, const NTL::ZZ& B) ********************************************************************/ double sampleHWt(zzX& poly, const Context& context, long Hwt) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); double retval; if (palg.getPow2() == 0) { // not power of two @@ -259,22 +259,17 @@ double sampleHWt(zzX& poly, const Context& context, long Hwt) double sampleHWtBoundedEffectiveBound(const Context& context, long Hwt) { - const PAlgebra& palg = context.zMStar; - long phim = palg.getPhiM(); - - double bound = sqrt(Hwt * log(phim)); // should be good with probability at least 1/2 // NOTE: the general formula is sigma*sqrt(log(phim)), // assuming we are sampling from a zero mean complex Gaussian // with std deviation sigma - - return bound; + return sqrt(Hwt * log(context.getPhiM())); } double sampleHWtBounded(zzX& poly, const Context& context, long Hwt) { double bound = sampleHWtBoundedEffectiveBound(context, Hwt); - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); #if 1 double val; @@ -324,7 +319,7 @@ double sampleHWtBounded(zzX& poly, const Context& context, long Hwt) double sampleSmall(zzX& poly, const Context& context) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); double retval; if (palg.getPow2() == 0) { // not power of two @@ -346,7 +341,7 @@ double sampleSmall(zzX& poly, const Context& context) // Same as above, but ensure the result is not too much larger than typical double sampleSmallBounded(zzX& poly, const Context& context) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); long phim = palg.getPhiM(); double bound = sqrt(phim * log(phim) / 2.0); @@ -402,7 +397,7 @@ double sampleSmallBounded(zzX& poly, const Context& context) double sampleGaussian(zzX& poly, const Context& context, double stdev) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); double retval; if (palg.getPow2() == 0) { // not power of two @@ -426,7 +421,7 @@ NTL::xdouble sampleGaussian(NTL::ZZX& poly, const Context& context, NTL::xdouble stdev) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); NTL::xdouble retval; if (palg.getPow2() == 0) { // not power of two @@ -449,7 +444,7 @@ NTL::xdouble sampleGaussian(NTL::ZZX& poly, double sampleGaussianBoundedEffectiveBound(const Context& context) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); long m = palg.getM(); long phim = palg.getPhiM(); @@ -463,7 +458,7 @@ double sampleGaussianBoundedEffectiveBound(const Context& context) // Same as above, but ensure the result is not too much larger than typical double sampleGaussianBounded(zzX& poly, const Context& context, double stdev) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); double bound = stdev * sampleGaussianBoundedEffectiveBound(context); @@ -517,7 +512,7 @@ NTL::xdouble sampleGaussianBounded(NTL::ZZX& poly, const Context& context, NTL::xdouble stdev) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); NTL::xdouble bound = stdev * sampleGaussianBoundedEffectiveBound(context); @@ -539,7 +534,7 @@ NTL::xdouble sampleGaussianBounded(NTL::ZZX& poly, double sampleUniform(zzX& poly, const Context& context, long B) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); double retval; if (palg.getPow2() == 0) { // not power of two @@ -560,7 +555,7 @@ NTL::xdouble sampleUniform(NTL::ZZX& poly, const Context& context, const NTL::ZZ& B) { - const PAlgebra& palg = context.zMStar; + const PAlgebra& palg = context.getZMStar(); NTL::xdouble retval; if (palg.getPow2() == 0) { // not power of two diff --git a/src/tableLookup.cpp b/src/tableLookup.cpp index ba2b2e726..2c175d4a0 100644 --- a/src/tableLookup.cpp +++ b/src/tableLookup.cpp @@ -67,7 +67,7 @@ void computeAllProducts(/*Output*/ CtPtrs& products, "Cannot bootstrap with non-bootstrappable public key"); packedRecrypt(array, *unpackSlotEncoding, - *(ct->getContext().ea), + ct->getContext().getEA(), /*belowLevel=*/nBits + 3); } if (findMinBitCapacity(array) < (NTL::NumBits(nBits) + 1) * bpl) diff --git a/src/tapprox.cpp b/src/tapprox.cpp index 2fcdf2dac..045035144 100644 --- a/src/tapprox.cpp +++ b/src/tapprox.cpp @@ -417,7 +417,7 @@ int main(int argc, char* argv[]) if (verbose) { std::cout << "security=" << context.securityLevel() << endl; ea.getPAlgebra().printout(); - cout << "r = " << context.alMod.getR() << endl; + cout << "r = " << context.getAlMod().getR() << endl; cout << "ctxtPrimes=" << context.ctxtPrimes << ", specialPrimes=" << context.specialPrimes << endl << endl; diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 9fce24311..beac44f07 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -40,6 +40,8 @@ if (NOT ONLY_ADD_TEST) "TestPolyModRing.cpp" "TestPtxt.cpp" "TestSet.cpp" + "TestBinIO.cpp" + "TestIO.cpp" "${CMAKE_CURRENT_BINARY_DIR}/TestVersion.cpp" # TestVersion.cpp is auto-generated in CMAKE_CURRENT_BINARY_DIR ) @@ -47,7 +49,6 @@ if (NOT ONLY_ADD_TEST) "GTestApproxNums.cpp" "GTestBinaryArith.cpp" "GTestBinaryCompare.cpp" - "GTestBinIO.cpp" "GTestBootstrapping.cpp" "GTestEaCx.cpp" "GTestEvalMap.cpp" @@ -55,7 +56,6 @@ if (NOT ONLY_ADD_TEST) "GTestFatboot.cpp" "GTestGeneral.cpp" "GTestIntraSlot.cpp" - "GTestIO.cpp" "GTestMatmul.cpp" "GTestPAlgebra.cpp" "GTestPGFFT.cpp" @@ -80,8 +80,15 @@ if (NOT ONLY_ADD_TEST) # change their running time. target_compile_options(runTests PRIVATE ${PRIVATE_HELIB_CXX_FLAGS}) - # Adding CMAKE_CURRENT_SOURCE_DIR to include files to access test_common.h. - target_include_directories(runTests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) + target_include_directories( + runTests + PRIVATE + # Adding CMAKE_CURRENT_SOURCE_DIR to include files to access + # test_common.h. + ${CMAKE_CURRENT_SOURCE_DIR} + # Adding HELIB_SOURCE_DIR to include local/private headers e.g. io.h + ${HELIB_SOURCE_DIR} + "$") # Dealing with test resource files (Test_Bin_IO and Test_IO) list(APPEND TEST_RESOURCE_FILES "test_resources/iotest_asciiBE.txt" @@ -116,7 +123,6 @@ set(TEST_NAMES "GTestApproxNums" "GTestBinaryArith" "GTestBinaryCompare" - "GTestBinIO" "GTestBootstrapping" "GTestEaCx" "GTestEvalMap" @@ -124,7 +130,6 @@ set(TEST_NAMES "GTestFatboot" "GTestGeneral" "GTestIntraSlot" - "GTestIO" "GTestMatmul" "GTestPAlgebra" "GTestPGFFT" @@ -154,6 +159,8 @@ set(TEST_NAMES "TestPtxt" "TestSet" "TestThinBootstrappingWithMultiplications" + "TestBinIO" + "TestIO" "TestVersion" ) message(STATUS "${CMAKE_BINARY_DIR}") diff --git a/tests/GTestApproxNums.cpp b/tests/GTestApproxNums.cpp index 401fc2532..1b1308b21 100644 --- a/tests/GTestApproxNums.cpp +++ b/tests/GTestApproxNums.cpp @@ -212,13 +212,18 @@ class GTestApproxNums : public ::testing::TestWithParam L(GetParam().L), epsilon(GetParam().epsilon), seed(GetParam().seed), - context(m, /*p=*/-1, r), - secretKey((context.scale = 4, buildModChain(context, L), context)), + context(helib::ContextBuilder() + .m(m) + .precision(r) + .scale(4) + .bits(L) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), addSome1DMatrices(secretKey), addSomeFrbMatrices(secretKey), secretKey)), - ea(context.ea->getCx()) + ea(context.getEA().getCx()) {} virtual void SetUp() override @@ -228,13 +233,13 @@ class GTestApproxNums : public ::testing::TestWithParam } if (helib_test::verbose) { ea.getPAlgebra().printout(); - std::cout << "r = " << context.alMod.getR() << std::endl; - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "r = " << context.getAlMod().getR() << std::endl; + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << "\n" << std::endl; helib::fhe_stats = true; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override @@ -627,7 +632,7 @@ TEST_P(GTestApproxNums, generalOpsWorkWithNewAPI) debugCompare(secretKey, p2, c2); debugCompare(secretKey, p3, c3); - long nslots = context.zMStar.getNSlots(); + long nslots = context.getNSlots(); // Random number in [-(nslots-1)..nslots-1] long rotamt = NTL::RandomBnd(2 * nslots - 1) - (nslots - 1); diff --git a/tests/GTestBinIO.cpp b/tests/GTestBinIO.cpp deleted file mode 100644 index 5c2a30c3c..000000000 --- a/tests/GTestBinIO.cpp +++ /dev/null @@ -1,420 +0,0 @@ -/* Copyright (C) 2012-2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ -#include -#include -#include -#include - -#include -#include - -#include -#include - -#include "gtest/gtest.h" -#include "test_common.h" - -namespace { - -bool isLittleEndian() -{ - int i = 1; - return static_cast(*reinterpret_cast(&i)); -} - -void cleanupFiles(const char* file) -{ - if (unlink(file)) { - std::cerr << "Delete of " << file << " failed." << std::endl; - } -} - -template -void cleanupFiles(const char* file, Files... files) -{ - cleanupFiles(file); - cleanupFiles(files...); -} - -// Compare two binary files, expecting equality of length and content -::testing::AssertionResult filesAreEqual(std::string filename1, - std::string filename2) -{ - std::ifstream file1(filename1); - std::ifstream file2(filename2); - - if (!file1.is_open() && !file2.is_open()) { - throw std::runtime_error("Could not open one of the following files: " + - filename1 + " and/or " + filename2 + "."); - } - - std::fstream::pos_type file1size, file2size; - - file1size = file1.seekg(0, std::ifstream::end).tellg(); - file1.seekg(0, std::ifstream::beg); - - file2size = file2.seekg(0, std::ifstream::end).tellg(); - file2.seekg(0, std::ifstream::beg); - - // Quick compare sizes. - if (file1size != file2size) { - file1.close(); - file2.close(); - return ::testing::AssertionFailure() - << "Files " << filename1 << " and " << filename2 - << " not the same size :(" << std::endl; - } - - // Now compare byte blocks at a time. - const size_t BLOCKSIZE = 4096; // 4 kB - - char buffer1[BLOCKSIZE]; - char buffer2[BLOCKSIZE]; - size_t curBlckSz = 0; - - for (size_t i = file1size, cnt = 0; i > 0; i -= curBlckSz, cnt++) { - - curBlckSz = std::min(BLOCKSIZE, i); - - file1.read(buffer1, curBlckSz); - file2.read(buffer2, curBlckSz); - - if (memcmp(buffer1, buffer2, curBlckSz)) { - return ::testing::AssertionFailure() - << "Block " << cnt << " (block size: " << BLOCKSIZE << " bytes) " - << cnt << " does not match :(" << std::endl; - } - } - return ::testing::AssertionSuccess(); // Files are the same! -} - -struct Parameters -{ - Parameters(long m, - long r, - long p, - long c, - long L, - const std::string& sampleFilePrefix, - bool cleanup) : - m(m), - r(r), - p(p), - c(c), - L(L), - sampleFilePrefix(sampleFilePrefix), - cleanup(cleanup){}; - long m; - long r; - long p; - long c; - long L; - std::string sampleFilePrefix; - bool cleanup; - - friend std::ostream& operator<<(std::ostream& os, const Parameters& params) - { - return os << "{" - << "m=" << params.m << "," - << "r=" << params.r << "," - << "p=" << params.p << "," - << "c=" << params.c << "," - << "L=" << params.L << "," - << "sampleFilePrefix=" << params.sampleFilePrefix << "," - << "cleanup=" << params.cleanup << "}"; - }; -}; - -class GTestBinIO : public ::testing::TestWithParam -{ -protected: - const long m; - const long r; - const long p; - const long c; - const long w; - const long L; - const std::string sampleFilePrefix; - const bool cleanup; - - static std::string testResourcePath; - static std::string asciiFile1; - static std::string asciiFile2; - static std::string binFile1; - static std::string otherEndianFileOut; - - static std::string getTestResourcePath() - { - std::string testResourcePath; - std::string executablePath(helib_test::path_of_executable); - std::size_t found; - if ((found = executablePath.find_last_of("/")) == std::string::npos) { - // Then there's no / in the filepath - testResourcePath = "../test_resources"; - } else { - testResourcePath = executablePath.substr(0, found) + "/../test_resources"; - } - return testResourcePath; - }; - - GTestBinIO() : - m(GetParam().m), - r(GetParam().r), - p(GetParam().p), - c(GetParam().c), - w(64), - L(GetParam().L), - sampleFilePrefix(GetParam().sampleFilePrefix), - cleanup(GetParam().cleanup){}; - - void SetUp() override{ - // Nothing clear to do here for now the way the test is written - }; - - virtual void TearDown() override { helib::cleanupDebugGlobals(); } - -public: - static void SetUpTestCase() - { - testResourcePath = getTestResourcePath(); - asciiFile1 = testResourcePath + "/iotest_ascii1.txt"; - asciiFile2 = testResourcePath + "/iotest_ascii2.txt"; - binFile1 = testResourcePath + "/iotest_bin.bin"; - otherEndianFileOut = testResourcePath + "/iotest_ascii3.bin"; - }; -}; - -std::string GTestBinIO::testResourcePath; -std::string GTestBinIO::asciiFile1; -std::string GTestBinIO::asciiFile2; -std::string GTestBinIO::binFile1; -std::string GTestBinIO::otherEndianFileOut; - -TEST_P(GTestBinIO, implementsBinaryFileIoCorrectly) -{ - { // 1. Write ASCII and bin files - std::ofstream asciiFile(asciiFile1); - std::ofstream binFile(binFile1, std::ios::binary); - ASSERT_TRUE(asciiFile.is_open()); - - std::unique_ptr context(new helib::Context(m, p, r)); - helib::buildModChain(*context, L, c); // Set the modulus chain - - if (!helib_test::noPrint) { - std::cout << "Test to write out ASCII and Binary Files.\n"; - context->zMStar.printout(); // Printout context params - std::cout << "\tSecurity Level: " << context->securityLevel() - << std::endl; - } - std::unique_ptr secKey(new helib::SecKey(*context)); - helib::PubKey* pubKey = (helib::PubKey*)secKey.get(); - secKey->GenSecKey(); - helib::addSome1DMatrices(*secKey); - helib::addFrbMatrices(*secKey); - - helib::setupDebugGlobals(secKey.get(), context->ea); - - // ASCII - if (!helib_test::noPrint) { - std::cout << "\tWriting ASCII1 file " << asciiFile1 << std::endl; - } - helib::writeContextBase(asciiFile, *context); - asciiFile << *context << std::endl << std::endl; - asciiFile << *pubKey << std::endl << std::endl; - asciiFile << *secKey << std::endl << std::endl; - - // Bin - if (!helib_test::noPrint) { - std::cout << "\tWriting Binary file " << binFile1 << std::endl; - } - helib::writeContextBaseBinary(binFile, *context); - helib::writeContextBinary(binFile, *context); - helib::writePubKeyBinary(binFile, *pubKey); - helib::writeSecKeyBinary(binFile, *secKey); - - asciiFile.close(); - binFile.close(); - } - { // 2. Read in bin files and write out ASCII. - if (!helib_test::noPrint) { - std::cout << "Test to read binary file and write it out as ASCII" - << std::endl; - } - - std::ifstream inFile(binFile1, std::ios::binary); - std::ofstream outFile(asciiFile2); - - // Read in context, - std::unique_ptr context = - helib::buildContextFromBinary(inFile); - helib::readContextBinary(inFile, *context); - - // Read in SecKey and PubKey. - std::unique_ptr secKey(new helib::SecKey(*context)); - helib::PubKey* pubKey = (helib::PubKey*)secKey.get(); - - helib::setupDebugGlobals(secKey.get(), context->ea); - - helib::readPubKeyBinary(inFile, *pubKey); - helib::readSecKeyBinary(inFile, *secKey); - - // ASCII - if (!helib_test::noPrint) { - std::cout << "\tWriting ASCII2 file." << std::endl; - } - helib::writeContextBase(outFile, *context); - outFile << *context << std::endl << std::endl; - outFile << *pubKey << std::endl << std::endl; - outFile << *secKey << std::endl << std::endl; - - inFile.close(); - outFile.close(); - } - { // 3. Compare byte-wise the two ASCII files - if (!helib_test::noPrint) { - std::cout << "Comparing the two ASCII files\n"; - } - - ASSERT_TRUE(filesAreEqual(asciiFile1, asciiFile2)); - } - { // 4. Read in binary and perform operation. - if (!helib_test::noPrint) { - std::cout << "Test reading in Binary files and performing an operation " - "between two ctxts\n"; - } - - std::ifstream inFile(binFile1, std::ios::binary); - - // Read in context, - std::unique_ptr context = - helib::buildContextFromBinary(inFile); - helib::readContextBinary(inFile, *context); - - // Read in PubKey. - std::unique_ptr secKey(new helib::SecKey(*context)); - helib::PubKey* pubKey = (helib::PubKey*)secKey.get(); - helib::readPubKeyBinary(inFile, *pubKey); - helib::readSecKeyBinary(inFile, *secKey); - inFile.close(); - - helib::setupDebugGlobals(secKey.get(), context->ea); - - // Get the ea - const helib::EncryptedArray& ea = *context->ea; - - // Setup some ptxts and ctxts. - helib::Ctxt c1(*pubKey), c2(*pubKey); - helib::PlaintextArray p1(ea), p2(ea); - - random(ea, p1); - random(ea, p2); - - ea.encrypt(c1, *pubKey, p1); - ea.encrypt(c2, *pubKey, p2); - - // Operation multiply and add. - mul(ea, p1, p2); - c1.multiplyBy(c2); - // c1 *= c2; - - // Decrypt and Compare. - helib::PlaintextArray pp1(ea); - ea.decrypt(c1, *secKey, pp1); - - ASSERT_TRUE(equals(ea, p1, pp1)) << "BAD"; - - if (cleanup) { - if (!helib_test::noPrint) - std::cout << "Clean up. Deleting created files." << std::endl; - cleanupFiles(asciiFile1.c_str(), asciiFile2.c_str(), binFile1.c_str()); - } - } - { // 5. Read in binary from opposite little endian and print ASCII and compare - bool littleEndian = isLittleEndian(); - - std::string otherEndianFileIn = testResourcePath + sampleFilePrefix + - (littleEndian ? "_BE.bin" : "_LE.bin"); - std::string otherEndianASCII = testResourcePath + sampleFilePrefix + - (littleEndian ? "_BE.txt" : "_LE.txt"); - - if (!helib_test::noPrint) { - std::cout << "Test to read in" << (littleEndian ? " BE " : " LE ") - << "binary file and write it out as ASCII" << std::endl; - } - - if (sampleFilePrefix.empty()) { - if (!helib_test::noPrint) - std::cout << "\tSample prefix not provided, test not done." - << std::endl; - } else { - if (!helib_test::noPrint) { - std::cout << "\tSample file used: " << otherEndianFileIn << std::endl; - } - - std::ifstream inFile(otherEndianFileIn, std::ios::binary); - - ASSERT_TRUE(inFile.is_open()) - << "file " << otherEndianFileIn << " could not be opened."; - std::ofstream outFile(otherEndianFileOut); - - // Read in context, - std::unique_ptr context = - helib::buildContextFromBinary(inFile); - helib::readContextBinary(inFile, *context); - - // Read in SecKey and PubKey. - std::unique_ptr secKey(new helib::SecKey(*context)); - helib::PubKey* pubKey = (helib::PubKey*)secKey.get(); - - helib::readPubKeyBinary(inFile, *pubKey); - helib::readSecKeyBinary(inFile, *secKey); - inFile.close(); - - // ASCII - if (!helib_test::noPrint) { - std::cout << "\tWriting other endian file." << std::endl; - } - helib::writeContextBase(outFile, *context); - outFile << *context << std::endl << std::endl; - outFile << *pubKey << std::endl << std::endl; - outFile << *secKey << std::endl << std::endl; - outFile.close(); - - // Compare byte-wise the two ASCII files - if (!helib_test::noPrint) { - std::cout << "Comparing the two ASCII files\n"; - } - - ASSERT_TRUE(filesAreEqual(otherEndianASCII, otherEndianFileOut)); - - if (cleanup) { - if (!helib_test::noPrint) { - std::cout << "Clean up. Deleting created files." << std::endl; - } - cleanupFiles(otherEndianFileOut.c_str()); - } - } - } -} - -INSTANTIATE_TEST_SUITE_P( - representativeParameters, - GTestBinIO, - ::testing::Values( - // SLOW - Parameters(127, 2, 2, 2, 300, std::string{}, true), - Parameters(127, 1, 257, 2, 300, std::string{}, true) - // FAST - // Parameters(91, 1, 2, 2, 300, std::string{}, true) - )); - -} // namespace diff --git a/tests/GTestBinaryArith.cpp b/tests/GTestBinaryArith.cpp index 90cb03780..d36e6748e 100644 --- a/tests/GTestBinaryArith.cpp +++ b/tests/GTestBinaryArith.cpp @@ -171,14 +171,14 @@ class GTestBinaryArith : std::cout << " using " << NTL::AvailableThreads() << " threads\n"; std::cout << "computing key-independent tables..." << std::flush; } - buildModChain(context, L, c, /*willBeBootstrappable=*/bootstrap); + context.buildModChain(L, c, /*willBeBootstrappable=*/bootstrap); if (bootstrap) { context.enableBootStrapping(mvec); } - buildUnpackSlotEncoding(unpackSlotEncoding, *context.ea); + buildUnpackSlotEncoding(unpackSlotEncoding, context.getEA()); if (helib_test::verbose) { std::cout << " done.\n"; - context.zMStar.printout(); + context.printout(); } return context; }; @@ -235,7 +235,14 @@ class GTestBinaryArith : B(vals[13]), c(vals[14]), L(calculateLevels(bootstrap, outSize, bitSize)), - context(m, p, /*r=*/1, gens, ords), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(1) + .gens(gens) + .ords(ords) + .buildModChain(false) + .build()), secKey(prepareContext(context)){}; void SetUp() override @@ -249,7 +256,7 @@ class GTestBinaryArith : helib::activeContext = &context; // make things a little easier sometimes - helib::setupDebugGlobals(&secKey, context.ea); + helib::setupDebugGlobals(&secKey, context.shareEA()); } virtual void TearDown() override @@ -350,7 +357,7 @@ TEST_P(GTestBinaryArith, product) // bit, however packing more into the slots is possible. // LSB is at the start (left) of the vector. - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // outSize 1's on the least significant end of mask. long mask = (outSize ? ((1L << outSize) - 1) : -1); @@ -494,7 +501,7 @@ TEST_P(GTestBinaryArith, add) // bit, however packing more into the slots is possible. // LSB is at the start(left) of the vector. - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // outSize 1's on the least significant end of mask. long mask = (outSize ? ((1L << outSize) - 1) : -1); @@ -591,7 +598,7 @@ TEST_P(GTestBinaryArith, addManyNumbers) // LSB is at the start(left) of the vector. const long num_summands = 5; - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // outSize 1's on the least significant end of mask. long mask = (outSize ? ((1L << outSize) - 1) : -1); @@ -669,7 +676,7 @@ TEST_P(GTestBinaryArith, negateNegatesCorrectly) { // Randomly generate a number in 2's complement and negate it. - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); unsigned long input_data = NTL::RandomBits_long(bitSize); long mask = ((1L << bitSize) - 1); @@ -711,7 +718,7 @@ TEST_P(GTestBinaryArith, subtractSubtractsCorrectly) { // Randomly generate two numbers in 2's complement and subtract one from the // other. - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); unsigned long minuend_data = NTL::RandomBits_long(bitSize); unsigned long subtrahend_data = NTL::RandomBits_long(bitSize); @@ -766,7 +773,7 @@ TEST_P(GTestBinaryArith, subtractSubtractsCorrectly) TEST_P(GTestBinaryArith, binaryMaskMasksCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); const helib::PubKey& pubKey = secKey; helib::Ctxt mask(secKey); helib::Ptxt mask_data(context); @@ -799,7 +806,7 @@ TEST_P(GTestBinaryArith, binaryMaskMasksCorrectly) TEST_P(GTestBinaryArith, binaryCondWorksCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); const helib::PubKey& pubKey = secKey; helib::Ctxt cond(secKey); helib::Ptxt cond_data(context); @@ -851,7 +858,7 @@ TEST_P(GTestBinaryArith, binaryCondWorksCorrectly) TEST_P(GTestBinaryArith, concatBinaryNumsConcatsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long lhs_number = NTL::RandomBits_long(bitSize); long rhs_number = NTL::RandomBits_long(bitSize); @@ -892,7 +899,7 @@ TEST_P(GTestBinaryArith, concatBinaryNumsConcatsCorrectly) TEST_P(GTestBinaryArith, splitBinaryNumsSplitsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long lhs_number = NTL::RandomBits_long(bitSize + 1); long rhs_number = NTL::RandomBits_long(bitSize); @@ -946,7 +953,7 @@ TEST_P(GTestBinaryArith, splitBinaryNumsSplitsCorrectly) TEST_P(GTestBinaryArith, bitwiseShiftShiftsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long number = NTL::RandomBits_long(bitSize); std::vector eNums(bitSize, helib::Ctxt(secKey)); @@ -986,7 +993,7 @@ TEST_P(GTestBinaryArith, bitwiseShiftShiftsCorrectly) TEST_P(GTestBinaryArith, bitwiseRotateRotatesCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long input = NTL::RandomBits_long(bitSize); std::vector eNums(bitSize, helib::Ctxt(secKey)); @@ -1033,7 +1040,7 @@ TEST_P(GTestBinaryArith, bitwiseRotateRotatesCorrectly) TEST_P(GTestBinaryArith, binaryAndWithLongAndsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long number = NTL::RandomBits_long(bitSize); unsigned long long_mask = 0; @@ -1072,7 +1079,7 @@ TEST_P(GTestBinaryArith, binaryAndWithLongAndsCorrectly) TEST_P(GTestBinaryArith, binaryXORXORsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long lhs = NTL::RandomBits_long(bitSize); long rhs = NTL::RandomBits_long(bitSize); @@ -1113,7 +1120,7 @@ TEST_P(GTestBinaryArith, binaryXORXORsCorrectly) TEST_P(GTestBinaryArith, binaryAndAndsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long lhs = NTL::RandomBits_long(bitSize); long rhs = NTL::RandomBits_long(bitSize); @@ -1154,7 +1161,7 @@ TEST_P(GTestBinaryArith, binaryAndAndsCorrectly) TEST_P(GTestBinaryArith, binaryOrOrsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long lhs = NTL::RandomBits_long(bitSize); long rhs = NTL::RandomBits_long(bitSize); @@ -1195,7 +1202,7 @@ TEST_P(GTestBinaryArith, binaryOrOrsCorrectly) TEST_P(GTestBinaryArith, bitwiseNotNotsCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); long input = NTL::RandomBits_long(bitSize); std::vector eNums(bitSize, helib::Ctxt(secKey)); diff --git a/tests/GTestBinaryCompare.cpp b/tests/GTestBinaryCompare.cpp index a02d0e793..bcb81c16e 100644 --- a/tests/GTestBinaryCompare.cpp +++ b/tests/GTestBinaryCompare.cpp @@ -146,15 +146,15 @@ class GTestBinaryCompare : std::cout << " using " << NTL::AvailableThreads() << " threads\n"; std::cout << "computing key-independent tables..." << std::flush; } - buildModChain(context, L, c, /*willBeBootstrappable=*/bootstrap); + context.buildModChain(L, c, /*willBeBootstrappable=*/bootstrap); if (bootstrap) { context.enableBootStrapping(mvec); } - buildUnpackSlotEncoding(unpackSlotEncoding, *context.ea); + buildUnpackSlotEncoding(unpackSlotEncoding, context.getEA()); if (helib_test::verbose) { std::cout << " done.\n"; - context.zMStar.printout(); + context.printout(); } return context; @@ -204,8 +204,16 @@ class GTestBinaryCompare : ords(calculateOrds(vals)), c(vals[14]), L(calculateLevels(bootstrap, bitSize)), - context(m, p, /*r=*/1, gens, ords), - secKey(prepareContext(context)){}; + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(1) + .gens(gens) + .ords(ords) + .buildModChain(false) + .build()), + secKey(prepareContext(context)) + {} void SetUp() override { @@ -218,7 +226,7 @@ class GTestBinaryCompare : helib::activeContext = &context; // make things a little easier sometimes - helib::setupDebugGlobals(&secKey, context.ea); + helib::setupDebugGlobals(&secKey, context.shareEA()); }; virtual void TearDown() override @@ -241,7 +249,7 @@ constexpr long GTestBinaryCompare::mValues[5][15]; TEST_P(GTestBinaryCompare, comparison) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // Choose two random n-bit integers long pa = NTL::RandomBits_long(bitSize); @@ -348,7 +356,7 @@ TEST_P(GTestBinaryCompare, comparison) TEST_P(GTestBinaryCompare, comparingTwoPositiveNumbersInTwosComplementWorksCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // Choose random n-bit numbers in 2's complement long pa = NTL::RandomBits_long(bitSize - 1); @@ -422,7 +430,7 @@ TEST_P(GTestBinaryCompare, TEST_P(GTestBinaryCompare, comparingTwoNegativeNumbersInTwosComplementWorksCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // Choose random n-bit numbers in 2's complement long pa_data = NTL::RandomBits_long(bitSize - 1); @@ -500,7 +508,7 @@ TEST_P(GTestBinaryCompare, TEST_P(GTestBinaryCompare, comparingNegativeAndPositiveNumbersInTwosComplementWorksCorrectly) { - const helib::EncryptedArray& ea = *context.ea; + const helib::EncryptedArray& ea = context.getEA(); // Choose random n-bit numbers in 2's complement long pa_data = NTL::RandomBits_long(bitSize - 1); diff --git a/tests/GTestBootstrapping.cpp b/tests/GTestBootstrapping.cpp index ef06e7b27..1ddb84192 100644 --- a/tests/GTestBootstrapping.cpp +++ b/tests/GTestBootstrapping.cpp @@ -254,31 +254,34 @@ TEST_P(GTestBootstrapping, bootstrappingWorksCorrectly) helib::setDryRun(false); // Need to get a "real context" to test bootstrapping double t = -NTL::GetTime(); - helib::Context context(m, p, r, gens, ords); + helib::ContextBuilder cb; + cb.m(m).p(p).r(r).gens(gens).ords(ords); if (scale) { - context.scale = scale; + cb.scale(scale); } + helib::Context context = cb.buildModChain(false).build(); - context.zMStar.set_cM(mValues[idx][13] / 100.0); - helib::buildModChain(context, - L, - c, - /*willBeBootstrappable=*/true, - /*t=*/skHwt); + context.buildModChain(L, + c, + /*willBeBootstrappable=*/true, + /*t=*/skHwt); if (!helib_test::noPrint) { std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << "\n"; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << "\n"; + std::cout << "# small primes = " << context.getSmallPrimes().card() << "\n"; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n"; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + 0.5) + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) + << "\n"; + std::cout << "# special primes = " << context.getSpecialPrimes().card() << "\n"; - std::cout << "# special primes = " << context.specialPrimes.card() << "\n"; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << "\n"; - std::cout << "scale=" << context.scale << std::endl; + std::cout << "scale=" << context.getScale() << std::endl; } // FIXME: The willBeBootstrappable flag is a hack, used to bypass the @@ -291,14 +294,15 @@ TEST_P(GTestBootstrapping, bootstrappingWorksCorrectly) // if (skHwt>0) context.rcData.skHwt = skHwt; if (!helib_test::noPrint) { std::cout << " done in " << t << " seconds\n"; - std::cout << " e=" << context.rcData.e << ", e'=" << context.rcData.ePrime - << ", t=" << context.rcData.skHwt << "\n "; - context.zMStar.printout(); + std::cout << " e=" << context.getRcData().e + << ", e'=" << context.getRcData().ePrime + << ", t=" << context.getRcData().skHwt << "\n"; + context.printout(); } helib::setDryRun( helib_test::dry); // Now we can set the dry-run flag if desired - long p2r = context.alMod.getPPowR(); + long p2r = context.getAlMod().getPPowR(); for (long numkey = 0; numkey < OUTER_REP; numkey++) { // test with 3 keys @@ -319,9 +323,9 @@ TEST_P(GTestBootstrapping, bootstrappingWorksCorrectly) std::cout << " done in " << t << " seconds\n"; NTL::zz_p::init(p2r); - NTL::zz_pX poly_p = NTL::random_zz_pX(context.zMStar.getPhiM()); + NTL::zz_pX poly_p = NTL::random_zz_pX(context.getPhiM()); helib::PowerfulConversion pConv( - context.rcData.p2dConv->getIndexTranslation()); + context.getRcData().p2dConv->getIndexTranslation()); helib::HyperCube powerful(pConv.getShortSig()); pConv.polyToPowerful(powerful, poly_p); NTL::ZZX ptxt_poly = NTL::conv(poly_p); diff --git a/tests/GTestEaCx.cpp b/tests/GTestEaCx.cpp index 6f52da129..81796315c 100644 --- a/tests/GTestEaCx.cpp +++ b/tests/GTestEaCx.cpp @@ -45,8 +45,13 @@ class GTestEaCx : public ::testing::TestWithParam GTestEaCx() : m(GetParam().m), r(GetParam().r), - context(m, /*p=*/-1, r), - eacx((helib::buildModChain(context, 5, 2), context.ea->getCx())) + context(helib::ContextBuilder() + .m(m) + .precision(r) + .bits(5) + .c(2) + .build()), + eacx(context.getEA().getCx()) {} virtual void SetUp() override diff --git a/tests/GTestEvalMap.cpp b/tests/GTestEvalMap.cpp index 97758b2f2..cb9a6c75a 100644 --- a/tests/GTestEvalMap.cpp +++ b/tests/GTestEvalMap.cpp @@ -106,7 +106,7 @@ class GTestEvalMap : public ::testing::TestWithParam helib::SecKey secretKey; const helib::PubKey& publicKey; - static NTL::Vec getDefaultMvec() + static NTL::Vec getMvec() { NTL::Vec defaultMvec; defaultMvec.SetLength(3); @@ -116,15 +116,12 @@ class GTestEvalMap : public ::testing::TestWithParam return defaultMvec; }; - static std::vector getDefaultGens() + static std::vector getGens() { return std::vector{3979, 3095, 3760}; }; - static std::vector getDefaultOrds() - { - return std::vector{6, 2, -8}; - }; + static std::vector getOrds() { return std::vector{6, 2, -8}; }; // Throws if mvec is invalid, returns mvec otherwise static NTL::Vec checkMvec(NTL::Vec mvec) @@ -151,15 +148,13 @@ class GTestEvalMap : public ::testing::TestWithParam return m; }; - static void prepareContext(helib::Context& context, long L, long c) + static void printContext(helib::Context& context) { - helib::buildModChain(context, L, c); - if (!helib_test::noPrint) { - context.zMStar.printout(); // print structure of Zm* /(p) to std::cout + context.printout(); // print structure of Zm* /(p) to std::cout std::cout << std::endl; } - }; + } GTestEvalMap() : p(GetParam().p), @@ -169,26 +164,31 @@ class GTestEvalMap : public ::testing::TestWithParam L(GetParam().L), s(GetParam().s), seed(GetParam().seed), - mvec(checkMvec(helib::lsize(GetParam().mvec) < 1 ? getDefaultMvec() + mvec(checkMvec(helib::lsize(GetParam().mvec) < 1 ? getMvec() : GetParam().mvec)), m(calculateM(mvec, p)), - gens(helib::lsize(GetParam().mvec) < 1 ? getDefaultGens() - : GetParam().gens), - ords(helib::lsize(GetParam().mvec) < 1 ? getDefaultOrds() - : GetParam().ords), + gens(helib::lsize(GetParam().mvec) < 1 ? getGens() : GetParam().gens), + ords(helib::lsize(GetParam().mvec) < 1 ? getOrds() : GetParam().ords), nthreads(GetParam().nthreads), useCache(GetParam().useCache), - context((helib::setDryRun(false), m), - p, - r, - gens, - ords), // We need to get a 'real' context to test EvalMap. - d((prepareContext(context, L, c), context.zMStar.getOrdP())), - phim(context.zMStar.getPhiM()), + context( + (helib::setDryRun(false), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(L) + .c(c) + .build())), // We need to get a 'real' context to test EvalMap. + d((printContext(context), context.getOrdP())), + phim(context.getPhiM()), nslots(phim / d), secretKey((helib::setDryRun(helib_test::dry), context)), // We can now switch to dry run if desired. - publicKey(secretKey){}; + publicKey(secretKey) + {} void SetUp() override { @@ -202,7 +202,7 @@ class GTestEvalMap : public ::testing::TestWithParam helib::addFrbMatrices( secretKey); // compute key-switching matrices that we need - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); }; virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -212,10 +212,10 @@ TEST_P(GTestEvalMap, evalMapBehavesCorrectly) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; - GG = context.alMod.getFactorsOverZZ()[0]; + GG = context.getAlMod().getFactorsOverZZ()[0]; helib::EncryptedArray ea(context, GG); - NTL::zz_p::init(context.alMod.getPPowR()); + NTL::zz_p::init(context.getAlMod().getPPowR()); NTL::zz_pX F; random(F, phim); // a random polynomial of degree phi(m)-1 modulo p diff --git a/tests/GTestExtractDigits.cpp b/tests/GTestExtractDigits.cpp index ddce71629..ace673fbc 100644 --- a/tests/GTestExtractDigits.cpp +++ b/tests/GTestExtractDigits.cpp @@ -76,7 +76,7 @@ class GTestExtractDigits : public ::testing::TestWithParam { long ll = NTL::NextPowerOfTwo(p); return 30 * (r * ll * 3 + 2); - }; + } GTestExtractDigits() : p(GetParam().p), @@ -86,8 +86,14 @@ class GTestExtractDigits : public ::testing::TestWithParam : p + 1), // FindM(/*secparam=*/80, L, /*c=*/4, p, /*d=*/1, 0, m); p2r(NTL::power_long(p, r)), L(calculateLevels(r, p)), - context(m, p, r), - secretKey((helib::buildModChain(context, L, /*c=*/4), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(L) + .c(4) + .build()), + secretKey(context), publicKey(secretKey) {} @@ -107,8 +113,8 @@ class GTestExtractDigits : public ::testing::TestWithParam // On legacy test is debug, but used verbose for consistency with other // tests - helib::setupDebugGlobals(&secretKey, context.ea); - }; + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } virtual void TearDown() override { helib::cleanupDebugGlobals(); } }; diff --git a/tests/GTestFatboot.cpp b/tests/GTestFatboot.cpp index d9f67e505..8e2f949d2 100644 --- a/tests/GTestFatboot.cpp +++ b/tests/GTestFatboot.cpp @@ -144,15 +144,6 @@ class GTestFatboot : public ::testing::TestWithParam time = -NTL::GetTime(); } - void postContextSetup() - { - if (scale) { - context.scale = scale; - } - - context.zMStar.set_cM(c_m / 100.0); - } - static void setGlobals(int force_bsgs, int force_hoist, int chen_han) { helib::fhe_test_force_bsgs = force_bsgs; @@ -235,10 +226,17 @@ class GTestFatboot : public ::testing::TestWithParam m(helib::computeProd(mvec)), phim((checkPM(p, m), helib::phi_N(m))), time(0), - context((preContextSetup(), m), p, r, gens, ords) - { - postContextSetup(); - } + context((preContextSetup(), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .scale(scale ? scale : 10 /*default is 10.*/) + .buildModChain(false) + .build())) + {} void TearDown() override { @@ -255,26 +253,29 @@ class GTestFatboot : public ::testing::TestWithParam TEST_P(GTestFatboot, correctlyPerformsFatboot) { - helib::buildModChain(context, - bits, - c, - /*willBeBootstrappable=*/true, - /*t=*/skHwt); + context.buildModChain(bits, + c, + /*willBeBootstrappable=*/true, + /*t=*/skHwt); if (!helib_test::noPrint) { std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << std::endl; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << std::endl; + std::cout << "# small primes = " << context.getSmallPrimes().card() + << std::endl; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() + << std::endl; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + 0.5) + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) << std::endl; - std::cout << "# special primes = " << context.specialPrimes.card() + std::cout << "# special primes = " << context.getSpecialPrimes().card() << std::endl; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << std::endl; - std::cout << "scale=" << context.scale << std::endl; + std::cout << "scale=" << context.getScale() << std::endl; } context.enableBootStrapping(mvec, useCache); @@ -282,15 +283,16 @@ TEST_P(GTestFatboot, correctlyPerformsFatboot) if (!helib_test::noPrint) { std::cout << " done in " << time << " seconds" << std::endl; - std::cout << " e=" << context.rcData.e << ", e'=" << context.rcData.ePrime - << ", t=" << context.rcData.skHwt << std::endl + std::cout << " e=" << context.getRcData().e + << ", e'=" << context.getRcData().ePrime + << ", t=" << context.getRcData().skHwt << "\n" << " "; - context.zMStar.printout(); + context.printout(); } helib::setDryRun( helib_test::dry); // Now we can set the dry-run flag if desired - long p2r = context.alMod.getPPowR(); + long p2r = context.getAlMod().getPPowR(); for (long numkey = 0; numkey < outer_rep; numkey++) { // test with 3 keys @@ -311,14 +313,14 @@ TEST_P(GTestFatboot, correctlyPerformsFatboot) std::cout << " done in " << time << " seconds\n"; NTL::zz_p::init(p2r); - NTL::zz_pX poly_p = NTL::random_zz_pX(context.zMStar.getPhiM()); + NTL::zz_pX poly_p = NTL::random_zz_pX(context.getPhiM()); helib::zzX poly_p1 = helib::balanced_zzX(poly_p); NTL::ZZX ptxt_poly = helib::convert(poly_p1); NTL::ZZX ptxt_poly1; helib::PolyRed(ptxt_poly1, ptxt_poly, p2r, true); // this is the format produced by decryption - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); NTL::ZZX poly2; helib::Ctxt c1(publicKey); diff --git a/tests/GTestGeneral.cpp b/tests/GTestGeneral.cpp index 41a3e6d33..2dc2add5f 100644 --- a/tests/GTestGeneral.cpp +++ b/tests/GTestGeneral.cpp @@ -208,7 +208,7 @@ class GTestGeneral : public ::testing::TestWithParam helib::addSome1DMatrices( secretKey); // compute key-switching matrices that we need - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); if (!helib_test::noPrint) { helib::fhe_stats = true; } @@ -230,23 +230,26 @@ TEST_P(GTestGeneral, correctlyImplementsMixOfOperationsOverFourCiphertexts) NTL::ZZX G; if (d == 0) - G = context.alMod.getFactorsOverZZ()[0]; + G = context.getAlMod().getFactorsOverZZ()[0]; else G = helib::makeIrredPoly(p, d); if (!helib_test::noPrint) { - context.zMStar.printout(); + context.getZMStar().printout(); std::cout << std::endl; std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << "\n"; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << "\n"; + std::cout << "# small primes = " << context.getSmallPrimes().card() << "\n"; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n"; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + 0.5) + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) + << "\n"; + std::cout << "# special primes = " << context.getSpecialPrimes().card() << "\n"; - std::cout << "# special primes = " << context.specialPrimes.card() << "\n"; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << "\n"; std::cout << "G = " << G << "\n"; @@ -466,23 +469,26 @@ TEST_P(GTestGeneral, rotate1D) NTL::ZZX G; if (d == 0) - G = context.alMod.getFactorsOverZZ()[0]; + G = context.getAlMod().getFactorsOverZZ()[0]; else G = helib::makeIrredPoly(p, d); if (!helib_test::noPrint) { - context.zMStar.printout(); + context.getZMStar().printout(); std::cout << std::endl; std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << "\n"; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << "\n"; + std::cout << "# small primes = " << context.getSmallPrimes().card() << "\n"; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n"; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + 0.5) + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) + << "\n"; + std::cout << "# special primes = " << context.getSpecialPrimes().card() << "\n"; - std::cout << "# special primes = " << context.specialPrimes.card() << "\n"; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << "\n"; std::cout << "G = " << G << "\n"; @@ -505,7 +511,8 @@ TEST_P(GTestGeneral, rotate1D) random(ea, p1); random(ea, p2); - long dim = context.zMStar.numOfGens() > 1 ? 1 : 0; // Dimension of rotation + long dim = + context.getZMStar().numOfGens() > 1 ? 1 : 0; // Dimension of rotation helib::Ctxt c0(publicKey), c1(publicKey), c2(publicKey); ea.encrypt(c0, publicKey, p0); diff --git a/tests/GTestIO.cpp b/tests/GTestIO.cpp deleted file mode 100644 index 0431b36c1..000000000 --- a/tests/GTestIO.cpp +++ /dev/null @@ -1,359 +0,0 @@ -/* Copyright (C) 2012-2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include -#include - -#include -#include - -#include -#include - -#include "gtest/gtest.h" -#include "test_common.h" - -namespace { -struct Parameters -{ - long r; // lifting - long p; // plaintext base - long c; // number of columns in the key-switching matrices - long mm; // cyclotomic index - - Parameters(long r, long p, long c, long mm) : r(r), p(p), c(c), mm(mm){}; - - friend std::ostream& operator<<(std::ostream& os, const Parameters& params) - { - return os << "{" - << "r=" << params.r << "," - << "p=" << params.p << "," - << "c=" << params.c << "," - << "mm=" << params.mm << "}"; - }; -}; - -class GTestIO : public ::testing::TestWithParam -{ -protected: -#define N_TESTS 3 - static constexpr long ms[N_TESTS][10] = { - // nSlots m phi(m) ord(2) - // { 2, 7, 6, 3, 0,0,0,0,0,0}, - {6, 31, 30, 5, 0, 0, 0, 0, 0, 0}, - {6, 127, 126, 7, 127, 1, 108, 24, 6, -3}, // gens=108(6), 24(!3) - {60, 1023, 600, 10, 11, 93, 838, 584, 10, 6}, // gens=838(10),584(6) - // { 378, 5461, 5292, 14}, // gens=3(126),509(3) - // { 630, 8191, 8190, 13}, // gens=39(630) - // { 600, 13981, 12000, 20}, // gens=10(30),23(10),3(!2) - // { 682, 15709, 15004, 22} // gens=5(682) - }; - - static std::string keyFilePath; - static std::string getTestResourcePath() - { - std::string testResourcePath; - std::string executablePath(helib_test::path_of_executable); - std::size_t found; - if ((found = executablePath.find_last_of("/")) == std::string::npos) { - // Then there's no / in the filepath - testResourcePath = "../test_resources"; - } else { - testResourcePath = executablePath.substr(0, found) + "/../test_resources"; - } - return testResourcePath; - }; - - GTestIO() : - r(GetParam().r), - p(GetParam().p), - c(GetParam().c), - w(64), - L(100), - mm(GetParam().mm), - useTable(mm == 0 && p == 2), - ptxtSpace(NTL::power_long(p, r)), - numTests(useTable ? N_TESTS : 1), - contexts(numTests), - sKeys(numTests), - ctxts(numTests), - eas(numTests), - ptxts(numTests){}; - - const long r; - const long p; - const long c; - const long w; - const long L; - const long mm; - const bool useTable; - const long ptxtSpace; - const long numTests; - - std::vector> contexts; - std::vector> sKeys; - std::vector> ctxts; - std::vector> eas; - std::vector> ptxts; - - virtual void TearDown() override { helib::cleanupDebugGlobals(); } - -public: - static void SetUpTestCase() - { - keyFilePath = getTestResourcePath() + "/iotest.txt"; - }; - - static void TearDownTestCase() - { - unlink(keyFilePath.c_str()); // clean up before exiting - }; -}; - -constexpr long GTestIO::ms[N_TESTS][10]; -std::string GTestIO::keyFilePath; - -// Testing the I/O of the important classes of the library -// (context, keys, ciphertexts). -TEST_P(GTestIO, importantClassesRemainConsistentUnderIo) -{ - // first loop: generate stuff and write it to file - - // open file for writing - { - std::fstream keyFile(keyFilePath, std::fstream::out | std::fstream::trunc); - ASSERT_TRUE(keyFile.is_open()); - for (long i = 0; i < numTests; i++) { - long m = (mm == 0) ? ms[i][1] : mm; - - if (!helib_test::noPrint) { - std::cout << "Testing IO: m=" << m << ", p^r=" << p << "^" << r - << std::endl; - } - - NTL::Vec mvec(NTL::INIT_SIZE, 2); - mvec[0] = ms[i][4]; - mvec[1] = ms[i][5]; - std::vector gens(2); - gens[0] = ms[i][6]; - gens[1] = ms[i][7]; - std::vector ords(2); - ords[0] = ms[i][8]; - ords[1] = ms[i][9]; - - if (useTable && gens[0] > 0) - contexts[i].reset(new helib::Context(m, p, r, gens, ords)); - else - contexts[i].reset(new helib::Context(m, p, r)); - if (!helib_test::noPrint) { - contexts[i]->zMStar.printout(); - } - - helib::buildModChain(*contexts[i], L, c); // Set the modulus chain - if (mm == 0 && m == 1023) - contexts[i]->enableBootStrapping(mvec); - - // Output the Context to file - helib::writeContextBase(keyFile, *contexts[i]); - if (!helib_test::noPrint) { - helib::writeContextBase(std::cout, *contexts[i]); - std::cout << std::endl; - } - keyFile << *contexts[i] << std::endl; - - sKeys[i].reset(new helib::SecKey(*contexts[i])); - sKeys[i]->GenSecKey(); // A +-1/0 secret key - addSome1DMatrices( - *sKeys[i]); // compute key-switching matrices that we need - const helib::PubKey publicKey = *sKeys[i]; - eas[i].reset(new helib::EncryptedArray(*contexts[i])); - - long nslots = eas[i]->size(); - - // Output the secret key to file, twice. Below we will have two copies - // of most things. - keyFile << *sKeys[i] << std::endl; - ; - keyFile << *sKeys[i] << std::endl; - ; - - std::vector b; - long p2r = eas[i]->getContext().alMod.getPPowR(); - NTL::ZZX poly = helib::RandPoly( - 0, - NTL::to_ZZ(p2r)); // choose a random constant polynomial - eas[i]->decode(ptxts[i], poly); - - ctxts[i].reset(new helib::Ctxt(publicKey)); - eas[i]->encrypt(*ctxts[i], publicKey, ptxts[i]); - eas[i]->decrypt(*ctxts[i], *sKeys[i], b); - ASSERT_EQ(ptxts[i].size(), b.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(ptxts[i][j], b[j]); - } - - // output the plaintext - keyFile << "[ "; - for (long j = 0; j < nslots; j++) - keyFile << ptxts[i][j] << " "; - keyFile << "]\n"; - - eas[i]->encode(poly, ptxts[i]); - keyFile << poly << std::endl; - - // Output the ciphertext to file - keyFile << *ctxts[i] << std::endl; - keyFile << *ctxts[i] << std::endl; - // std::cerr << "okay " << i << std::endl<< std::endl; - } - keyFile.close(); - } - // std::cerr << "so far, so good\n\n"; - - // second loop: read from input and repeat the computation - - // open file for read - { - std::fstream keyFile(keyFilePath, std::fstream::in); - for (long i = 0; i < numTests; i++) { - - // Read context from file - unsigned long m1, p1, r1; - std::vector gens, ords; - helib::readContextBase(keyFile, m1, p1, r1, gens, ords); - helib::Context tmpContext(m1, p1, r1, gens, ords); - keyFile >> tmpContext; - ASSERT_EQ(*contexts[i], tmpContext); - // std::cerr << i << ": context matches input\n"; - - // We define some things below wrt *contexts[i], not tmpContext. - // This is because the various operator== methods check equality of - // references, not equality of the referenced Context objects. - helib::Context& context = *contexts[i]; - helib::SecKey secretKey(context); - helib::SecKey secretKey2(tmpContext); - const helib::PubKey& publicKey = secretKey; - const helib::PubKey& publicKey2 = secretKey2; - - keyFile >> secretKey; - keyFile >> secretKey2; - ASSERT_EQ(secretKey, *sKeys[i]); - // std::cerr << " secret key matches input\n"; - - helib::EncryptedArray ea(context); - helib::EncryptedArray ea2(tmpContext); - - long nslots = ea.size(); - - // Read the plaintext from file - std::vector a; - a.resize(nslots); - ASSERT_EQ(nslots, (long)ptxts[i].size()); - helib::seekPastChar(keyFile, '['); // defined in NumbTh.cpp - for (long j = 0; j < nslots; j++) { - keyFile >> a[j]; - ASSERT_EQ(a[j], ptxts[i][j]); - } - helib::seekPastChar(keyFile, ']'); - // std::cerr << " ptxt matches input\n"; - - // Read the encoded plaintext from file - NTL::ZZX poly1, poly2; - keyFile >> poly1; - eas[i]->encode(poly2, a); - ASSERT_EQ(poly1, poly2); - // std::cerr << " eas[i].encode(a)==poly1 okay\n"; - - ea.encode(poly2, a); - ASSERT_EQ(poly1, poly2); - // std::cerr << " ea.encode(a)==poly1 okay\n"; - - ea2.encode(poly2, a); - ASSERT_EQ(poly1, poly2); - // std::cerr << " ea2.encode(a)==poly1 okay\n"; - - eas[i]->decode(a, poly1); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " eas[i].decode(poly1)==ptxts[i] okay\n"; - - ea.decode(a, poly1); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " ea.decode(poly1)==ptxts[i] okay\n"; - - ea2.decode(a, poly1); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " ea2.decode(poly1)==ptxts[i] okay\n"; - - // Read ciphertext from file - helib::Ctxt ctxt(publicKey); - helib::Ctxt ctxt2(publicKey2); - keyFile >> ctxt; - keyFile >> ctxt2; - ASSERT_TRUE(ctxts[i]->equalsTo(ctxt, /*comparePkeys=*/false)); - // std::cerr << " ctxt matches input\n"; - - sKeys[i]->Decrypt(poly2, *ctxts[i]); - ASSERT_EQ(poly1, poly2); - // std::cerr << " sKeys[i]->decrypt(*ctxts[i]) == poly1 okay\n"; - - secretKey.Decrypt(poly2, *ctxts[i]); - ASSERT_EQ(poly1, poly2); - // std::cerr << " secretKey.decrypt(*ctxts[i]) == poly1 okay\n"; - - secretKey.Decrypt(poly2, ctxt); - ASSERT_EQ(poly1, poly2); - // std::cerr << " secretKey.decrypt(ctxt) == poly1 okay\n"; - - secretKey2.Decrypt(poly2, ctxt2); - ASSERT_EQ(poly1, poly2); - // std::cerr << " secretKey2.decrypt(ctxt2) == poly1 okay\n"; - - eas[i]->decrypt(ctxt, *sKeys[i], a); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " eas[i].decrypt(ctxt, *sKeys[i])==ptxts[i] okay\n"; - - ea.decrypt(ctxt, secretKey, a); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " ea.decrypt(ctxt, secretKey)==ptxts[i] okay\n"; - - ea2.decrypt(ctxt2, secretKey2, a); - ASSERT_EQ(nslots, (long)a.size()); - for (long j = 0; j < nslots; j++) { - ASSERT_EQ(a[j], ptxts[i][j]); - } - // std::cerr << " ea2.decrypt(ctxt2, secretKey2)==ptxts[i] okay\n"; - } - } -} - -INSTANTIATE_TEST_SUITE_P(someSmallParameters, - GTestIO, - ::testing::Values( - // FAST - Parameters(1, 2, 2, 91))); - -} // namespace diff --git a/tests/GTestIntraSlot.cpp b/tests/GTestIntraSlot.cpp index a8acf14c4..a194aced9 100644 --- a/tests/GTestIntraSlot.cpp +++ b/tests/GTestIntraSlot.cpp @@ -46,14 +46,13 @@ struct Parameters class GTestIntraSlot : public ::testing::TestWithParam { - static helib::Context& setupContext(helib::Context& context, long L) + static helib::Context& setupContext(helib::Context& context) { if (helib_test::verbose) { - context.zMStar.printout(); + context.printout(); } - buildModChain(context, L, 3); return context; - }; + } protected: GTestIntraSlot() : @@ -63,9 +62,16 @@ class GTestIntraSlot : public ::testing::TestWithParam L(GetParam().L), m(GetParam().m), seed(GetParam().seed), - context(m, p, r), - secretKey(setupContext(context, L)), - publicKey(secretKey){}; + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(L) + .c(3) + .build()), + secretKey(setupContext(context)), + publicKey(secretKey) + {} long p; long n; @@ -85,7 +91,7 @@ class GTestIntraSlot : public ::testing::TestWithParam secretKey); // compute key-switching matrices that we need helib::addFrbMatrices(secretKey); - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); }; virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -93,7 +99,7 @@ class GTestIntraSlot : public ::testing::TestWithParam TEST_P(GTestIntraSlot, packingAndUnpackingWorks) { - NTL::ZZX G = context.alMod.getFactorsOverZZ()[0]; + NTL::ZZX G = context.getAlMod().getFactorsOverZZ()[0]; helib::EncryptedArray ea(context, G); long d = ea.getDegree(); // size of each slot diff --git a/tests/GTestMatmul.cpp b/tests/GTestMatmul.cpp index 1f2c96c0d..22bb04f6b 100644 --- a/tests/GTestMatmul.cpp +++ b/tests/GTestMatmul.cpp @@ -177,21 +177,23 @@ class GTestMatmul : public ::testing::Test helib::EncryptedArray ea; std::unique_ptr matrixPtr; - static helib::Context& setupContext(helib::Context& context, long L) + static helib::Context& setupContext(helib::Context& context) { - buildModChain(context, L, /*c=*/3); if (helib_test::verbose) { - context.zMStar.printout(); - std::cout << "# small primes = " << context.smallPrimes.card() << "\n"; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << "\n"; + context.getZMStar().printout(); + std::cout << "# small primes = " << context.getSmallPrimes().card() + << "\n"; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n"; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + + << long(context.logOfProduct(context.getCtxtPrimes()) / + log(2.0) + 0.5) << "\n"; - std::cout << "# special primes = " << context.specialPrimes.card() + std::cout << "# special primes = " << context.getSpecialPrimes().card() << "\n"; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << "\n"; helib::fhe_stats = true; @@ -213,10 +215,19 @@ class GTestMatmul : public ::testing::Test gens(T::parameters.gens), ords(T::parameters.ords), ks_strategy(T::parameters.ks_strategy), - context((helib::setTimersOn(), m), p, r, gens, ords), - secretKey(setupContext(context, L)), + context((helib::setTimersOn(), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(L) + .c(3) + .build())), + secretKey(setupContext(context)), publicKey((secretKey.GenSecKey(), secretKey)), - ea(context, context.alMod), // encrypted array with "full slots" + ea(context, context.getAlMod()), // encrypted array with "full slots" matrixPtr(buildMat(ea, dim)){}; virtual void SetUp() diff --git a/tests/GTestPAlgebra.cpp b/tests/GTestPAlgebra.cpp index bd8f9fd26..88e7fe407 100644 --- a/tests/GTestPAlgebra.cpp +++ b/tests/GTestPAlgebra.cpp @@ -64,7 +64,15 @@ class GTestPAlgebra : public ::testing::TestWithParam r(GetParam().r), gens(GetParam().gens), ords(GetParam().ords), - context(m, p, r, gens, ords){}; + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .buildModChain(false) + .build()) + {} const long m; const long p; @@ -81,13 +89,13 @@ class GTestPAlgebra : public ::testing::TestWithParam for (const auto& factor : f) std::cout << factor << " "; std::cout << "]" << std::endl; - context.zMStar.printout(); + context.printout(); std::cout << std::endl; } virtual void SetUp() override { - helib::buildModChain(context, 5, 2); + context.buildModChain(5, 2); if (!helib_test::noPrint) { printPrimeFactors(m, context); } @@ -99,7 +107,6 @@ class GTestPAlgebra : public ::testing::TestWithParam TEST_P(GTestPAlgebra, readsAndWritesContextsAsStrings) { std::stringstream s1; - helib::writeContextBase(s1, context); s1 << context; std::string s2 = s1.str(); @@ -110,12 +117,7 @@ TEST_P(GTestPAlgebra, readsAndWritesContextsAsStrings) std::stringstream s3(s2); - unsigned long m1, p1, r1; - std::vector gens, ords; - helib::readContextBase(s3, m1, p1, r1, gens, ords); - - helib::Context c1(m1, p1, r1, gens, ords); - s3 >> c1; + helib::Context c1 = helib::Context::readFromJSON(s3); EXPECT_EQ(context, c1); } diff --git a/tests/GTestPolyEval.cpp b/tests/GTestPolyEval.cpp index fae520147..516b06b5c 100644 --- a/tests/GTestPolyEval.cpp +++ b/tests/GTestPolyEval.cpp @@ -80,10 +80,16 @@ class GTestPolyEval : public ::testing::TestWithParam isMonic(GetParam().isMonic), m(GetParam().m), k(GetParam().k), - context((helib::setDryRun(helib_test::dry), m), p, r), - p2r(context.alMod.getPPowR()), - ea(std::make_shared( - (helib::buildModChain(context, L, /*c=*/3), context))), + context((helib::setDryRun(helib_test::dry), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(L) + .c(3) + .build())), + p2r(context.getAlMod().getPPowR()), + ea(std::make_shared(context)), secretKey(context), publicKey((secretKey.GenSecKey(), secretKey)) // addSome1DMatrices(secretKey); // compute key-switching matrices diff --git a/tests/GTestPowerful.cpp b/tests/GTestPowerful.cpp index 3fee5b41f..db7d62065 100644 --- a/tests/GTestPowerful.cpp +++ b/tests/GTestPowerful.cpp @@ -62,19 +62,22 @@ class GTestPowerful : public ::testing::TestWithParam if (m3 > 1) append(mvec, m3); return mvec; - }; + } GTestPowerful() : mvec(computeMvec(GetParam().m1, GetParam().m2, GetParam().m3)), m(helib::computeProd(mvec)), p(GetParam().p), r(GetParam().r), - context(m, p, r){}; + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .buildModChain(false) + .build()) + {} - virtual void SetUp() override - { - helib::buildModChain(context, /*L=*/100, /*c=*/3); - }; + virtual void SetUp() override { context.buildModChain(/*L=*/100, /*c=*/3); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } }; diff --git a/tests/GTestReplicate.cpp b/tests/GTestReplicate.cpp index 5b2167dc4..e77647cfc 100644 --- a/tests/GTestReplicate.cpp +++ b/tests/GTestReplicate.cpp @@ -60,7 +60,7 @@ class GTestReplicate : public ::testing::TestWithParam static void printContextAndG(const helib::Context& context, const NTL::ZZX& G) { if (!helib_test::noPrint) { - context.zMStar.printout(); + context.printout(); std::cout << std::endl; std::cout << "G = " << G << "\n"; } @@ -68,7 +68,7 @@ class GTestReplicate : public ::testing::TestWithParam static NTL::ZZX createG(const helib::Context& context, long p, long d) { - return (d == 0) ? context.alMod.getFactorsOverZZ()[0] + return (d == 0) ? context.getAlMod().getFactorsOverZZ()[0] : helib::makeIrredPoly(p, d); }; @@ -80,10 +80,16 @@ class GTestReplicate : public ::testing::TestWithParam L(GetParam().L), bnd(GetParam().bnd), B(GetParam().B), - context((helib::setDryRun(helib_test::dry), helib::setTimersOn(), m), - p, - r), - secretKey((buildModChain(context, L, /*c=*/2), context)), + context((helib::setDryRun(helib_test::dry), + helib::setTimersOn(), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(L) + .c(2) + .build())), + secretKey(context), G(createG(context, p, d)), publicKey((printContextAndG(context, G), secretKey.GenSecKey(), // A +-1/0 secret key @@ -104,7 +110,7 @@ class GTestReplicate : public ::testing::TestWithParam ea.encode(poly_xp1, xp1); xc1 = xc0; - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); }; virtual void TearDown() override { helib::cleanupDebugGlobals(); } diff --git a/tests/GTestTableLookup.cpp b/tests/GTestTableLookup.cpp index 0c3cfe8a9..5ca5abee3 100644 --- a/tests/GTestTableLookup.cpp +++ b/tests/GTestTableLookup.cpp @@ -173,7 +173,7 @@ class GTestTableLookup : public ::testing::TestWithParam { if (helib_test::verbose) { std::cout << " done.\n"; - context.zMStar.printout(); + context.printout(); std::cout << " L=" << L << std::endl; }; } @@ -182,11 +182,11 @@ class GTestTableLookup : public ::testing::TestWithParam helib::Context& prepareContext(helib::Context& context) { printPreContextPrepDiagnostics(bitSize, outSize, nTests, nthreads); - helib::buildModChain(context, L, c, /*willBeBootstrappable*/ bootstrap); + context.buildModChain(L, c, /*willBeBootstrappable*/ bootstrap); if (bootstrap) { context.enableBootStrapping(mvec); } - helib::buildUnpackSlotEncoding(unpackSlotEncoding, *context.ea); + helib::buildUnpackSlotEncoding(unpackSlotEncoding, context.getEA()); printPostContextPrepDiagnostics(context, L); return context; }; @@ -233,7 +233,14 @@ class GTestTableLookup : public ::testing::TestWithParam ords(calculateOrds(vals)), c(vals[14]), L(calculateLevels(bootstrap, bitSize)), - context(m, p, /*r=*/1, gens, ords), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(1) + .gens(gens) + .ords(ords) + .buildModChain(false) + .build()), secretKey(prepareContext(context)) { prepareSecKey(secretKey, bootstrap); @@ -261,7 +268,7 @@ class GTestTableLookup : public ::testing::TestWithParam void SetUp() override { helib::activeContext = &context; // make things a little easier sometimes - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); }; virtual void TearDown() override @@ -295,7 +302,7 @@ TEST_P(GTestTableLookup, lookupFunctionsCorrectly) outSize, /*scale_out=*/1 - outSize, /*sign_out=*/0, - *(secretKey.getContext().ea)); + secretKey.getContext().getEA()); ASSERT_EQ(helib::lsize(T), 1L << bitSize); for (long i = 0; i < helib::lsize(T); i++) { diff --git a/tests/GTestThinBootstrapping.cpp b/tests/GTestThinBootstrapping.cpp index d513fc973..34000ffc7 100644 --- a/tests/GTestThinBootstrapping.cpp +++ b/tests/GTestThinBootstrapping.cpp @@ -230,31 +230,29 @@ class GTestThinBootstrapping : public ::testing::TestWithParam void postContextSetup() { - if (scale) { - context.scale = scale; - } - context.zMStar.set_cM(mValues[idx][13] / 100.0); - helib::buildModChain(context, - L, - c, - /*willBeBootstrappable=*/true, - /*t=*/skHwt); + context.buildModChain(L, + c, + /*willBeBootstrappable=*/true, + /*t=*/skHwt); if (!helib_test::noPrint) { std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << "\n"; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << "\n"; + std::cout << "# small primes = " << context.getSmallPrimes().card() + << "\n"; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n"; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + + << long(context.logOfProduct(context.getCtxtPrimes()) / + log(2.0) + 0.5) << "\n"; - std::cout << "# special primes = " << context.specialPrimes.card() + std::cout << "# special primes = " << context.getSpecialPrimes().card() << "\n"; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << "\n"; - std::cout << "scale=" << context.scale << std::endl; + std::cout << "scale=" << context.getScale() << std::endl; } context.enableBootStrapping(mvec, @@ -270,10 +268,10 @@ class GTestThinBootstrapping : public ::testing::TestWithParam t += NTL::GetTime(); if (!helib_test::noPrint) { std::cout << " done in " << t << " seconds\n"; - std::cout << " e=" << context.rcData.e - << ", e'=" << context.rcData.ePrime - << ", t=" << context.rcData.skHwt << "\n "; - context.zMStar.printout(); + std::cout << " e=" << context.getRcData().e + << ", e'=" << context.getRcData().ePrime + << ", t=" << context.getRcData().skHwt << "\n "; + context.printout(); } } @@ -344,18 +342,27 @@ class GTestThinBootstrapping : public ::testing::TestWithParam gens(calculateGens(idx)), ords(calculateOrds(idx)), t(0), - context((preContextSetup(), m), p, r, gens, ords), + context((preContextSetup(), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .scale(scale ? scale : 10 /*10 is default*/) + .buildModChain(false) + .build())), nPrimes((postContextSetup(), context.numPrimes())), allPrimes(0, nPrimes - 1), bitSize(context.logOfProduct(allPrimes) / log(2.0)), p2r((helib::setDryRun( helib_test::dry), // Now we can set the dry-run flag if desired postContextPrintout(), - context.alMod.getPPowR())), + context.getAlMod().getPPowR())), secretKey(context), publicKey(setUpSecretKey(secretKey)), - d(context.zMStar.getOrdP()), - nslots(context.zMStar.getPhiM() / d){}; + d(context.getOrdP()), + nslots(context.getPhiM() / d){}; virtual void TearDown() override { @@ -364,7 +371,10 @@ class GTestThinBootstrapping : public ::testing::TestWithParam } public: - void SetUp() override { helib::setupDebugGlobals(&secretKey, context.ea); } + void SetUp() override + { + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } static void TearDownTestCase() { @@ -381,7 +391,7 @@ TEST_P(GTestThinBootstrapping, correctlyPerformsThinBootstrapping) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; - GG = context.alMod.getFactorsOverZZ()[0]; + GG = context.getAlMod().getFactorsOverZZ()[0]; std::shared_ptr ea( std::make_shared(context, GG)); diff --git a/tests/GTestThinEvalMap.cpp b/tests/GTestThinEvalMap.cpp index 3aa4b25a3..190fef84f 100644 --- a/tests/GTestThinEvalMap.cpp +++ b/tests/GTestThinEvalMap.cpp @@ -24,7 +24,6 @@ namespace { struct Parameters { - const long p; const long r; const long c; @@ -105,17 +104,14 @@ class GTestThinEvalMap : public ::testing::TestWithParam helib::SecKey secretKey; const helib::PubKey& publicKey; - static std::vector getDefaultGens() + static std::vector getGens() { return std::vector{3979, 3095, 3760}; }; - static std::vector getDefaultOrds() - { - return std::vector{6, 2, -8}; - }; + static std::vector getOrds() { return std::vector{6, 2, -8}; }; - static NTL::Vec getDefaultMvec() + static NTL::Vec getMvec() { NTL::Vec defaultMvec; defaultMvec.SetLength(3); @@ -141,18 +137,15 @@ class GTestThinEvalMap : public ::testing::TestWithParam if (helib::lsize(userMvec) >= 1) mvec = userMvec; else - mvec = getDefaultMvec(); + mvec = getMvec(); validateMvec(mvec); return mvec; }; - static helib::Context& prepareContext(helib::Context& context, - const long L, - const long c) + static helib::Context& printContext(helib::Context& context) { - helib::buildModChain(context, L, c); if (!helib_test::noPrint) { - context.zMStar.printout(); // print structure of Zm* /(p) to std::cout + context.printout(); // print structure of Zm* /(p) to std::cout std::cout << std::endl; } return context; @@ -181,29 +174,31 @@ class GTestThinEvalMap : public ::testing::TestWithParam seed( (NTL::SetSeed(NTL::conv(GetParam().seed)), GetParam().seed)), mvec(calculateMvec(GetParam().mvec)), - gens(helib::lsize(GetParam().mvec) >= 1 ? GetParam().gens - : getDefaultGens()), - ords(helib::lsize(GetParam().mvec) >= 1 ? GetParam().ords - : getDefaultOrds()), + gens(helib::lsize(GetParam().mvec) >= 1 ? GetParam().gens : getGens()), + ords(helib::lsize(GetParam().mvec) >= 1 ? GetParam().ords : getOrds()), m(helib::computeProd(mvec)), nthreads((NTL::SetNumThreads(GetParam().nthreads), GetParam().nthreads)), useCache(GetParam().useCache), context((helib::setTimersOn(), - helib::setDryRun( - false), // Need to get a "real context" to test ThinEvalMap - m), - p, - r, - gens, - ords), - d(prepareContext(context, L, c).zMStar.getOrdP()), - phim(context.zMStar.getPhiM()), + // Need to get a "real context" to test ThinEvalMap + helib::setDryRun(false), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .bits(L) + .c(c) + .build())), + d(printContext(context).getOrdP()), + phim(context.getPhiM()), nslots(phim / d), secretKey( - (helib::setDryRun( - helib_test::dry), // Now we can set the dry-run flag if desired - context)), - publicKey(prepareSecretKey(secretKey, w)){}; + // Now we can set the dry-run flag if desired + (helib::setDryRun(helib_test::dry), context)), + publicKey(prepareSecretKey(secretKey, w)) + {} virtual void TearDown() override { @@ -220,10 +215,10 @@ TEST_P(GTestThinEvalMap, thinEvalMapIsCorrect) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; - GG = context.alMod.getFactorsOverZZ()[0]; + GG = context.getAlMod().getFactorsOverZZ()[0]; helib::EncryptedArray ea(context, GG); - NTL::zz_p::init(context.alMod.getPPowR()); + NTL::zz_p::init(context.getAlMod().getPPowR()); NTL::Vec val0(NTL::INIT_SIZE, nslots); for (auto& x : val0) diff --git a/tests/GTestThinboot.cpp b/tests/GTestThinboot.cpp index b4896e5c1..d8f3554f6 100644 --- a/tests/GTestThinboot.cpp +++ b/tests/GTestThinboot.cpp @@ -159,15 +159,6 @@ class GTestThinboot : public ::testing::TestWithParam time = -NTL::GetTime(); } - void postContextSetup() - { - if (scale) { - context.scale = scale; - } - - context.zMStar.set_cM(c_m / 100.0); - } - static void setGlobals(int force_bsgs, int force_hoist, int chen_han) { helib::fhe_test_force_bsgs = force_bsgs; @@ -250,12 +241,19 @@ class GTestThinboot : public ::testing::TestWithParam m(helib::computeProd(mvec)), phim((checkPM(p, m), helib::phi_N(m))), time(0), - context((preContextSetup(), m), p, r, gens, ords), + context((preContextSetup(), + helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .gens(gens) + .ords(ords) + .scale(scale ? scale : 10 /*10 is default.*/) + .buildModChain(false) + .build())), v_values_name(GetParam().v_values_name) - { - postContextSetup(); - } + {} void TearDown() override { @@ -360,28 +358,31 @@ class GTestThinboot : public ::testing::TestWithParam TEST_P(GTestThinboot, correctlyPerformsThinboot) { - helib::buildModChain(context, - bits, - c, - /*willBeBootstrappable=*/true, - /*skHwt=*/skHwt, - /*resolution=*/3, - /*bitsInSpecialPrimes=*/helib_test::special_bits); + context.buildModChain(bits, + c, + /*willBeBootstrappable=*/true, + /*skHwt=*/skHwt, + /*resolution=*/3, + /*bitsInSpecialPrimes=*/helib_test::special_bits); if (!helib_test::noPrint) { std::cout << "security=" << context.securityLevel() << std::endl; - std::cout << "# small primes = " << context.smallPrimes.card() << std::endl; - std::cout << "# ctxt primes = " << context.ctxtPrimes.card() << std::endl; + std::cout << "# small primes = " << context.getSmallPrimes().card() + << std::endl; + std::cout << "# ctxt primes = " << context.getCtxtPrimes().card() + << std::endl; std::cout << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + 0.5) + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) << std::endl; - std::cout << "# special primes = " << context.specialPrimes.card() + std::cout << "# special primes = " << context.getSpecialPrimes().card() << std::endl; std::cout << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + + << long(context.logOfProduct(context.getSpecialPrimes()) / + log(2.0) + 0.5) << std::endl; - std::cout << "scale=" << context.scale << std::endl; + std::cout << "scale=" << context.getScale() << std::endl; } context.enableBootStrapping(mvec, useCache, /*alsoThick=*/false); @@ -392,15 +393,16 @@ TEST_P(GTestThinboot, correctlyPerformsThinboot) // if (skHwt>0) context.rcData.skHwt = skHwt; if (!helib_test::noPrint) { std::cout << " done in " << time << " seconds" << std::endl; - std::cout << " e=" << context.rcData.e << ", e'=" << context.rcData.ePrime - << ", t=" << context.rcData.skHwt << std::endl + std::cout << " e=" << context.getRcData().e + << ", e'=" << context.getRcData().ePrime + << ", t=" << context.getRcData().skHwt << "\n" << " "; - context.zMStar.printout(); + context.printout(); } helib::setDryRun( helib_test::dry); // Now we can set the dry-run flag if desired - long p2r = context.alMod.getPPowR(); + long p2r = context.getAlMod().getPPowR(); for (long numkey = 0; numkey < iter; numkey++) { // test with 3 keys if (helib::fhe_stats && numkey > 0 && numkey % 100 == 0) { @@ -431,13 +433,13 @@ TEST_P(GTestThinboot, correctlyPerformsThinboot) const helib::PubKey publicKey = secretKey; - long d = context.zMStar.getOrdP(); - long phim = context.zMStar.getPhiM(); + long d = context.getOrdP(); + long phim = context.getPhiM(); long nslots = phim / d; // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; - GG = context.alMod.getFactorsOverZZ()[0]; + GG = context.getAlMod().getFactorsOverZZ()[0]; std::shared_ptr ea( std::make_shared(context, GG)); @@ -478,10 +480,10 @@ TEST_P(GTestThinboot, correctlyPerformsThinboot) if (!helib_test::noPrint) { // compute minimal capacity before bootstrapping (rawModSwitch) - long e = context.rcData.e; + long e = context.getRcData().e; long q = NTL::power_long(p, e) + 1; double Bnd = context.boundForRecryption(); - double mfac = context.zMStar.getNormBnd(); + double mfac = context.getZMStar().getNormBnd(); double min_bit_cap = log(mfac * q / (p2r * Bnd * HELIB_MIN_CAP_FRAC)) / log(2.0); diff --git a/tests/TestBGV.cpp b/tests/TestBGV.cpp index 107ec3a2b..313447536 100644 --- a/tests/TestBGV.cpp +++ b/tests/TestBGV.cpp @@ -66,25 +66,30 @@ class TestBGV : public ::testing::TestWithParam p(GetParam().p), r(GetParam().r), bits(GetParam().bits), - context(m, p, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), helib::addSome1DMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} virtual void SetUp() override { if (helib_test::verbose) { ea.getPAlgebra().printout(); - std::cout << "r = " << context.alMod.getR() << std::endl; - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "r = " << context.getAlMod().getR() << std::endl; + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << "\n" << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } diff --git a/tests/TestBinIO.cpp b/tests/TestBinIO.cpp new file mode 100644 index 000000000..00845fdc3 --- /dev/null +++ b/tests/TestBinIO.cpp @@ -0,0 +1,1054 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ +#include // isinf +#include +#include +#include +#include +#include + +#include "test_common.h" +#include "gtest/gtest.h" + +namespace { + +struct BGVParameters +{ + const long m; + const long p; + const long r; + const long bits; + const std::vector gens; + const std::vector ords; + const std::vector mvec; + + BGVParameters(long m, + long p, + long r, + long bits, + std::vector gens, + std::vector ords, + std::vector mvec) : + m(m), p(p), r(r), bits(bits), gens(gens), ords(ords), mvec(mvec){}; + + friend std::ostream& operator<<(std::ostream& os, const BGVParameters& params) + { + return os << "{" + << "m = " << params.m << ", " + << "p = " << params.p << ", " + << "r = " << params.r << ", " + << "bits = " << params.bits << ", " + << "gens = " << helib::vecToStr(params.gens) << ", " + << "ords = " << helib::vecToStr(params.ords) << ", " + << "mvec = " << helib::vecToStr(params.mvec) << "}"; + } +}; + +struct CKKSParameters +{ + const long m; + const long precision; + const long bits; + + CKKSParameters(long m, long precision, long bits) : + m(m), precision(precision), bits(bits){}; + + friend std::ostream& operator<<(std::ostream& os, + const CKKSParameters& params) + { + return os << "{" + << "m = " << params.m << ", " + << "precision = " << params.precision << ", " + << "bits = " << params.bits << "}"; + } +}; + +class TestBinIO_BGV : public ::testing::TestWithParam +{ +protected: + const long m; + const long p; + const long r; + const long bits; + const std::vector gens; + const std::vector ords; + const std::vector mvec; + + helib::Context context; + helib::SecKey secretKey; + helib::PubKey publicKey; + const helib::EncryptedArray& ea; + + TestBinIO_BGV() : + m(GetParam().m), + p(GetParam().p), + r(GetParam().r), + bits(GetParam().bits), + gens(GetParam().gens), + ords(GetParam().ords), + mvec(GetParam().mvec), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .gens(gens) + .ords(ords) + .mvec(mvec) + .build()), + secretKey(context), + publicKey( + (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), + ea(context.getEA()) + {} + + virtual void SetUp() override + { + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } + + virtual void TearDown() override { helib::cleanupDebugGlobals(); } +}; + +class TestBinIO_CKKS : public ::testing::TestWithParam +{ +protected: + const long m; + const long precision; + const long bits; + + helib::Context context; + helib::SecKey secretKey; + helib::PubKey publicKey; + const helib::EncryptedArray& ea; + + TestBinIO_CKKS() : + m(GetParam().m), + precision(GetParam().precision), + bits(GetParam().bits), + context(helib::ContextBuilder() + .m(m) + .precision(precision) + .bits(bits) + .build()), + secretKey(context), + publicKey( + (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), + ea(context.getEA()) + {} + + virtual void SetUp() override + { + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } + + virtual void TearDown() override { helib::cleanupDebugGlobals(); } +}; + +// Helper function for converting std::array to string +std::string eyeCatcherToStr( + const std::array& eyeCatcher) +{ + return std::string(eyeCatcher.begin(), eyeCatcher.end()); +} + +TEST(TestBinIO, headerSizeIs24bytes) +{ + EXPECT_EQ(sizeof(helib::SerializeHeader), 24); +} + +TEST(TestBinIO, headerForContext) +{ + helib::SerializeHeader header; + + EXPECT_TRUE(header.beginCatcher == helib::EyeCatcher::HEADER_BEGIN); + EXPECT_TRUE(header.endCatcher == helib::EyeCatcher::HEADER_END); + EXPECT_TRUE(header.version == helib::Binio::VERSION_0_0_1_0); + EXPECT_EQ(header.structId, 5); +} + +TEST(TestBinIO, headerEquals) +{ + helib::SerializeHeader header1; + helib::SerializeHeader header2; + + EXPECT_TRUE(!memcmp(&header1, &header2, sizeof(header1))); +} + +TEST(TestBinIO, headerSerializationDeserialization) +{ + helib::SerializeHeader header; + + std::stringstream ss; + + header.writeTo(ss); + + auto DeserialisedHeader = + helib::SerializeHeader::readFrom(ss); + + EXPECT_TRUE(!memcmp(&header, &DeserialisedHeader, sizeof(header))); +} + +TEST_P(TestBinIO_BGV, singleFunctionSerialization) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); +} + +TEST_P(TestBinIO_BGV, singleFunctionDeserialization) +{ + std::stringstream str; + + context.writeTo(str); + + EXPECT_NO_THROW(context.readFrom(str)); +} + +TEST_P(TestBinIO_BGV, throwsWhenPreContextEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(context.writeTo(ss)); + + // Delete pre-context eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CONTEXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(context.readFrom(ss), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPostContextEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(context.writeTo(ss)); + + // Delete post-context eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CONTEXT_END)), + s.size() - 1); + ss.str(s); + + EXPECT_THROW(context.readFrom(ss), helib::IOError); +} + +TEST_P(TestBinIO_BGV, readContextFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); + + helib::Context deserialized_context = helib::Context::readFrom(str); + + EXPECT_EQ(context, deserialized_context); +} + +TEST_P(TestBinIO_BGV, readContextPtrFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); + + helib::Context* deserialized_contextp = helib::Context::readPtrFrom(str); + + EXPECT_EQ(context, *deserialized_contextp); +} + +TEST(TestBinIO_BGV, readContextFromDeserializeCorrectlyBootstrappable) +{ + // clang-format off + helib::Context context = helib::ContextBuilder() + .m(1271) + .p(2) + .r(1) + .gens({1026, 249}) + .ords({30, -2}) + .bits(30) + .bootstrappable(true) + .mvec(helib::convert>(std::vector({31, 41}))) + .build(); + // clang-format on + + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); + + helib::Context deserialized_context = helib::Context::readFrom(str); + + EXPECT_EQ(context, deserialized_context); + EXPECT_TRUE(deserialized_context.isBootstrappable()); +} + +TEST_P(TestBinIO_BGV, canPerformOperationWithDeserializedContext) +{ + std::stringstream ss; + + context.writeTo(ss); + + helib::Context deserialized_context = helib::Context::readFrom(ss); + + EXPECT_NO_THROW(helib::PubKey{deserialized_context}); + EXPECT_NO_THROW(helib::SecKey{deserialized_context}); + + helib::Ctxt ctxt{helib::PubKey(deserialized_context)}; + + EXPECT_NO_THROW(ctxt.square()); + EXPECT_NO_THROW(ctxt += ctxt); + EXPECT_NO_THROW(ctxt.reLinearize()); + EXPECT_NO_THROW(deserialized_context.getEA().rotate(ctxt, 1)); +} + +TEST_P(TestBinIO_BGV, singleFunctionSerializationOfKeys) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + EXPECT_NO_THROW(secretKey.writeTo(str)); +} + +TEST_P(TestBinIO_BGV, singleFunctionDeserializationOfKeys) +{ + std::stringstream str; + + publicKey.writeTo(str); + + EXPECT_NO_THROW(publicKey.readFrom(str, context)); + + str.str(""); + str.clear(); + + secretKey.writeTo(str); + + EXPECT_NO_THROW(secretKey.readFrom(str, context)); +} + +TEST_P(TestBinIO_BGV, throwsWhenPrePublicKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(publicKey.writeTo(ss)); + + // Delete pre-publicKey eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::PK_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(publicKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPostPublicKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(publicKey.writeTo(ss)); + + // Delete post-publicKey eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::PK_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(publicKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPreSecretKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(secretKey.writeTo(ss)); + + // Delete pre-secretKey eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::SK_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(secretKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPostSecretKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(secretKey.writeTo(ss)); + + // Delete post-secretKey eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::SK_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(secretKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_BGV, readKeysFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + + helib::PubKey deserialized_pk = helib::PubKey::readFrom(str, context); + + EXPECT_EQ(publicKey, deserialized_pk); + + str.str(""); + str.clear(); + + EXPECT_NO_THROW(secretKey.writeTo(str)); + + helib::SecKey deserialized_sk = helib::SecKey::readFrom(str, context); + + EXPECT_EQ(secretKey, deserialized_sk); +} + +TEST_P(TestBinIO_BGV, readKeyPtrsFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + + std::shared_ptr deserialized_pkp = + std::make_shared(helib::PubKey::readFrom(str, context)); + + EXPECT_EQ(publicKey, *deserialized_pkp); + + str.str(""); + str.clear(); + + EXPECT_NO_THROW(secretKey.writeTo(str)); + + std::shared_ptr deserialized_skp = + std::make_shared(helib::SecKey::readFrom(str, context)); + + EXPECT_EQ(secretKey, *deserialized_skp); +} + +TEST_P(TestBinIO_BGV, canEncryptWithDeserializedPublicKey) +{ + std::stringstream ss; + + publicKey.writeTo(ss); + + helib::PubKey deserialized_pk = helib::PubKey::readFrom(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + helib::Ctxt ctxt(deserialized_pk); + + EXPECT_NO_THROW(ptxt.encrypt(ctxt)); + + decrypted_result.decrypt(ctxt, secretKey); + + EXPECT_EQ(ptxt, decrypted_result); +} + +TEST_P(TestBinIO_BGV, canEncryptWithDeserializedSecretKey) +{ + std::stringstream ss; + + secretKey.writeTo(ss); + + helib::SecKey deserialized_sk = helib::SecKey::readFrom(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + helib::Ctxt ctxt(publicKey); + + ptxt.encrypt(ctxt); + + EXPECT_NO_THROW(decrypted_result.decrypt(ctxt, deserialized_sk)); + EXPECT_EQ(ptxt, decrypted_result); +} + +TEST_P(TestBinIO_BGV, singleFunctionSerializationOfCiphertext) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); +} + +TEST_P(TestBinIO_BGV, singleFunctionDeserializationOfCiphertext) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + ctxt.writeTo(str); + + EXPECT_NO_THROW(helib::Ctxt::readFrom(str, publicKey)); +} + +TEST_P(TestBinIO_BGV, singleFunctionDeserializationOfCiphertextInPlace) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + ctxt.writeTo(str); + + EXPECT_NO_THROW(ctxt.read(str)); +} + +TEST_P(TestBinIO_BGV, throwsWhenPreCiphertextEyeCatcherNotFound) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete pre-ciphertext eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(ctxt.readFrom(ss, publicKey), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPostCiphertextEyeCatcherNotFound) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete post-ciphertext eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(ctxt.readFrom(ss, publicKey), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPreCiphertextEyeCatcherNotFoundInPlace) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete pre-ciphertext eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(ctxt.read(ss), helib::IOError); +} + +TEST_P(TestBinIO_BGV, throwsWhenPostCiphertextEyeCatcherNotFoundInPlace) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete post-ciphertext eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(ctxt.read(ss), helib::IOError); +} + +TEST_P(TestBinIO_BGV, readCiphertextFromDeserializeCorrectly) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(str, publicKey); + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_BGV, readCiphertextInPlaceFromDeserializeCorrectly) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); + + helib::Ctxt deserialized_ctxt(publicKey); + deserialized_ctxt.read(str); + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_BGV, readCiphertextAndReadCiphertextInPlaceAreEquivalent) +{ + std::stringstream str1; + std::stringstream str2; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str1)); + EXPECT_NO_THROW(ctxt.writeTo(str2)); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(str1, publicKey); + helib::Ctxt inplace_ctxt(publicKey); + inplace_ctxt.read(str2); + + EXPECT_EQ(inplace_ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_BGV, canPerformOperationsOnDeserializedCiphertext) +{ + std::stringstream ss1, ss2; + helib::Ctxt ctxt(publicKey); + + ctxt.writeTo(ss1); + ctxt.writeTo(ss2); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(ss1, publicKey); + helib::PtxtArray ptxt1(ea), ptxt2(ea); + + EXPECT_NO_THROW(deserialized_ctxt *= ctxt); + EXPECT_NO_THROW(deserialized_ctxt += ctxt); + EXPECT_NO_THROW(deserialized_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(deserialized_ctxt, 1)); + EXPECT_NO_THROW(ptxt1.decrypt(deserialized_ctxt, secretKey)); + + helib::Ctxt inplace_ctxt(publicKey); + inplace_ctxt.read(ss2); + + EXPECT_NO_THROW(inplace_ctxt *= ctxt); + EXPECT_NO_THROW(inplace_ctxt += ctxt); + EXPECT_NO_THROW(inplace_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(inplace_ctxt, 1)); + EXPECT_NO_THROW(ptxt2.decrypt(inplace_ctxt, secretKey)); + + EXPECT_EQ(ptxt1, ptxt2); +} + +TEST_P(TestBinIO_CKKS, singleFunctionSerialization) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionDeserialization) +{ + std::stringstream str; + + context.writeTo(str); + + EXPECT_NO_THROW(context.readFrom(str)); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPreContextEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(context.writeTo(ss)); + + // Delete pre-context eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CONTEXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(context.readFrom(ss), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPostContextEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(context.writeTo(ss)); + + // Delete post-context eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CONTEXT_END)), + s.size() - 1); + ss.str(s); + + EXPECT_THROW(context.readFrom(ss), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, readContextFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); + + helib::Context deserialized_context = helib::Context::readFrom(str); + + EXPECT_EQ(context, deserialized_context); +} + +TEST_P(TestBinIO_CKKS, readContextPtrFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(context.writeTo(str)); + + helib::Context* deserialized_contextp = helib::Context::readPtrFrom(str); + + EXPECT_EQ(context, *deserialized_contextp); +} + +TEST_P(TestBinIO_CKKS, canPerformOperationWithDeserializedContext) +{ + std::stringstream ss; + + context.writeTo(ss); + + helib::Context deserialized_context = helib::Context::readFrom(ss); + + EXPECT_NO_THROW(helib::PubKey{deserialized_context}); + EXPECT_NO_THROW(helib::SecKey{deserialized_context}); + + helib::Ctxt ctxt{helib::PubKey(deserialized_context)}; + + EXPECT_NO_THROW(ctxt.square()); + EXPECT_NO_THROW(ctxt += ctxt); + EXPECT_NO_THROW(ctxt.reLinearize()); + EXPECT_NO_THROW(deserialized_context.getEA().rotate(ctxt, 1)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionSerializationOfKeys) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + EXPECT_NO_THROW(secretKey.writeTo(str)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionDeserializationOfKeys) +{ + std::stringstream str; + + publicKey.writeTo(str); + + EXPECT_NO_THROW(publicKey.readFrom(str, context)); + + str.str(""); + str.clear(); + + secretKey.writeTo(str); + + EXPECT_NO_THROW(secretKey.readFrom(str, context)); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPrePublicKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(publicKey.writeTo(ss)); + + // Delete pre-publicKey eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::PK_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(publicKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPostPublicKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(publicKey.writeTo(ss)); + + // Delete post-publicKey eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::PK_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(publicKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPreSecretKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(secretKey.writeTo(ss)); + + // Delete pre-secretKey eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::SK_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(secretKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPostSecretKeyEyeCatcherNotFound) +{ + std::stringstream ss; + + EXPECT_NO_THROW(secretKey.writeTo(ss)); + + // Delete post-secretKey eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::SK_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(secretKey.readFrom(ss, context), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, readKeysFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + + helib::PubKey deserialized_pk = helib::PubKey::readFrom(str, context); + + EXPECT_EQ(publicKey, deserialized_pk); + + str.str(""); + str.clear(); + + EXPECT_NO_THROW(secretKey.writeTo(str)); + + helib::SecKey deserialized_sk = helib::SecKey::readFrom(str, context); + + EXPECT_EQ(secretKey, deserialized_sk); +} + +TEST_P(TestBinIO_CKKS, readKeyPtrsFromDeserializeCorrectly) +{ + std::stringstream str; + + EXPECT_NO_THROW(publicKey.writeTo(str)); + + std::shared_ptr deserialized_pkp = + std::make_shared(helib::PubKey::readFrom(str, context)); + + EXPECT_EQ(publicKey, *deserialized_pkp); + + str.str(""); + str.clear(); + + EXPECT_NO_THROW(secretKey.writeTo(str)); + + std::shared_ptr deserialized_skp = + std::make_shared(helib::SecKey::readFrom(str, context)); + + EXPECT_EQ(secretKey, *deserialized_skp); +} + +TEST_P(TestBinIO_CKKS, canEncryptWithDeserializedPublicKey) +{ + std::stringstream ss; + + publicKey.writeTo(ss); + + helib::PubKey deserialized_pk = helib::PubKey::readFrom(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + helib::Ctxt ctxt(deserialized_pk); + + EXPECT_NO_THROW(ptxt.encrypt(ctxt)); + + decrypted_result.decrypt(ctxt, secretKey); + + EXPECT_EQ(ptxt, helib::Approx(decrypted_result)); +} + +TEST_P(TestBinIO_CKKS, canEncryptWithDeserializedSecretKey) +{ + std::stringstream ss; + + secretKey.writeTo(ss); + + helib::SecKey deserialized_sk = helib::SecKey::readFrom(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + helib::Ctxt ctxt(publicKey); + + ptxt.encrypt(ctxt); + + EXPECT_NO_THROW(decrypted_result.decrypt(ctxt, deserialized_sk)); + EXPECT_EQ(ptxt, helib::Approx(decrypted_result)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionSerializationOfCiphertext) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionDeserializationOfCiphertext) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + ctxt.writeTo(str); + + EXPECT_NO_THROW(helib::Ctxt::readFrom(str, publicKey)); +} + +TEST_P(TestBinIO_CKKS, singleFunctionDeserializationOfCiphertextInPlace) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + ctxt.writeTo(str); + + EXPECT_NO_THROW(ctxt.read(str)); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPreCiphertextEyeCatcherNotFound) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete pre-ciphertext eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(ctxt.readFrom(ss, publicKey), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPostCiphertextEyeCatcherNotFound) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete post-ciphertext eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(ctxt.readFrom(ss, publicKey), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPreCiphertextEyeCatcherNotFoundInPlace) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete pre-ciphertext eye catcher + std::string s = ss.str(); + std::size_t pos = s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_BEGIN)); + s.erase(pos, pos + helib::EyeCatcher::SIZE); + ss.str(s); + + EXPECT_THROW(ctxt.read(ss), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, throwsWhenPostCiphertextEyeCatcherNotFoundInPlace) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(ss)); + + // Delete post-ciphertext eye catcher + std::string s = ss.str(); + s.erase(s.find(eyeCatcherToStr(helib::EyeCatcher::CTXT_END)), s.size() - 1); + ss.str(s); + + EXPECT_THROW(ctxt.read(ss), helib::IOError); +} + +TEST_P(TestBinIO_CKKS, readCiphertextFromDeserializeCorrectly) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(str, publicKey); + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_CKKS, readCiphertextInPlaceFromDeserializeCorrectly) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str)); + + helib::Ctxt deserialized_ctxt(publicKey); + deserialized_ctxt.read(str); + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_CKKS, readCiphertextAndReadCiphertextInPlaceAreEquivalent) +{ + std::stringstream str1; + std::stringstream str2; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(ctxt.writeTo(str1)); + EXPECT_NO_THROW(ctxt.writeTo(str2)); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(str1, publicKey); + helib::Ctxt inplace_ctxt(publicKey); + inplace_ctxt.read(str2); + + EXPECT_EQ(inplace_ctxt, deserialized_ctxt); +} + +TEST_P(TestBinIO_CKKS, canPerformOperationsOnDeserializedCiphertext) +{ + std::stringstream ss1, ss2; + helib::Ctxt ctxt(publicKey); + + ctxt.writeTo(ss1); + ctxt.writeTo(ss2); + + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFrom(ss1, publicKey); + helib::PtxtArray ptxt1(ea), ptxt2(ea); + + EXPECT_NO_THROW(deserialized_ctxt *= ctxt); + EXPECT_NO_THROW(deserialized_ctxt += ctxt); + EXPECT_NO_THROW(deserialized_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(deserialized_ctxt, 1)); + EXPECT_NO_THROW(ptxt1.decrypt(deserialized_ctxt, secretKey)); + + helib::Ctxt inplace_ctxt(publicKey); + inplace_ctxt.read(ss2); + + EXPECT_NO_THROW(inplace_ctxt *= ctxt); + EXPECT_NO_THROW(inplace_ctxt += ctxt); + EXPECT_NO_THROW(inplace_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(inplace_ctxt, 1)); + EXPECT_NO_THROW(ptxt2.decrypt(inplace_ctxt, secretKey)); + + EXPECT_EQ(ptxt1, ptxt2); +} + +INSTANTIATE_TEST_SUITE_P(Parameters, + TestBinIO_BGV, + ::testing::Values(BGVParameters(/*m=*/45, + /*p=*/2, + /*r=*/1, + /*bits=*/30, + /*gens=*/{}, + /*ords=*/{}, + /*mvec=*/{}))); + +INSTANTIATE_TEST_SUITE_P(Parameters, + TestBinIO_CKKS, + ::testing::Values(CKKSParameters(/*m=*/64, + /*precision=*/30, + /*bits=*/30))); + +} // namespace diff --git a/tests/TestBootstrappingWithMultiplications.cpp b/tests/TestBootstrappingWithMultiplications.cpp index 5143fb860..b7185a792 100644 --- a/tests/TestBootstrappingWithMultiplications.cpp +++ b/tests/TestBootstrappingWithMultiplications.cpp @@ -11,6 +11,7 @@ */ #include #include +#include #include "gtest/gtest.h" #include "test_common.h" @@ -88,11 +89,14 @@ class TestFatBootstrappingWithMultiplications : TestFatBootstrappingWithMultiplications() : n(GetParam().n), - context(GetParam().m, - GetParam().p, - GetParam().r, - GetParam().gens, - GetParam().ords), + context(helib::ContextBuilder() + .m(GetParam().m) + .p(GetParam().p) + .r(GetParam().r) + .gens(GetParam().gens) + .ords(GetParam().ords) + .buildModChain(false) + .build()), secretKey(postContextSetup(context, GetParam().c_m, GetParam().bits, @@ -100,18 +104,17 @@ class TestFatBootstrappingWithMultiplications : GetParam().t, GetParam().mvec)), publicKey(keySetup(secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} static helib::Context& postContextSetup(helib::Context& context, - int c_m, + UNUSED int c_m, long bits, long c, long t, NTL::Vec mvec) { - context.zMStar.set_cM(c_m / 100); - helib::buildModChain(context, bits, c, true, t); + context.buildModChain(bits, c, true, t); context.enableBootStrapping(mvec); return context; } @@ -137,11 +140,11 @@ class TestFatBootstrappingWithMultiplications : << ", gens=" << helib::vecToStr(GetParam().gens) << ", ords=" << helib::vecToStr(GetParam().ords) << std::endl; ea.getPAlgebra().printout(); - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << std::endl << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override @@ -240,7 +243,7 @@ TEST_P(TestFatBootstrappingWithMultiplications, correctlyPerformsFatBootstrappingWithMultiplications) { const long nslots = ea.size(); - const long p2r = context.alMod.getPPowR(); + const long p2r = context.getAlMod().getPPowR(); std::vector ptxt( generateRandomBinaryVector(nslots)); // Random 0s and 1s helib::Ctxt ctxt(publicKey); @@ -306,11 +309,14 @@ class TestThinBootstrappingWithMultiplications : TestThinBootstrappingWithMultiplications() : n(GetParam().n), - context(GetParam().m, - GetParam().p, - GetParam().r, - GetParam().gens, - GetParam().ords), + context(helib::ContextBuilder() + .m(GetParam().m) + .p(GetParam().p) + .r(GetParam().r) + .gens(GetParam().gens) + .ords(GetParam().ords) + .buildModChain(false) + .build()), secretKey(postContextSetup(context, GetParam().c_m, GetParam().bits, @@ -318,18 +324,17 @@ class TestThinBootstrappingWithMultiplications : GetParam().t, GetParam().mvec)), publicKey(keySetup(secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} static helib::Context& postContextSetup(helib::Context& context, - int c_m, + UNUSED int c_m, long bits, long c, long t, NTL::Vec mvec) { - context.zMStar.set_cM(c_m / 100); - helib::buildModChain(context, bits, c, true, t); + context.buildModChain(bits, c, true, t); context.enableBootStrapping(mvec); return context; } @@ -355,12 +360,12 @@ class TestThinBootstrappingWithMultiplications : << ", gens=" << helib::vecToStr(GetParam().gens) << ", ords=" << helib::vecToStr(GetParam().ords) << std::endl; ea.getPAlgebra().printout(); - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << std::endl << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override @@ -401,7 +406,7 @@ TEST_P(TestThinBootstrappingWithMultiplications, correctlyPerformsThinBootstrappingWithMultiplications) { const long nslots = ea.size(); - const long p2r = context.alMod.getPPowR(); + const long p2r = context.getAlMod().getPPowR(); std::vector ptxt( generateRandomBinaryVector(nslots)); // Random 0s and 1s helib::Ctxt ctxt(publicKey); diff --git a/tests/TestCKKS.cpp b/tests/TestCKKS.cpp index ae9197c88..c2974c937 100644 --- a/tests/TestCKKS.cpp +++ b/tests/TestCKKS.cpp @@ -164,28 +164,32 @@ class TestCKKS : public ::testing::TestWithParam r(GetParam().r), L(GetParam().L), epsilon(GetParam().epsilon), - context(m, /*p=*/-1, r), - secretKey((context.scale = 4, - helib::buildModChain(context, L, /*c=*/2), - context)), + context(helib::ContextBuilder() + .m(m) + .precision(r) + .scale(4) + .bits(L) + .c(2) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), helib::addSome1DMatrices(secretKey), helib::addSomeFrbMatrices(secretKey), secretKey)), - ea(context.ea->getCx()) + ea(context.getEA().getCx()) {} virtual void SetUp() override { if (helib_test::verbose) { ea.getPAlgebra().printout(); - std::cout << "r = " << context.alMod.getR() << std::endl; - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "r = " << context.getAlMod().getR() << std::endl; + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << "\n" << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -611,7 +615,10 @@ TEST_P(TestCKKS, multiplyBySmallNegativeConstantFollowedByOperationWorks) TEST(TestCKKS, buildingCKKSContextWithMAsNotAPowerOfTwoThrows) { - EXPECT_THROW(helib::Context context(99, -1, 20), helib::InvalidArgument); + EXPECT_THROW( + helib::Context context( + helib::ContextBuilder().m(99).precision(20).build()), + helib::InvalidArgument); } INSTANTIATE_TEST_SUITE_P(typicalParameters, diff --git a/tests/TestContext.cpp b/tests/TestContext.cpp index ce1c3d607..dd90402ce 100644 --- a/tests/TestContext.cpp +++ b/tests/TestContext.cpp @@ -64,7 +64,12 @@ class TestContextBGV : public ::testing::TestWithParam m(GetParam().m), p(GetParam().p), r(GetParam().r), - context(std::make_shared(m, p, r)) + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .buildModChain(false) + .buildPtr()) {} const unsigned long m; @@ -80,12 +85,15 @@ class TestContextCKKS : public ::testing::TestWithParam TestContextCKKS() : m(GetParam().m), r(GetParam().r), - context(std::make_shared(m, /*p=*/-1, r)) + context(helib::ContextBuilder() + .m(m) + .precision(r) + .buildModChain(false) + .buildPtr()) {} const unsigned long m; const unsigned long r; - const std::shared_ptr context; }; @@ -97,17 +105,23 @@ TEST_P(TestContextBGV, TEST_P(TestContextBGV, contextEquals) { - helib::Context someOtherContext(/*m=*/17, /*p=*/2, /*r=*/1); - buildModChain(*context, /*bits=*/100, /*c=*/2); - buildModChain(someOtherContext, /*bits=*/100, /*c=*/2); + helib::Context someOtherContext = helib::ContextBuilder() + .m(17) + .p(2) + .r(1) + .bits(100) + .c(2) + .build(); + + context->buildModChain(/*bits=*/100, /*c=*/2); EXPECT_EQ(*context, *context); EXPECT_EQ(*context, someOtherContext); - EXPECT_EQ(context->zMStar.getM(), 17); // m - EXPECT_EQ(context->zMStar.getP(), 2); // p - EXPECT_EQ(context->alMod.getR(), 1); // r - EXPECT_EQ(context->digits.size(), 2); // c + EXPECT_EQ(context->getM(), 17); // m + EXPECT_EQ(context->getP(), 2); // p + EXPECT_EQ(context->getAlMod().getR(), 1); // r + EXPECT_EQ(context->getDigits().size(), 2); // c EXPECT_GT(context->numPrimes(), 0); EXPECT_EQ(context->numPrimes(), someOtherContext.numPrimes()); for (long i = 0; i < context->numPrimes(); i++) { @@ -115,32 +129,32 @@ TEST_P(TestContextBGV, contextEquals) const helib::Cmodulus& m2 = someOtherContext.ithModulus(i); EXPECT_EQ(m1.getQ(), m2.getQ()) << " index: " << i; } - EXPECT_EQ(context->smallPrimes, someOtherContext.smallPrimes); - EXPECT_EQ(context->ctxtPrimes, someOtherContext.ctxtPrimes); - EXPECT_EQ(context->specialPrimes, someOtherContext.specialPrimes); - for (std::size_t i = 0; i < context->digits.size(); ++i) { - EXPECT_EQ(context->digits[i], someOtherContext.digits[i]) + EXPECT_EQ(context->getSmallPrimes(), someOtherContext.getSmallPrimes()); + EXPECT_EQ(context->getCtxtPrimes(), someOtherContext.getCtxtPrimes()); + EXPECT_EQ(context->getSpecialPrimes(), someOtherContext.getSpecialPrimes()); + for (std::size_t i = 0; i < context->getDigits().size(); ++i) { + EXPECT_EQ(context->getDigit(i), someOtherContext.getDigit(i)) << " index: " << i; } - EXPECT_EQ(context->stdev, someOtherContext.stdev); - EXPECT_EQ(context->scale, someOtherContext.scale); - EXPECT_EQ(context->rcData, someOtherContext.rcData); + EXPECT_EQ(context->getStdev(), someOtherContext.getStdev()); + EXPECT_EQ(context->getScale(), someOtherContext.getScale()); + EXPECT_EQ(context->getRcData(), someOtherContext.getRcData()); } TEST_P(TestContextBGV, contextNotEquals) { - helib::Context someOtherContext(/*m=*/13, /*p=*/3, /*r=*/2); - buildModChain(*context, /*bits=*/100, /*c=*/3); - buildModChain(someOtherContext, - /*bits=*/200, - /*c=*/2, - /*willBeBootstrappable =*/true); - someOtherContext.scale = 6; - someOtherContext.stdev = 3.0; - NTL::Vec mvec; - mvec.SetLength(1); - mvec[0] = 13; - someOtherContext.enableBootStrapping(mvec); + helib::Context someOtherContext = helib::ContextBuilder() + .m(13) + .p(3) + .r(2) + .scale(6) + .stdev(3.0) + .bits(200) + .c(2) + .bootstrappable() + .mvec({13}) + .build(); + context->buildModChain(/*bits=*/100, /*c=*/3); EXPECT_NE(*context, someOtherContext); EXPECT_NE(context->numPrimes(), someOtherContext.numPrimes()); @@ -155,43 +169,43 @@ TEST_P(TestContextBGV, contextNotEquals) } EXPECT_TRUE(atLeastOneDoesNotEqual); // This only checks the handles, not the primes themselves. - EXPECT_EQ(context->smallPrimes, someOtherContext.smallPrimes); - EXPECT_NE(context->ctxtPrimes, someOtherContext.ctxtPrimes); - EXPECT_NE(context->specialPrimes, someOtherContext.specialPrimes); - for (std::size_t i = 0; i < context->digits.size(); ++i) { - EXPECT_NE(context->digits[i], someOtherContext.digits[i]) + EXPECT_EQ(context->getSmallPrimes(), someOtherContext.getSmallPrimes()); + EXPECT_NE(context->getCtxtPrimes(), someOtherContext.getCtxtPrimes()); + EXPECT_NE(context->getSpecialPrimes(), someOtherContext.getSpecialPrimes()); + for (std::size_t i = 0; i < context->getDigits().size(); ++i) { + EXPECT_NE(context->getDigit(i), someOtherContext.getDigit(i)) << " index: " << i; } - EXPECT_NE(context->stdev, someOtherContext.stdev); - EXPECT_NE(context->scale, someOtherContext.scale); - EXPECT_NE(context->rcData, someOtherContext.rcData); + EXPECT_NE(context->getStdev(), someOtherContext.getStdev()); + EXPECT_NE(context->getScale(), someOtherContext.getScale()); + EXPECT_NE(context->getRcData(), someOtherContext.getRcData()); } TEST_P(TestContextBGV, ContextCalculatingSecurityAfterModchainBuilt) { - buildModChain(*context, /*bits=*/100, /*c=*/2); + context->buildModChain(/*bits=*/100, /*c=*/2); double result = context->securityLevel(); EXPECT_FALSE(std::isinf(result)); } TEST_P(TestContextBGV, hasCorrectSlotRingWhenConstructed) { - EXPECT_EQ(context->slotRing->p, p); - EXPECT_EQ(context->slotRing->r, r); - EXPECT_EQ(context->slotRing->p2r, pow(p, r)); - EXPECT_EQ(context->slotRing->G, helib::getG(*(context->ea))); + EXPECT_EQ(context->getSlotRing()->p, p); + EXPECT_EQ(context->getSlotRing()->r, r); + EXPECT_EQ(context->getSlotRing()->p2r, pow(p, r)); + EXPECT_EQ(context->getSlotRing()->G, helib::getG(context->getEA())); } TEST_P(TestContextBGV, buildModChainThrowsWhenBitsIsZero) { - EXPECT_THROW(helib::buildModChain(*context, /*bits=*/0, /*c=*/2), + EXPECT_THROW(context->buildModChain(/*bits=*/0, /*c=*/2), helib::InvalidArgument); } TEST_P(TestContextBGV, calculateBitSizeOfQ) { long bits = 1016; - buildModChain(*context, bits, /*c=*/2); + context->buildModChain(bits, /*c=*/2); long bitsize = context->bitSizeOfQ(); // Get the primes used by HElib. @@ -200,7 +214,7 @@ TEST_P(TestContextBGV, calculateBitSizeOfQ) ceil(context->logOfProduct(fullPrimes) / log(2.0)); long calcCtxtPrimesBitSize = - ceil(context->logOfProduct(context->ctxtPrimes) / log(2.0)); + ceil(context->logOfProduct(context->getCtxtPrimes()) / log(2.0)); // Check if the ctxtPrimes are the bits we asked for. // Will be close but not exact. @@ -236,14 +250,15 @@ TEST(TestContextBGV, contextBuilderWithDefaultArguments) { helib::Context context_built = helib::ContextBuilder().build(); - helib::Context expected_default_context(/*m=*/3, /*p=*/2, /*r=*/1); - buildModChain(expected_default_context, /*bits=*/300, /*c=*/3); + helib::Context expected_default_context = + helib::ContextBuilder().m(3).p(2).r(1).bits(300).c(3).build(); // Making sure the number of columns is not clipped. - EXPECT_GT(expected_default_context.ctxtPrimes.card(), - expected_default_context.digits.size()); - EXPECT_GT(context_built.ctxtPrimes.card(), context_built.digits.size()); - EXPECT_EQ(context_built.digits.size(), 3); + EXPECT_GT(expected_default_context.getCtxtPrimes().card(), + expected_default_context.getDigits().size()); + EXPECT_GT(context_built.getCtxtPrimes().card(), + context_built.getDigits().size()); + EXPECT_EQ(context_built.getDigits().size(), 3); EXPECT_FALSE(context_built.isBootstrappable()); EXPECT_GT(context_built.numPrimes(), 0); @@ -255,14 +270,15 @@ TEST(TestContextBGV, contextBuilderBuildsPointer) std::unique_ptr context_built{ helib::ContextBuilder().buildPtr()}; - helib::Context expected_default_context(/*m=*/3, /*p=*/2, /*r=*/1); - buildModChain(expected_default_context, /*bits=*/300, /*c=*/3); + helib::Context expected_default_context = + helib::ContextBuilder().m(3).p(2).r(1).bits(300).c(3).build(); // Making sure the number of columns is not clipped. - EXPECT_GT(expected_default_context.ctxtPrimes.card(), - expected_default_context.digits.size()); - EXPECT_GT(context_built->ctxtPrimes.card(), context_built->digits.size()); - EXPECT_EQ(context_built->digits.size(), 3); + EXPECT_GT(expected_default_context.getCtxtPrimes().card(), + expected_default_context.getDigits().size()); + EXPECT_GT(context_built->getCtxtPrimes().card(), + context_built->getDigits().size()); + EXPECT_EQ(context_built->getDigits().size(), 3); EXPECT_FALSE(context_built->isBootstrappable()); EXPECT_GT(context_built->numPrimes(), 0); @@ -276,7 +292,7 @@ TEST(TestContextBGV, contextBuilderClipsDigitsSizeWithSmallBits) helib::ContextBuilder().bits(100).c(c).build(); // Because bits is small, c gets clipped automatically. - EXPECT_LT(context_built.digits.size(), c); + EXPECT_LT(context_built.getDigits().size(), c); } TEST(TestContextBGV, contextBuilderDoesNotClipDigitsSize) @@ -286,7 +302,7 @@ TEST(TestContextBGV, contextBuilderDoesNotClipDigitsSize) helib::ContextBuilder().bits(500).c(c).build(); // Should have sufficient number of bits to have c columns. - EXPECT_EQ(context_built.digits.size(), c); + EXPECT_EQ(context_built.getDigits().size(), c); } TEST_P(TestContextBGV, contextBuilderWithBasicParams) @@ -299,7 +315,7 @@ TEST_P(TestContextBGV, contextBuilderWithBasicParams) .build(); // clang-format off - buildModChain(*context, /*bits*/300, /*c=*/3); + context->buildModChain( /*bits*/300, /*c=*/3); EXPECT_EQ(context_built, *context); EXPECT_GT(context_built.numPrimes(), 0); } @@ -316,7 +332,7 @@ TEST_P(TestContextBGV, contextBuilderWithGensOrdsToo) .build(); // clang-format off - buildModChain(*context, /*bits*/300, /*c=*/3); + context->buildModChain( /*bits*/300, /*c=*/3); EXPECT_EQ(context_built, *context); EXPECT_GT(context_built.numPrimes(), 0); } @@ -349,81 +365,23 @@ TEST_P(TestContextBGV, contextBuilderBootstrappableContext) EXPECT_TRUE(context_built.isBootstrappable()); } -TEST_P(TestContextBGV, contextBuilderLogsCorrectly) -{ - NTL::Vec mvec; - mvec.SetLength(1); - mvec[0] = 3; - - long c = 3; - std::vector gens = {3}; - std::vector ords = {-2}; - bool buildModChainFlag = false; - long bits = 2; - long skHwt = 64; - long resolution = 1; - long bitsInSpecialPrimes = 15; - bool bootstrappableFlag = true; - bool buildCacheFlag = true; - bool thickFlag = true; - - // clang-format off - auto cb = helib::ContextBuilder() - .m(m) - .p(p) - .r(r) - .c(c) - .gens(gens) - .ords(ords) - .buildModChain(buildModChainFlag) - .bits(bits) - .skHwt(skHwt) - .resolution(resolution) - .bitsInSpecialPrimes(bitsInSpecialPrimes) - .bootstrappable(bootstrappableFlag) - .mvec(mvec) - .buildCache(buildCacheFlag) - .thickboot(); - // clang-format off - - std::stringstream expected_ss; - expected_ss << "{\n" - << " scheme: BGV\n" - << " m: " << m << "\n" - << " p: " << p << "\n" - << " r: " << r << "\n" - << " c: " << c << "\n" - << " gens: " << helib::vecToStr(gens) << "\n" - << " ords: " << helib::vecToStr(ords) << "\n" - << " buildModChainFlag: " << buildModChainFlag << "\n" - << " bits: " << bits << "\n" - << " skHwt: " << skHwt << "\n" - << " resolution: " << resolution << "\n" - << " bitsInSpecialPrimes: " << bitsInSpecialPrimes << "\n" - << " bootstrappableFlag: " << bootstrappableFlag << "\n" - << " mvec: " << mvec << "\n" - << " buildCacheFlag: " << buildCacheFlag << "\n" - << " thickFlag: " << thickFlag << "\n" - << "}" << std::endl; - - std::stringstream actual_ss; - actual_ss << cb; - - EXPECT_EQ(expected_ss.str(), actual_ss.str()); -} - TEST(TestContextCKKS, contextBuilderWithDefaultArguments) { - helib::Context context_built { helib::ContextBuilder().build() }; + helib::Context context_built = helib::ContextBuilder().build(); - helib::Context expected_default_context(/*m=*/4, /*p=*/-1, /*r=*/20); - buildModChain(expected_default_context, /*bits=*/300, /*c=*/3); + helib::Context expected_default_context = helib::ContextBuilder() + .m(4) + .bits(300) + .c(3) + .precision(20) + .build(); // Making sure columns is not clipped. - EXPECT_GT(expected_default_context.ctxtPrimes.card(), - expected_default_context.digits.size()); - EXPECT_GT(context_built.ctxtPrimes.card(), context_built.digits.size()); - EXPECT_EQ(context_built.digits.size(), 3); + EXPECT_GT(expected_default_context.getCtxtPrimes().card(), + expected_default_context.getDigits().size()); + EXPECT_GT(context_built.getCtxtPrimes().card(), + context_built.getDigits().size()); + EXPECT_EQ(context_built.getDigits().size(), 3); EXPECT_FALSE(context_built.isBootstrappable()); EXPECT_GT(context_built.numPrimes(), 0); @@ -437,7 +395,7 @@ TEST(TestContextCKKS, contextBuilderClipsDigitsSizeWithSmallBits) helib::ContextBuilder().bits(100).c(c).build(); // Because bits is small, c gets clipped automatically. - EXPECT_LT(context_built.digits.size(), c); + EXPECT_LT(context_built.getDigits().size(), c); } TEST(TestContextCKKS, contextBuilderDoesNotClipDigitsSize) @@ -447,7 +405,7 @@ TEST(TestContextCKKS, contextBuilderDoesNotClipDigitsSize) helib::ContextBuilder().bits(500).c(c).build(); // Should have sufficient number of bits to have c columns. - EXPECT_EQ(context_built.digits.size(), c); + EXPECT_EQ(context_built.getDigits().size(), c); } TEST_P(TestContextCKKS, contextBuilderWithBasicParams) @@ -459,7 +417,7 @@ TEST_P(TestContextCKKS, contextBuilderWithBasicParams) .build(); // clang-format off - buildModChain(*context, /*bits*/300, /*c=*/3); + context->buildModChain( /*bits*/300, /*c=*/3); EXPECT_EQ(context_built, *context); EXPECT_GT(context_built.numPrimes(), 0); } @@ -475,7 +433,7 @@ TEST_P(TestContextCKKS, contextBuilderWithGensOrdsToo) .build(); // clang-format off - buildModChain(*context, /*bits*/300, /*c=*/3); + context->buildModChain( /*bits*/300, /*c=*/3); EXPECT_EQ(context_built, *context); EXPECT_GT(context_built.numPrimes(), 0); } @@ -492,57 +450,6 @@ TEST_P(TestContextCKKS, contextBuilderNoModChain) EXPECT_EQ(context_built.numPrimes(), 0); } -TEST_P(TestContextCKKS, contextBuilderLogsCorrectly) -{ - NTL::Vec mvec; - mvec.SetLength(1); - mvec[0] = 3; - - long precision = r; - long c = 3; - std::vector gens = {3}; - std::vector ords = {-2}; - bool buildModChainFlag = false; - long bits = 2; - long skHwt = 64; - long resolution = 1; - long bitsInSpecialPrimes = 15; - - // clang-format off - auto cb = helib::ContextBuilder() - .m(m) - .precision(precision) - .c(c) - .gens(gens) - .ords(ords) - .buildModChain(buildModChainFlag) - .bits(bits) - .skHwt(skHwt) - .resolution(resolution) - .bitsInSpecialPrimes(bitsInSpecialPrimes); - // clang-format off - - std::stringstream expected_ss; - expected_ss << "{\n" - << " scheme: CKKS\n" - << " m: " << m << ",\n" - << " precision: " << precision << ",\n" - << " c: " << c << ",\n" - << " gens: " << helib::vecToStr(gens) << ",\n" - << " ords: " << helib::vecToStr(ords) << ",\n" - << " buildModChainFlag: " << buildModChainFlag << ",\n" - << " bits: " << bits << ",\n" - << " skHwt: " << skHwt << ",\n" - << " resolution: " << resolution << ",\n" - << " bitsInSpecialPrimes: " << bitsInSpecialPrimes << "\n" - << "}" << std::endl; - - std::stringstream actual_ss; - actual_ss << cb; - - EXPECT_EQ(expected_ss.str(), actual_ss.str()); -} - // Just checking manually if the printout works as expected // TEST_P(TestContextBGV, contextBuilderPrintoutWorksCorrectly) // { diff --git a/tests/TestCtxt.cpp b/tests/TestCtxt.cpp index 996b2c97e..e30384cc0 100644 --- a/tests/TestCtxt.cpp +++ b/tests/TestCtxt.cpp @@ -69,18 +69,23 @@ class TestCtxt : public ::testing::TestWithParam p(GetParam().p), r(GetParam().r), bits(GetParam().bits), - context(m, p, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), addFrbMatrices(secretKey), addSome1DMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} virtual void SetUp() override { - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); }; virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -93,7 +98,7 @@ class TestCtxtWithBadDimensions : public TestCtxt protected: TestCtxtWithBadDimensions() : TestCtxt() { - for (long i = 0; i < context.zMStar.numOfGens(); ++i) { + for (long i = 0; i < context.getZMStar().numOfGens(); ++i) { if (!ea.nativeDimension(i)) { return; } @@ -232,7 +237,7 @@ TEST_P(TestCtxtWithBadDimensions, rotate1DRotatesCorrectlyWithBadDimensions) helib::Ctxt ctxt(publicKey); publicKey.Encrypt(ctxt, ptxt); - for (long i = 0; i < context.zMStar.numOfGens(); ++i) { + for (long i = 0; i < context.getZMStar().numOfGens(); ++i) { helib::Ctxt tmp(ctxt); ea.rotate1D(tmp, i, 3); helib::Ptxt expected_result(ptxt); diff --git a/tests/TestIO.cpp b/tests/TestIO.cpp new file mode 100644 index 000000000..e69617804 --- /dev/null +++ b/tests/TestIO.cpp @@ -0,0 +1,1632 @@ +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +/* Note this file only tests JSON (de)serialization.*/ +/* If you are searching for binary (de)serialization go to TestBinIO.cpp*/ + +#include +#include +#include + +#include "test_common.h" +#include "gtest/gtest.h" + +namespace { + +std::string addHeader(const std::string& data, const std::string& scheme) +{ + return "{\"HElibVersion\":\"" + std::string(helib::version::asString) + + "\",\"content\":{\"scheme\":\"" + scheme + "\",\"slots\":" + data + + "},\"serializationVersion\":\"0.0.1\",\"type\":\"Ptxt\"}"; +} + +struct BGVParameters +{ + const long m; + const long p; + const long r; + const long bits; + const std::vector gens; + const std::vector ords; + const std::vector mvec; + + BGVParameters(long m, + long p, + long r, + long bits, + std::vector gens, + std::vector ords, + std::vector mvec) : + m(m), p(p), r(r), bits(bits), gens(gens), ords(ords), mvec(mvec){}; + + friend std::ostream& operator<<(std::ostream& os, const BGVParameters& params) + { + return os << "{" + << "m = " << params.m << ", " + << "p = " << params.p << ", " + << "r = " << params.r << ", " + << "bits = " << params.bits << ", " + << "gens = " << helib::vecToStr(params.gens) << ", " + << "ords = " << helib::vecToStr(params.ords) << ", " + << "mvec = " << helib::vecToStr(params.mvec) << "}"; + } +}; + +struct CKKSParameters +{ + const long m; + const long precision; + const long bits; + + CKKSParameters(long m, long precision, long bits) : + m(m), precision(precision), bits(bits){}; + + friend std::ostream& operator<<(std::ostream& os, + const CKKSParameters& params) + { + return os << "{" + << "m = " << params.m << ", " + << "precision = " << params.precision << ", " + << "bits = " << params.bits << "}"; + } +}; + +class TestIO_BGV : public ::testing::TestWithParam +{ +protected: + const long m; + const long p; + const long r; + const long bits; + const std::vector gens; + const std::vector ords; + const std::vector mvec; + + helib::Context context; + helib::SecKey secretKey; + helib::PubKey publicKey; + const helib::EncryptedArray& ea; + + TestIO_BGV() : + m(GetParam().m), + p(GetParam().p), + r(GetParam().r), + bits(GetParam().bits), + gens(GetParam().gens), + ords(GetParam().ords), + mvec(GetParam().mvec), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .gens(gens) + .ords(ords) + .mvec(mvec) + .build()), + secretKey(context), + publicKey( + (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), + ea(context.getEA()) + {} + + virtual void SetUp() override + { + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } + + virtual void TearDown() override { helib::cleanupDebugGlobals(); } +}; + +class TestIO_CKKS : public ::testing::TestWithParam +{ +protected: + const long m; + const long precision; + const long bits; + + helib::Context context; + helib::SecKey secretKey; + helib::PubKey publicKey; + const helib::EncryptedArray& ea; + + TestIO_CKKS() : + m(GetParam().m), + precision(GetParam().precision), + bits(GetParam().bits), + context(helib::ContextBuilder() + .m(m) + .precision(precision) + .bits(bits) + .build()), + secretKey(context), + publicKey( + (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), + ea(context.getEA()) + {} + + virtual void SetUp() override + { + helib::setupDebugGlobals(&secretKey, context.shareEA()); + } + + virtual void TearDown() override { helib::cleanupDebugGlobals(); } +}; + +static const json makeExpectedJSON(const helib::Context& context) +{ + // Generators + long numGens = context.getZMStar().numOfGens(); + std::vector gens(numGens); + for (long i = 0; i < numGens; ++i) { + gens[i] = context.getZMStar().ZmStarGen(i); + } + + // Orders of the generators + std::vector ords(numGens); + for (long i = 0; i < numGens; ++i) { + // Check for good/bad dimension + if (context.getZMStar().SameOrd(i)) { + ords[i] = context.getZMStar().OrderOf(i); + } else { // Bad dimensions are negated + ords[i] = -context.getZMStar().OrderOf(i); + } + } + + // Prime chain + std::vector qs(context.numPrimes()); + for (std::size_t i = 0; i < qs.size(); ++i) { + qs[i] = context.ithPrime(i); + } + + json j = {{"m", context.getM()}, + {"p", context.getP()}, + {"r", context.getR()}, + {"gens", gens}, + {"ords", ords}, + {"stdev", context.getStdev()}, + {"scale", context.getScale()}, + {"smallPrimes", unwrap(context.getSmallPrimes().writeToJSON())}, + {"specialPrimes", unwrap(context.getSpecialPrimes().writeToJSON())}, + {"qs", qs}, + {"digits", writeVectorToJSON(context.getDigits())}, + {"hwt_param", context.getHwt()}, + {"e_param", context.getE()}, + {"ePrime_param", context.getEPrime()}, + {"mvec", context.getRcData().mvec}, + {"build_cache", context.getRcData().build_cache}, + {"alsoThick", context.getRcData().alsoThick}}; + return helib::toTypedJson(j); +} + +TEST(TestIO, TypedJSONLabelsAreTypeNames) +{ + EXPECT_EQ(helib::ContextBuilder::typeName, "ContextBuilder"); + EXPECT_EQ(helib::Context::typeName, "Context"); + EXPECT_EQ(helib::Ctxt::typeName, "Ctxt"); + EXPECT_EQ(helib::PubKey::typeName, "PubKey"); + EXPECT_EQ(helib::SecKey::typeName, "SecKey"); + EXPECT_EQ(helib::KeySwitch::typeName, "KeySwitch"); + EXPECT_EQ(helib::Ptxt::typeName, "Ptxt"); +} + +TEST(TestIO, toTypedJSONWorks) +{ + json jcont = 42; + + EXPECT_EQ( + helib::toTypedJson>(jcont).at("type"), + helib::ContextBuilder::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::Context::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::Ctxt::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::PubKey::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::SecKey::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::KeySwitch::typeName); + EXPECT_EQ(helib::toTypedJson>(jcont).at("type"), + helib::Ptxt::typeName); + + EXPECT_EQ( + helib::toTypedJson(jcont).at("serializationVersion"), + helib::jsonSerializationVersion); + + EXPECT_EQ(helib::toTypedJson(jcont).at("HElibVersion"), + helib::version::asString); + + EXPECT_EQ(helib::toTypedJson(jcont).at("content"), jcont); +} + +TEST(TestIO, fromTypedJSONWorks) +{ + json jcont = 42; + + EXPECT_EQ(helib::fromTypedJson>( + helib::toTypedJson>(jcont)), + jcont); + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); + EXPECT_EQ( + helib::fromTypedJson(helib::toTypedJson(jcont)), + jcont); + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); + EXPECT_EQ(helib::fromTypedJson>( + helib::toTypedJson>(jcont)), + jcont); + + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); + + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); +} + +TEST(TestIO, fromTypedJSONThrowsWhenMetadataIsWrong) +{ + json jcont = 42; + json tj_orig = helib::toTypedJson(jcont); + json tj = tj_orig; + tj.at("type") = "wrong"; + + EXPECT_THROW(helib::fromTypedJson>(tj), + helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson>(tj), + helib::IOError); + + tj = tj_orig; + std::stringstream ss; + ss << helib::jsonSerializationVersion << ".wrong"; + tj.at("serializationVersion") = ss.str(); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + + ss.str(""); + ss.clear(); + tj = tj_orig; + ss << helib::version::asString << ".wrong"; + tj.at("HElibVersion") = ss.str(); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); + + tj = tj_orig; + EXPECT_EQ(helib::fromTypedJson(tj), jcont); +} + +TEST(TestIO, serializeComplexNumbers) +{ + std::complex cd1 = 0; + json j1 = cd1; + EXPECT_EQ(j1.dump(), "[0.0,0.0]"); + + std::complex cd2 = 42.5; + json j2 = cd2; + EXPECT_EQ(j2.dump(), "[42.5,0.0]"); + + std::complex cd3 = {0, 12.2}; + json j3 = cd3; + EXPECT_EQ(j3.dump(), "[0.0,12.2]"); + + std::complex cd4 = {10.9, 9.1}; + json j4 = cd4; + EXPECT_EQ(j4.dump(), "[10.9,9.1]"); +} + +TEST(TestIO, deserializeComplexNumbers) +{ + std::stringstream ss1("[0.0,0.0]"); + std::complex cd1 = 0; + json j1; + ss1 >> j1; + EXPECT_EQ(j1.get>(), cd1); + + std::stringstream ss2("[42.5,0.0]"); + std::complex cd2 = 42.5; + json j2; + ss2 >> j2; + EXPECT_EQ(j2.get>(), cd2); + + std::stringstream ss3("[0.0,12.2]"); + std::complex cd3 = {0, 12.2}; + json j3; + ss3 >> j3; + EXPECT_EQ(j3.get>(), cd3); + + std::stringstream ss4("[10.9,9.1]"); + std::complex cd4 = {10.9, 9.1}; + json j4; + ss4 >> j4; + EXPECT_EQ(j4.get>(), cd4); + + std::stringstream ss5("[0]"); + std::complex cd5 = 0; + json j5; + ss5 >> j5; + EXPECT_EQ(j5.get>(), cd5); + + std::stringstream ss6("[42.5]"); + std::complex cd6 = 42.5; + json j6; + ss6 >> j6; + EXPECT_EQ(j6.get>(), cd6); + + std::stringstream ss7("[42.5]"); + std::complex cd7 = {0, 42.5}; + json j7; + ss7 >> j7; + EXPECT_NE(j7.get>(), cd7); + + std::stringstream ss8("42.5"); + std::complex cd8 = 42.5; + json j8; + ss8 >> j8; + EXPECT_EQ(j8.get>(), cd8); + + std::stringstream ss9("[]"); + std::complex cd9 = 0; + json j9; + ss9 >> j9; + EXPECT_EQ(j9.get>(), cd9); + + std::stringstream ss10("[1,2,3]"); + std::complex cd10; + json j10; + ss10 >> j10; + EXPECT_THROW(std::from_json(j10, cd10), helib::IOError); +} + +TEST_P(TestIO_BGV, polyModWriteToJSONWorks) +{ + std::stringstream ss1, ss2, ss3; + helib::PolyMod s1(context.getSlotRing()), s2(context.getSlotRing()), + s3(context.getSlotRing()); + s1 = 0; + s2 = 42; + s3 = {1, 2, 3}; + ss1 << s1; + ss2 << s2; + ss3 << s3; + + EXPECT_EQ(ss1.str(), "[0]"); + EXPECT_EQ(ss2.str(), "[0]"); + EXPECT_EQ(ss3.str(), "[1,0,1]"); + + helib::PolyMod invalid; + EXPECT_THROW(ss1 << invalid, helib::LogicError); +} + +TEST_P(TestIO_BGV, polyModReadFromJSONWorks) +{ + auto ring = context.getSlotRing(); + std::stringstream ss1("[0]"), ss2("[0]"), ss3("[1,0,1]"); + helib::PolyMod s1(ring), s2(ring), s3(ring), s4(ring); + s1 = 0; + s2 = 42; + s3 = {1, 2, 3}; + EXPECT_EQ(helib::PolyMod::readFromJSON(ss1, ring), s1); + EXPECT_EQ(helib::PolyMod::readFromJSON(ss2, ring), s2); + EXPECT_EQ(helib::PolyMod::readFromJSON(ss3, ring), s3); + + std::stringstream ss4; + ss4 << "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, " + "20, 21, 22, 23, 24, 25]"; + EXPECT_THROW(helib::PolyMod::readFromJSON(ss4, ring), helib::IOError); +} + +TEST_P(TestIO_BGV, polyModReadJSONPolyModObjects) +{ + auto ring = context.getSlotRing(); + std::stringstream ss1("[0]"), ss2("[0]"), ss3("[1,0,1]"); + helib::PolyMod s1(ring), s2(ring), s3(ring), s4(ring), ds1(ring), ds2(ring), + ds3(ring), ds4(ring), invalid; + s1 = 0; + s2 = 42; + s3 = {1, 2, 3}; + ds1.readJSON(ss1); + ds2.readJSON(ss2); + ds3.readJSON(ss3); + EXPECT_EQ(ds1, s1); + EXPECT_EQ(ds2, s2); + EXPECT_EQ(ds3, s3); + + std::stringstream ss4; + ss4 << "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, " + "20, 21, 22, 23, 24, 25]"; + EXPECT_THROW(ds4.readJSON(ss4), helib::IOError); + ss4 << "[1]"; + EXPECT_THROW(invalid.readJSON(ss4), helib::LogicError); +} + +TEST_P(TestIO_BGV, + polyModReadFromJSONFunctionThrowsIfMoreEqualsElementsThanDegree) +{ + auto ring = context.getSlotRing(); + + std::stringstream ss; + ss << "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, " + "20, 21, 22, 23, 24, 25]"; + + EXPECT_THROW(helib::PolyMod::readFromJSON(ss, ring), helib::IOError); + + ss.str(""); + ss.clear(); + + json j; + to_json(j, ring->G); + ss << j; + + EXPECT_THROW(helib::PolyMod::readFromJSON(ss, ring), helib::IOError); +} + +TEST_P(TestIO_BGV, polyModReadFromJSONFunctionThrowsIfFloatingPointCoefficient) +{ + // G = x^2 + auto ring = context.getSlotRing(); + + std::stringstream ss; + ss << "[1.5, 2.2]"; + + EXPECT_THROW(helib::PolyMod::readFromJSON(ss, ring), helib::IOError); +} + +TEST_P(TestIO_BGV, rpolyModRightShiftOperatorThrowsIfMoreElementsThanDegree) +{ + NTL::ZZX G; + NTL::SetX(G); + G *= G; + // G = x^2 + auto ring = context.getSlotRing(); + helib::PolyMod dest(ring); + + std::stringstream ss; + ss << "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, " + "20, 21, 22, 23, 24, 25]"; + + EXPECT_THROW(ss >> dest, helib::IOError); +} + +TEST_P(TestIO_BGV, polyModWriteToJSONSerializesCorrectly) +{ + NTL::ZZX G; + NTL::SetX(G); + G *= G; // G^2 + auto ring = context.getSlotRing(); + NTL::ZZX data; + NTL::SetCoeff(data, 0, 2); + NTL::SetCoeff(data, 1, 1); + helib::PolyMod poly(data, ring); + + std::stringstream ss; + poly.writeToJSON(ss); + std::string expected_string = "[0,1]"; + + EXPECT_EQ(ss.str(), expected_string); +} + +TEST_P(TestIO_BGV, polyModReadFromJSONDeserializesCorrectly) +{ + auto ring = context.getSlotRing(); + NTL::ZZX data; + NTL::SetCoeff(data, 0, 3); + NTL::SetCoeff(data, 1, 1); + helib::PolyMod expected_result(data, ring); + + std::string string_poly = "[3, 1]"; + std::stringstream str(string_poly); + helib::PolyMod deserialized_poly = helib::PolyMod::readFromJSON(str, ring); + + EXPECT_EQ(deserialized_poly, expected_result); +} + +TEST_P(TestIO_BGV, serializeContextWithStreamOperator) +{ + std::stringstream strm; + const json expected_json = makeExpectedJSON(context); + + EXPECT_NO_THROW(strm << context); + EXPECT_EQ(strm.str(), expected_json.dump()); +} + +TEST_P(TestIO_BGV, deserializingContextDoesNotThrow) +{ + std::stringstream str; + + context.writeToJSON(str); + + EXPECT_NO_THROW(helib::Context::readFromJSON(str)); +} + +TEST_P(TestIO_BGV, handlingContextDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << context; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("m"); + + ss << j; + EXPECT_THROW(helib::Context::readFromJSON(ss), helib::RuntimeError); +} + +TEST_P(TestIO_BGV, readContextFromDeserializeCorrectly) +{ + std::stringstream ss; + + ss << context; + + helib::Context deserialized_context = helib::Context::readFromJSON(ss); + + EXPECT_EQ(deserialized_context, context); +} + +TEST_P(TestIO_BGV, canPerformOperationWithDeserializedContext) +{ + std::stringstream ss; + + ss << context; + + helib::Context deserialized_context = helib::Context::readFromJSON(ss); + + EXPECT_NO_THROW(helib::PubKey{deserialized_context}); + EXPECT_NO_THROW(helib::SecKey{deserialized_context}); + + helib::Ctxt ctxt{helib::PubKey(deserialized_context)}; + + EXPECT_NO_THROW(ctxt.square()); + EXPECT_NO_THROW(ctxt += ctxt); + EXPECT_NO_THROW(ctxt.reLinearize()); + EXPECT_NO_THROW(deserialized_context.getEA().rotate(ctxt, 1)); +} + +TEST_P(TestIO_BGV, serializeKeysWithStreamOperator) +{ + std::stringstream str; + + EXPECT_NO_THROW(str << publicKey); + EXPECT_NO_THROW(str << secretKey); +} + +TEST_P(TestIO_BGV, deserializeKeysWithStreamOperator) +{ + std::stringstream str; + + str << publicKey; + + EXPECT_NO_THROW(str >> publicKey); + + str.str(""); + str.clear(); + + str << secretKey; + + EXPECT_NO_THROW(str >> secretKey); +} + +TEST_P(TestIO_BGV, readKeysFromDeserializeCorrectly) +{ + std::stringstream ss; + + ss << publicKey; + + helib::PubKey deserialized_pk(context); + ss >> deserialized_pk; + + EXPECT_EQ(publicKey, deserialized_pk); + + ss.str(""); + ss.clear(); + + ss << secretKey; + + helib::SecKey deserialized_sk = helib::SecKey::readFromJSON(ss, context); + + EXPECT_EQ(secretKey, deserialized_sk); +} + +TEST_P(TestIO_BGV, handlingPublicKeyDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << publicKey; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("KS_strategy"); + + ss << j; + EXPECT_THROW(helib::PubKey::readFromJSON(ss, context), helib::RuntimeError); +} + +TEST_P(TestIO_BGV, handlingSecretKeyDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << secretKey; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("PubKey"); + + ss << j; + EXPECT_THROW(helib::SecKey::readFromJSON(ss, context), helib::RuntimeError); +} + +TEST_P(TestIO_BGV, canEncryptWithDeserializedPublicKey) +{ + std::stringstream ss; + + ss << publicKey; + + helib::PubKey deserialized_pk = helib::PubKey::readFromJSON(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + helib::Ctxt ctxt(deserialized_pk); + + EXPECT_NO_THROW(ptxt.encrypt(ctxt)); + + decrypted_result.decrypt(ctxt, secretKey); + + EXPECT_EQ(ptxt, decrypted_result); +} + +TEST_P(TestIO_BGV, canDecryptWithDeserializedSecretKey) +{ + std::stringstream ss; + + ss << secretKey; + + helib::SecKey deserialized_sk = helib::SecKey::readFromJSON(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + + helib::Ctxt ctxt(publicKey); + ptxt.encrypt(ctxt); + + EXPECT_NO_THROW(decrypted_result.decrypt(ctxt, deserialized_sk)); + EXPECT_EQ(ptxt, decrypted_result); +} + +TEST_P(TestIO_BGV, serializeCiphertextWithStreamOperator) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(str << ctxt); +} + +TEST_P(TestIO_BGV, deserializeCiphertextWithStreamOperator) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + str << ctxt; + + EXPECT_NO_THROW(str >> ctxt); +} + +TEST_P(TestIO_BGV, readCiphertextFromDeserializeCorrectly) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + + helib::Ctxt deserialized_ctxt(publicKey); + ss >> deserialized_ctxt; + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestIO_BGV, handlingCiphertextDeserializationWithMissingField) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("noiseBound"); + + ss << j; + EXPECT_THROW(helib::Ctxt::readFromJSON(ss, publicKey), helib::RuntimeError); +} + +TEST_P(TestIO_BGV, canPerformOperationsOnDeserializedCiphertext) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFromJSON(ss, publicKey); + helib::PtxtArray ptxt(ea); + + EXPECT_NO_THROW(deserialized_ctxt *= ctxt); + EXPECT_NO_THROW(deserialized_ctxt += ctxt); + EXPECT_NO_THROW(deserialized_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(deserialized_ctxt, 1)); + EXPECT_NO_THROW(ptxt.decrypt(deserialized_ctxt, secretKey)); +} + +TEST_P(TestIO_BGV, ptxtWritesDataCorrectlyToOstream) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); + std::stringstream ss; + ss << "["; + for (long i = 0; i < helib::lsize(data); ++i) { + NTL::ZZX input; + NTL::SetCoeff(input, 0, i % p2r); + if (d != 1) { + NTL::SetCoeff(input, 1, (i + 2) % p2r); + } + data[i] = input; + ss << data[i] << (i != helib::lsize(data) - 1 ? "," : ""); + } + ss << "]"; + helib::Ptxt ptxt(context, data); + std::string expected = + "{\"HElibVersion\":\"" + std::string(helib::version::asString) + + "\",\"content\":{\"scheme\":\"BGV\"," + "\"slots\":" + + ss.str() + "},\"serializationVersion\":\"0.0.1\",\"type\":\"Ptxt\"}"; + std::ostringstream os; + os << ptxt; + + EXPECT_EQ(os.str(), expected); +} + +TEST_P(TestIO_BGV, ptxtReadsDataCorrectlyFromIstream) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); + for (long i = 0; i < helib::lsize(data); ++i) { + data[i] = {i, i + 2}; + } + helib::Ptxt ptxt(context); + std::stringstream ss; + ss << "["; + for (auto it = data.begin(); it != data.end(); it++) { + ss << *it; + if (it != data.end() - 1) { + ss << ", "; + } + } + ss << "]"; + + std::string expected = addHeader(ss.str(), "BGV"); + ss.str(expected); + ss >> ptxt; + + for (std::size_t i = 0; i < ptxt.size(); ++i) { + EXPECT_EQ(ptxt[i], data[i]); + } +} + +TEST_P(TestIO_BGV, ptxtReadsJSONVectorFromIstream) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); + for (long i = 0; i < helib::lsize(data); ++i) { + data[i] = {i, i + 2}; + } + helib::Ptxt ptxt(context); + std::stringstream ss; + ss << "["; + for (auto it = data.begin(); it != data.end(); it++) { + ss << *it; + if (it != data.end() - 1) { + ss << ", "; + } + } + ss << "]"; + + ss >> ptxt; + + for (std::size_t i = 0; i < ptxt.size(); ++i) { + EXPECT_EQ(ptxt[i], data[i]); + } +} + +TEST_P(TestIO_BGV, ptxtWriteToJSONFunctionSerializesPtxtCorrectly) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); + std::stringstream ptxt_string_stream; + ptxt_string_stream << "["; + for (long i = 0; i < helib::lsize(data); ++i) { + data[i] = 2 * i; + ptxt_string_stream << "[" << helib::mcMod(2 * i, context.getPPowR()) << "]"; + if (i < helib::lsize(data) - 1) + ptxt_string_stream << ","; + } + ptxt_string_stream << "]"; + helib::Ptxt ptxt(context, data); + + std::stringstream ss; + ptxt.writeToJSON(ss); + + EXPECT_EQ(ss.str(), addHeader(ptxt_string_stream.str(), "BGV")); +} + +TEST_P(TestIO_BGV, ptxtReadFromJSONFunctionDeserializesPtxtCorrectly) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); + std::stringstream ptxt_string_stream; + ptxt_string_stream << "["; + for (long i = 0; i < helib::lsize(data); ++i) { + NTL::ZZX tmp; + ptxt_string_stream << "["; + for (long j = 0; j < context.getOrdP(); ++j) { + NTL::SetCoeff(tmp, j, j * j); + ptxt_string_stream << j * j; + if (j < context.getOrdP() - 1) + ptxt_string_stream << ","; + } + data[i] = tmp; + ptxt_string_stream << "]"; + if (i < helib::lsize(data) - 1) + ptxt_string_stream << ","; + } + ptxt_string_stream << "]"; + std::string expected = addHeader(ptxt_string_stream.str(), "BGV"); + ptxt_string_stream.str(expected); + helib::Ptxt ptxt(context, data); + + helib::Ptxt deserialized_ptxt = + helib::Ptxt::readFromJSON(ptxt_string_stream, context); + + EXPECT_EQ(ptxt, deserialized_ptxt); +} + +TEST_P(TestIO_BGV, ptxtReadFromJSONFunctionThrowsIfMoreElementsThanSlots) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size() + 1, poly); + std::stringstream ptxt_string_stream; + ptxt_string_stream << "["; + for (long i = 0; i < helib::lsize(data); ++i) { + data[i] = {i, i * i}; + ptxt_string_stream << "[" << i << ", " << i * i << "]"; + if (i < helib::lsize(data) - 1) + ptxt_string_stream << ","; + } + ptxt_string_stream << "]"; + std::string ptxt_string = addHeader(ptxt_string_stream.str(), "BGV"); + ptxt_string_stream.str(ptxt_string); + + EXPECT_THROW( + helib::Ptxt::readFromJSON(ptxt_string_stream, context), + helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtRightShiftOperatorThrowsIfMoreElementsThanSlots) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size() + 1, poly); + std::stringstream ptxt_string_stream; + ptxt_string_stream << "["; + for (long i = 0; i < helib::lsize(data); ++i) { + data[i] = {i, i * i}; + ptxt_string_stream << "[" << i << ", " << i * i << "]"; + if (i < helib::lsize(data) - 1) + ptxt_string_stream << ", "; + } + ptxt_string_stream << "]"; + std::string s = addHeader(ptxt_string_stream.str(), "BGV"); + ptxt_string_stream.str(s); + + helib::Ptxt deserialized_ptxt(context); + EXPECT_THROW(ptxt_string_stream >> deserialized_ptxt, helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtWriteToJSONCorrectlyWritesMetdata) +{ + helib::Ptxt ptxt(context); + std::stringstream ss; + ss << ptxt; + json j; + ss >> j; + + EXPECT_TRUE(j.contains("type")); + EXPECT_EQ(j.at("type").get(), helib::Ptxt::typeName); + + EXPECT_TRUE(j.contains("serializationVersion")); + EXPECT_EQ(j.at("serializationVersion").get(), + helib::jsonSerializationVersion); + + EXPECT_TRUE(j.contains("HElibVersion")); + EXPECT_EQ(j.at("HElibVersion").get(), helib::version::asString); + + j = j.at("content"); + EXPECT_TRUE(j.contains("scheme")); + EXPECT_EQ(j.at("scheme").get(), helib::BGV::schemeName); + + EXPECT_TRUE(j.contains("slots")); + EXPECT_EQ(j.at("slots").size(), ea.size()); +} + +TEST_P(TestIO_BGV, ptxtReadFromJSONFailsWhenBadMetadata) +{ + helib::PolyMod poly(context.getSlotRing()); + helib::Ptxt original_ptxt{context}; + std::stringstream ptxt_string_stream; + for (long i = 0; i < original_ptxt.lsize(); ++i) { + original_ptxt[i] = {i, i * i}; + } + + helib::JsonWrapper jw = original_ptxt.writeToJSON(); + + helib::Ptxt dest_ptxt; + + EXPECT_THROW(dest_ptxt.readJSON(jw), helib::RuntimeError); + + dest_ptxt = helib::Ptxt(context); + + json jmod = unwrap(jw); + jmod.at("type") = "wrong"; + EXPECT_THROW(dest_ptxt.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("serializationVersion") = "wrong"; + EXPECT_THROW(dest_ptxt.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("HElibVersion") = "wrong"; + EXPECT_THROW(dest_ptxt.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("content").at("scheme") = "wrong"; + EXPECT_THROW(dest_ptxt.readJSON(helib::wrap(jmod)), helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtReadFromJSONCorrectlyPadsData) +{ + std::stringstream ss(addHeader("[]", "BGV")); + helib::Ptxt deserialized_ptxt(context); + ss >> deserialized_ptxt; + + EXPECT_EQ(deserialized_ptxt.size(), ea.size()); + for (long i = 0; i < ea.size(); ++i) { + EXPECT_EQ(deserialized_ptxt[i], 0); + } + + ss.str(""); + ss.clear(); + + std::vector data(context.getEA().size() / 2, 1); + json j = data; + ss.str(addHeader(j.dump(), "BGV")); + ss >> deserialized_ptxt; + + EXPECT_EQ(deserialized_ptxt.size(), ea.size()); + for (long i = 0; i < ea.size(); ++i) { + if (i < static_cast(data.size())) { + EXPECT_EQ(deserialized_ptxt[i], 1); + } else { + EXPECT_EQ(deserialized_ptxt[i], 0); + } + } +} + +TEST_P(TestIO_BGV, ptxtReadsManyPtxtsFromStream) +{ + helib::PolyMod poly(context.getSlotRing()); + std::vector data1(context.getEA().size(), poly); + std::vector data2(context.getEA().size(), poly); + std::vector data3(context.getEA().size(), poly); + for (long i = 0; i < helib::lsize(data1); ++i) { + data1[i] = {i, i + 2}; + data2[i] = {2 * i, 2 * (i + 2)}; + data3[i] = {3 * i, 3 * (i + 2)}; + } + helib::Ptxt ptxt1(context, data1); + helib::Ptxt ptxt2(context, data2); + helib::Ptxt ptxt3(context, data3); + + std::stringstream ss; + ss << ptxt1 << std::endl; + ss << ptxt2 << std::endl; + ss << ptxt3 << std::endl; + + helib::Ptxt deserialized1(context); + helib::Ptxt deserialized2(context); + helib::Ptxt deserialized3(context); + ss >> deserialized1; + ss >> deserialized2; + ss >> deserialized3; + + EXPECT_EQ(ptxt1, deserialized1); + EXPECT_EQ(ptxt2, deserialized2); + EXPECT_EQ(ptxt3, deserialized3); +} + +TEST_P(TestIO_CKKS, serializeContextWithStreamOperator) +{ + std::stringstream strm; + const json expected_json = makeExpectedJSON(context); + + EXPECT_NO_THROW(strm << context); + EXPECT_EQ(strm.str(), expected_json.dump()); +} + +TEST_P(TestIO_CKKS, deserializingContextDoesNotThrow) +{ + std::stringstream str; + + context.writeToJSON(str); + + EXPECT_NO_THROW(helib::Context::readFromJSON(str)); +} + +TEST_P(TestIO_CKKS, handlingContextDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << context; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("m"); + + ss << j; + EXPECT_THROW(helib::Context::readFromJSON(ss), helib::RuntimeError); +} + +TEST_P(TestIO_CKKS, canPerformOperationWithDeserializedContext) +{ + std::stringstream ss; + + ss << context; + + helib::Context deserialized_context = helib::Context::readFromJSON(ss); + + EXPECT_NO_THROW(helib::PubKey{deserialized_context}); + EXPECT_NO_THROW(helib::SecKey{deserialized_context}); + + helib::Ctxt ctxt{helib::PubKey(deserialized_context)}; + + EXPECT_NO_THROW(ctxt.square()); + EXPECT_NO_THROW(ctxt += ctxt); + EXPECT_NO_THROW(ctxt.reLinearize()); + EXPECT_NO_THROW(deserialized_context.getEA().rotate(ctxt, 1)); +} + +TEST_P(TestIO_CKKS, readContextFromDeserializeCorrectly) +{ + std::stringstream ss; + + ss << context; + + helib::Context deserialized_context = helib::Context::readFromJSON(ss); + + EXPECT_EQ(deserialized_context, context); +} + +TEST_P(TestIO_CKKS, serializeKeysWithStreamOperator) +{ + std::stringstream str; + + EXPECT_NO_THROW(str << publicKey); + EXPECT_NO_THROW(str << secretKey); +} + +TEST_P(TestIO_CKKS, deserializeKeysWithStreamOperator) +{ + std::stringstream str; + + str << publicKey; + + EXPECT_NO_THROW(str >> publicKey); + + str.str(""); + str.clear(); + + str << secretKey; + + EXPECT_NO_THROW(str >> secretKey); +} + +TEST_P(TestIO_CKKS, readKeysFromDeserializeCorrectly) +{ + std::stringstream ss; + + ss << publicKey; + + helib::PubKey deserialized_pk(context); + ss >> deserialized_pk; + + EXPECT_EQ(publicKey, deserialized_pk); + + ss.str(""); + ss.clear(); + + ss << secretKey; + + helib::SecKey deserialized_sk = helib::SecKey::readFromJSON(ss, context); + + EXPECT_EQ(secretKey, deserialized_sk); +} + +TEST_P(TestIO_CKKS, handlingPublicKeyDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << publicKey; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("KS_strategy"); + + ss << j; + EXPECT_THROW(helib::PubKey::readFromJSON(ss, context), helib::RuntimeError); +} + +TEST_P(TestIO_CKKS, handlingSecretKeyDeserializationWithMissingField) +{ + std::stringstream ss; + + ss << secretKey; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("PubKey"); + + ss << j; + EXPECT_THROW(helib::SecKey::readFromJSON(ss, context), helib::RuntimeError); +} + +TEST_P(TestIO_CKKS, canEncryptWithDeserializedPublicKey) +{ + std::stringstream ss; + + ss << publicKey; + + helib::PubKey deserialized_pk = helib::PubKey::readFromJSON(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + + helib::Ctxt ctxt(deserialized_pk); + + EXPECT_NO_THROW(ptxt.encrypt(ctxt)); + + decrypted_result.decrypt(ctxt, secretKey); + + EXPECT_EQ(ptxt, helib::Approx(decrypted_result)); +} + +TEST_P(TestIO_CKKS, canDecryptWithDeserializedSecretKey) +{ + std::stringstream ss; + + ss << secretKey; + + helib::SecKey deserialized_sk = helib::SecKey::readFromJSON(ss, context); + + helib::PtxtArray ptxt(ea), decrypted_result(ea); + ptxt.random(); + + helib::Ctxt ctxt(publicKey); + ptxt.encrypt(ctxt); + + EXPECT_NO_THROW(decrypted_result.decrypt(ctxt, deserialized_sk)); + EXPECT_EQ(ptxt, helib::Approx(decrypted_result)); +} + +TEST_P(TestIO_CKKS, serializeCiphertextWithStreamOperator) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + EXPECT_NO_THROW(str << ctxt); +} + +TEST_P(TestIO_CKKS, deserializeCiphertextWithStreamOperator) +{ + std::stringstream str; + helib::Ctxt ctxt(publicKey); + + str << ctxt; + + EXPECT_NO_THROW(str >> ctxt); +} + +TEST_P(TestIO_CKKS, readCiphertextFromDeserializeCorrectly) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + + helib::Ctxt deserialized_ctxt(publicKey); + ss >> deserialized_ctxt; + + EXPECT_EQ(ctxt, deserialized_ctxt); +} + +TEST_P(TestIO_CKKS, handlingCiphertextDeserializationWithMissingField) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + + json j; + ss >> j; + + // Clears the stream + ss.str(""); + ss.clear(); + j.at("content").erase("noiseBound"); + + ss << j; + EXPECT_THROW(helib::Ctxt::readFromJSON(ss, publicKey), helib::RuntimeError); +} + +TEST_P(TestIO_CKKS, canPerformOperationsOnDeserializedCiphertext) +{ + std::stringstream ss; + helib::Ctxt ctxt(publicKey); + + ss << ctxt; + helib::Ctxt deserialized_ctxt = helib::Ctxt::readFromJSON(ss, publicKey); + helib::PtxtArray ptxt(ea); + + EXPECT_NO_THROW(deserialized_ctxt *= ctxt); + EXPECT_NO_THROW(deserialized_ctxt += ctxt); + EXPECT_NO_THROW(deserialized_ctxt.reLinearize()); + EXPECT_NO_THROW(ea.rotate(deserialized_ctxt, 1)); + EXPECT_NO_THROW(ptxt.decrypt(deserialized_ctxt, secretKey)); +} + +TEST_P(TestIO_CKKS, ptxtWritesDataCorrectlyToOstream) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context, data); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS"); + std::ostringstream os; + os << ptxt; + + EXPECT_EQ(os.str(), expected); +} + +TEST_P(TestIO_CKKS, ptxtReadsDataCorrectlyFromIstream) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context); + std::stringstream ss; + json j = data; + ss << addHeader(j.dump(), "CKKS"); + std::istringstream is(ss.str()); + is >> ptxt; + + COMPARE_CXDOUBLE_VECS(ptxt, data); +} + +TEST_P(TestIO_CKKS, ptxtReadsSquareBracketsDataCorrectly) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS"); + std::istringstream is(expected); + is >> ptxt; + + COMPARE_CXDOUBLE_VECS(ptxt, data); +} + +TEST_P(TestIO_CKKS, ptxtWriteToJSONSerializesPtxtCorrectly) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context, data); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS"); + std::stringstream serialized_ptxt; + ptxt.writeToJSON(serialized_ptxt); + + EXPECT_EQ(serialized_ptxt.str(), expected); +} + +TEST_P(TestIO_CKKS, ptxtRightShiftDeserializeCorrectly) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS"); + std::istringstream is(expected); + is >> ptxt; + + COMPARE_CXDOUBLE_VECS(ptxt, data); +} + +TEST_P(TestIO_CKKS, ptxtReadsJSONVectorFromIstream) +{ + std::vector> data(context.getEA().size()); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context); + json j = data; + std::istringstream is(j.dump()); + is >> ptxt; + + COMPARE_CXDOUBLE_VECS(ptxt, data); +} + +TEST_P(TestIO_CKKS, ptxtReadFromJSONThrowsIfMoreElementsThanSlots) +{ + std::vector> data(context.getEA().size() + 1); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + std::stringstream ss; + ss << "["; + ss << std::setprecision(std::numeric_limits::digits10); + for (auto it = data.begin(); it != data.end(); it++) { + ss << "[" << it->real() << ", " << it->imag() << "]"; + if (it != data.end() - 1) { + ss << ", "; + } + } + ss << "]"; + std::istringstream is(ss.str()); + EXPECT_THROW(helib::Ptxt::readFromJSON(is, context), + helib::IOError); +} + +TEST_P(TestIO_CKKS, ptxtRightShiftOperatorThrowsIfMoreElementsThanSlots) +{ + std::vector> data(context.getEA().size() + 1); + for (std::size_t i = 0; i < data.size(); ++i) { + data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + } + helib::Ptxt ptxt(context); + std::stringstream ss; + ss << "["; + ss << std::setprecision(std::numeric_limits::digits10); + for (auto it = data.begin(); it != data.end(); it++) { + ss << "[" << it->real() << ", " << it->imag() << "]"; + if (it != data.end() - 1) { + ss << ", "; + } + } + ss << "]"; + std::istringstream is(addHeader(ss.str(), "CKKS")); + EXPECT_THROW(is >> ptxt, helib::IOError); +} + +TEST_P(TestIO_CKKS, ptxtReadsManyPtxtsFromStream) +{ + std::vector> data1(context.getEA().size()); + std::vector> data2(context.getEA().size()); + std::vector> data3(context.getEA().size()); + for (std::size_t i = 0; i < data1.size(); ++i) { + data1[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + data2[i] = data1[i] * 2.0; + data3[i] = data1[i] * 3.5; + } + helib::Ptxt ptxt1(context, data1); + helib::Ptxt ptxt2(context, data2); + helib::Ptxt ptxt3(context, data3); + + std::stringstream ss; + ss << ptxt1 << std::endl; + ss << ptxt2 << std::endl; + ss << ptxt3 << std::endl; + + helib::Ptxt deserialized1(context); + helib::Ptxt deserialized2(context); + helib::Ptxt deserialized3(context); + ss >> deserialized1; + ss >> deserialized2; + ss >> deserialized3; + + COMPARE_CXDOUBLE_VECS(ptxt1, deserialized1); + COMPARE_CXDOUBLE_VECS(ptxt2, deserialized2); + COMPARE_CXDOUBLE_VECS(ptxt3, deserialized3); +} + +TEST_P(TestIO_BGV, contextBuilderLogsCorrectly) +{ + long c = 3; + std::vector gens = {3}; + std::vector ords = {-2}; + std::vector mvec = {3}; + bool buildModChainFlag = false; + long bits = 2; + long skHwt = 64; + long resolution = 1; + long bitsInSpecialPrimes = 15; + bool bootstrappableFlag = true; + bool buildCacheFlag = true; + bool thickFlag = true; + + // clang-format off + auto cb = helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .c(c) + .gens(gens) + .ords(ords) + .buildModChain(buildModChainFlag) + .bits(bits) + .skHwt(skHwt) + .resolution(resolution) + .bitsInSpecialPrimes(bitsInSpecialPrimes) + .bootstrappable(bootstrappableFlag) + .mvec(mvec) + .buildCache(buildCacheFlag) + .thickboot(); + // clang-format off + + std::stringstream ss; + json actual_json; + ss << cb; + ss >> actual_json; + + // Content only + const json expected_json = { + { "scheme", "bgv" }, + { "m", m }, + { "p", p }, + { "r", r }, + { "c", c }, + { "gens", gens }, + { "ords", ords }, + { "buildModChainFlag", buildModChainFlag }, + { "bits", bits }, + { "skHwt", skHwt }, + { "resolution", resolution }, + { "bitsInSpecialPrimes", bitsInSpecialPrimes }, + { "bootstrappableFlag", bootstrappableFlag }, + { "mvec", mvec }, + { "buildCacheFlag", buildCacheFlag }, + { "thickFlag", thickFlag } + }; + + EXPECT_EQ(actual_json.at("content"), expected_json); +} + +TEST_P(TestIO_CKKS, contextBuilderLogsCorrectly) +{ + long c = 3; + std::vector gens = {3}; + std::vector ords = {-2}; + bool buildModChainFlag = false; + long bits = 2; + long skHwt = 64; + long resolution = 1; + long bitsInSpecialPrimes = 15; + + // clang-format off + auto cb = helib::ContextBuilder() + .m(m) + .precision(precision) + .c(c) + .gens(gens) + .ords(ords) + .buildModChain(buildModChainFlag) + .bits(bits) + .skHwt(skHwt) + .resolution(resolution) + .bitsInSpecialPrimes(bitsInSpecialPrimes); + // clang-format off + + std::stringstream ss; + json actual_json; + ss << cb; + ss >> actual_json; + + // Content only + const json expected_json = { + { "scheme", "ckks"}, + { "m", m }, + { "precision", precision }, + { "c", c }, + { "gens", gens }, + { "ords", ords }, + { "buildModChainFlag", buildModChainFlag }, + { "bits", bits }, + { "skHwt", skHwt }, + { "resolution", resolution }, + { "bitsInSpecialPrimes", bitsInSpecialPrimes } + }; + + EXPECT_EQ(actual_json.at("content"), expected_json); +} + +INSTANTIATE_TEST_SUITE_P(Parameters, + TestIO_BGV, + ::testing::Values(BGVParameters(/*m=*/45, + /*p=*/2, + /*r=*/1, + /*bits=*/30, + /*gens=*/{}, + /*ords=*/{}, + /*mvec=*/{}))); + +INSTANTIATE_TEST_SUITE_P(Parameters, + TestIO_CKKS, + ::testing::Values(CKKSParameters(/*m=*/64, + /*precision=*/30, + /*bits=*/30))); + +} // namespace diff --git a/tests/TestMatmulCKKS.cpp b/tests/TestMatmulCKKS.cpp index 62768f98c..d9fdcd40c 100644 --- a/tests/TestMatmulCKKS.cpp +++ b/tests/TestMatmulCKKS.cpp @@ -95,10 +95,14 @@ class TestMatmulCKKS : public ::testing::TestWithParam r(GetParam().r), bits(GetParam().bits), nt(GetParam().nt), - context(m, /*p=*/-1, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .precision(r) + .bits(bits) + .build()), + secretKey(context), publicKey(keySetup(secretKey, GetParam().ks_strategy)), - ea(*(context.ea)) + ea(context.getEA()) {} static helib::SecKey& keySetup(helib::SecKey& secretKey, int ks_strategy) @@ -132,22 +136,23 @@ class TestMatmulCKKS : public ::testing::TestWithParam virtual void SetUp() override { if (helib_test::verbose) { - context.zMStar.printout(); - std::cout << "# small primes = " << context.smallPrimes.card() << "\n" - << "# ctxt primes = " << context.ctxtPrimes.card() << "\n" - << "# bits in ctxt primes = " - << long(context.logOfProduct(context.ctxtPrimes) / log(2.0) + - 0.5) - << "\n" - << "# special primes = " << context.specialPrimes.card() << "\n" - << "# bits in special primes = " - << long(context.logOfProduct(context.specialPrimes) / log(2.0) + - 0.5) - << "\n"; + context.getZMStar().printout(); + std::cout + << "# small primes = " << context.getSmallPrimes().card() << "\n" + << "# ctxt primes = " << context.getCtxtPrimes().card() << "\n" + << "# bits in ctxt primes = " + << long(context.logOfProduct(context.getCtxtPrimes()) / log(2.0) + + 0.5) + << "\n" + << "# special primes = " << context.getSpecialPrimes().card() << "\n" + << "# bits in special primes = " + << long(context.logOfProduct(context.getSpecialPrimes()) / log(2.0) + + 0.5) + << "\n"; helib::fhe_stats = true; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override diff --git a/tests/TestMatrix.cpp b/tests/TestMatrix.cpp index 797a114c8..fdf7549ab 100644 --- a/tests/TestMatrix.cpp +++ b/tests/TestMatrix.cpp @@ -193,15 +193,21 @@ class TestMatrixWithCtxt : public ::testing::TestWithParam m(GetParam().m), p(GetParam().p), r(GetParam().r), - context(m, p, r), - sk((helib::buildModChain(context, /*bits*/ 300, /*c*/ 2), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(300) + .c(2) + .build()), + sk(context), pk((sk.GenSecKey(), sk)), - ea(*context.ea) + ea(context.getEA()) {} virtual void SetUp() override { - helib::setupDebugGlobals(&sk, context.ea); + helib::setupDebugGlobals(&sk, context.shareEA()); if (!helib_test::noPrint) { helib::fhe_stats = true; } diff --git a/tests/TestPartialMatch.cpp b/tests/TestPartialMatch.cpp index 83cb3d6e1..882ca11b6 100644 --- a/tests/TestPartialMatch.cpp +++ b/tests/TestPartialMatch.cpp @@ -58,26 +58,31 @@ class TestPartialMatch : public ::testing::TestWithParam p(GetParam().p), r(GetParam().r), bits(GetParam().bits), - context(m, p, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), addSome1DMatrices(secretKey), addFrbMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} virtual void SetUp() override { if (helib_test::verbose) { ea.getPAlgebra().printout(); - std::cout << "r = " << context.alMod.getR() << std::endl; - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "r = " << context.getAlMod().getR() << std::endl; + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << "\n" << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -85,8 +90,9 @@ class TestPartialMatch : public ::testing::TestWithParam TEST(TestPartialMatch, calculateMasksThrowsWhenPassedEmptyQueryOrDatabase) { - helib::Context context(1024, 1087, 1); - const helib::EncryptedArray& ea = *(context.ea); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); + const helib::EncryptedArray& ea = context.getEA(); helib::Matrix> empty(0l, 0l); helib::Matrix> nonempty(1l, 1l); @@ -97,8 +103,9 @@ TEST(TestPartialMatch, calculateMasksThrowsWhenPassedEmptyQueryOrDatabase) TEST(TestPartialMatch, calculateMasksThrowsIfQueryAndDatabaseHaveUnequalWidth) { - helib::Context context(1024, 1087, 1); - const helib::EncryptedArray& ea = *(context.ea); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); + const helib::EncryptedArray& ea = context.getEA(); helib::Matrix> query(1l, 2l); helib::Matrix> database(2l, 3l); @@ -108,8 +115,9 @@ TEST(TestPartialMatch, calculateMasksThrowsIfQueryAndDatabaseHaveUnequalWidth) TEST(TestPartialMatch, calculateMasksReturnsZerosWhenNoMatchFound) { - helib::Context context(1024, 1087, 1); - const helib::EncryptedArray& ea = *(context.ea); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); + const helib::EncryptedArray& ea = context.getEA(); helib::Matrix> query( helib::Ptxt(context, std::vector(ea.size(), 0)), @@ -137,8 +145,9 @@ TEST(TestPartialMatch, calculateMasksReturnsZerosWhenNoMatchFound) TEST(TestPartialMatch, calculateMasksReturnsOnesWhenEverythingMatches) { - helib::Context context(1024, 1087, 1); - const helib::EncryptedArray& ea = *(context.ea); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); + const helib::EncryptedArray& ea = context.getEA(); helib::Matrix> query( helib::Ptxt(context, std::vector(ea.size(), 1)), @@ -166,8 +175,9 @@ TEST(TestPartialMatch, calculateMasksReturnsOnesWhenEverythingMatches) TEST(TestPartialMatch, calculateMasksWorksCorrectly) { - helib::Context context(1024, 1087, 1); - const helib::EncryptedArray& ea = *(context.ea); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); + const helib::EncryptedArray& ea = context.getEA(); helib::Matrix> plaintext_database(1l, 5l); // columns/features @@ -220,7 +230,8 @@ TEST(TestPartialMatch, calculateMasksWorksCorrectly) TEST(TestPartialMatch, calculateScoresThrowsIfIndexSetsAndOffsetsDifferInSize) { - helib::Context context(1024, 1087, 1); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); std::vector> index_sets(4, std::vector{}); std::vector offsets(3, 0); @@ -235,7 +246,8 @@ TEST(TestPartialMatch, calculateScoresThrowsIfIndexSetsAndOffsetsDifferInSize) TEST(TestPartialMatch, calculateScoresThrowsIfWeightsAndOffsetsDifferInSize) { - helib::Context context(1024, 1087, 1); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); std::vector> index_sets(4, std::vector{}); std::vector offsets(4, 0); @@ -250,7 +262,8 @@ TEST(TestPartialMatch, calculateScoresThrowsIfWeightsAndOffsetsDifferInSize) TEST(TestPartialMatch, calculateScoresThrowsIfWeightsAndIndexSetsDifferInSize) { - helib::Context context(1024, 1087, 1); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); std::vector> index_sets = {{2, 3}}; std::vector offsets = {5}; @@ -266,7 +279,8 @@ TEST(TestPartialMatch, calculateScoresThrowsIfWeightsAndIndexSetsDifferInSize) TEST(TestPartialMatch, calculateScoresThrowsIfMaskIsNotAColumnVector) { - helib::Context context(1024, 1087, 1); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); std::vector> index_sets = {{2, 3}}; std::vector offsets = {5}; @@ -282,7 +296,8 @@ TEST(TestPartialMatch, calculateScoresThrowsIfMaskIsNotAColumnVector) TEST(TestPartialMatch, calculateScoresWorksCorrectly) { - helib::Context context(1024, 1087, 1); + helib::Context context = + helib::ContextBuilder().m(1024).p(1087).r(1).build(); helib::Matrix> mask(2l, 5l); std::vector> mask_numbers = { @@ -511,7 +526,7 @@ TEST_P(TestPartialMatch, partialMatchEncodeEncodesIntegersCorrectly) helib::PolyMod output = partialMatchEncode(input, context); auto vec = static_cast>(output); uint32_t result = 0; - ASSERT_EQ(vec.size(), context.zMStar.getOrdP()); + ASSERT_EQ(vec.size(), context.getOrdP()); for (long i = 0, multiplier = 1; i < long(vec.size()); multiplier *= p, ++i) result += multiplier * vec[i]; EXPECT_EQ(input, result); @@ -566,7 +581,7 @@ TEST_P(TestPartialMatch, databaseLookupWorksCorrectly) // FLT on scores scores.apply([&](auto& ptxt) { - ptxt.power(context.alMod.getPPowR() - 1); + ptxt.power(context.getAlMod().getPPowR() - 1); return ptxt; }); @@ -650,11 +665,11 @@ TEST_P(TestPartialMatch, databaseLookupWorksCorrectlyForCtxtAndPtxt) // FLT on scores plaintext_scores.apply([&](auto& ptxt) { - ptxt.power(context.alMod.getPPowR() - 1); + ptxt.power(context.getAlMod().getPPowR() - 1); return ptxt; }); encrypted_scores.apply([&](auto& ctxt) { - ctxt.power(context.alMod.getPPowR() - 1); + ctxt.power(context.getAlMod().getPPowR() - 1); return ctxt; }); diff --git a/tests/TestPermutations.cpp b/tests/TestPermutations.cpp index d38a5321f..274d8d7b9 100644 --- a/tests/TestPermutations.cpp +++ b/tests/TestPermutations.cpp @@ -107,16 +107,21 @@ class TestPermutationsBGV : public ::testing::TestWithParam r(GetParam().r), bits(GetParam().bits), depth(GetParam().depth), - context(m, p, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .build()), + secretKey(context), publicKey( (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} virtual void SetUp() override { - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } @@ -140,16 +145,20 @@ class TestPermutationsCKKS : public ::testing::TestWithParam r(GetParam().r), bits(GetParam().bits), depth(GetParam().depth), - context(m, /*p=*/-1, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .precision(r) + .bits(bits) + .build()), + secretKey(context), publicKey( (secretKey.GenSecKey(), addSome1DMatrices(secretKey), secretKey)), - ea(context.ea->getCx()) + ea(context.getEA().getCx()) {} virtual void SetUp() override { - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } diff --git a/tests/TestPolyMod.cpp b/tests/TestPolyMod.cpp index 0f43808fc..b06fbd670 100644 --- a/tests/TestPolyMod.cpp +++ b/tests/TestPolyMod.cpp @@ -373,7 +373,7 @@ TEST(TestPolyMod, canBeSerializedAndDeserialized) std::stringstream ss; ss << pre_serialized_poly; - std::string serialized = "[1, 2]"; + std::string serialized = "[1,2]"; EXPECT_EQ(ss.str(), serialized); helib::PolyMod deserialized(ring); ss >> deserialized; @@ -381,77 +381,6 @@ TEST(TestPolyMod, canBeSerializedAndDeserialized) EXPECT_EQ(pre_serialized_poly, deserialized); } -TEST(TestPolyMod, deserializeFunctionThrowsIfMoreElementsThanDegree) -{ - const long p2r = 7; - NTL::ZZX G; - NTL::SetX(G); - G *= G; - // G = x^2 - auto ring = std::make_shared(p2r, 1, G); - helib::PolyMod dest(ring); - - std::stringstream ss; - ss << "[1, 2, 3, 4]"; - - EXPECT_THROW(deserialize(ss, dest), helib::IOError); -} - -TEST(TestPolyMod, rightShiftOperatorThrowsIfMoreElementsThanDegree) -{ - const long p2r = 7; - NTL::ZZX G; - NTL::SetX(G); - G *= G; - // G = x^2 - auto ring = std::make_shared(p2r, 1, G); - helib::PolyMod dest(ring); - - std::stringstream ss; - ss << "[1, 2, 3, 4]"; - - EXPECT_THROW(ss >> dest, helib::IOError); -} - -TEST(TestPolyMod, serializeFunctionSerializesCorrectly) -{ - const long p2r = 7; - NTL::ZZX G; - NTL::SetX(G); - G *= G; // G^2 - auto ring = std::make_shared(p2r, 1, G); - NTL::ZZX data; - NTL::SetCoeff(data, 0, 3); - NTL::SetCoeff(data, 1, 1); - helib::PolyMod poly(data, ring); - - std::stringstream ss; - serialize(ss, poly); - std::string expected_string = "[3, 1]"; - - EXPECT_EQ(ss.str(), expected_string); -} - -TEST(TestPolyMod, deserializeFunctionDeserializesCorrectly) -{ - const long p2r = 7; - NTL::ZZX G; - NTL::SetX(G); - G *= G; // G^2 - auto ring = std::make_shared(p2r, 1, G); - NTL::ZZX data; - NTL::SetCoeff(data, 0, 3); - NTL::SetCoeff(data, 1, 1); - helib::PolyMod expected_result(data, ring); - - std::string string_poly = "[3, 1]"; - helib::PolyMod deserialized_poly(ring); - std::stringstream str(string_poly); - deserialize(str, deserialized_poly); - - EXPECT_EQ(deserialized_poly, expected_result); -} - TEST(TestPolyMod, minusOperatorCorrectlyNegates) { const long p2r = 5; diff --git a/tests/TestPtxt.cpp b/tests/TestPtxt.cpp index 1fdb0fbd4..4945dcc11 100644 --- a/tests/TestPtxt.cpp +++ b/tests/TestPtxt.cpp @@ -20,6 +20,8 @@ #include "test_common.h" #include "gtest/gtest.h" +#include + namespace { struct BGVParameters @@ -45,12 +47,15 @@ class TestPtxtCKKS : public ::testing::TestWithParam TestPtxtCKKS() : // Only relevant parameter is m for a CKKS plaintext m(GetParam()), - context(m, -1, 40) + context(helib::ContextBuilder() + .m(m) + .precision(40) + .buildModChain(false) + .build()) // VJS_NOTE: I changed r=50 to r=40. // I find setting r so large can cause problems, // and the test was not passing. - // This may be somethng that needs further investigation, - // but later... + // This may be somethng that needs further investigation. // This probably has something to do with the slightly // different logic in the new encoding functions {} @@ -93,12 +98,12 @@ TEST_P(TestPtxtCKKS, reportsWhetherItIsValid) TEST_P(TestPtxtCKKS, hasSameNumberOfSlotsAsContext) { helib::Ptxt ptxt(context); - EXPECT_EQ(ptxt.size(), context.ea->size()); + EXPECT_EQ(ptxt.size(), context.getEA().size()); } TEST_P(TestPtxtCKKS, preservesDataPassedIntoConstructor) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) data[i] = i / 10.0; helib::Ptxt ptxt(context, data); @@ -108,9 +113,9 @@ TEST_P(TestPtxtCKKS, preservesDataPassedIntoConstructor) TEST_P(TestPtxtCKKS, hasSameNumberOfSlotsAsContextWhenCreatedWithData) { - std::vector> data(context.ea->size() - 1); + std::vector> data(context.getEA().size() - 1); helib::Ptxt ptxt(context, data); - EXPECT_EQ(ptxt.size(), context.ea->size()); + EXPECT_EQ(ptxt.size(), context.getEA().size()); } TEST_P(TestPtxtCKKS, replicateValueWhenPassingASingleSlotTypeNumber) @@ -137,7 +142,7 @@ TEST_P(TestPtxtCKKS, replicateValueWhenPassingASingleNonSlotTypeNumber) TEST_P(TestPtxtCKKS, atMethodThrowsOrReturnsCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) data[i] = i / 10.0; helib::Ptxt ptxt(context, data); @@ -156,7 +161,7 @@ TEST_P(TestPtxtCKKS, atMethodThrowsOrReturnsCorrectly) TEST_P(TestPtxtCKKS, padsWithZerosWhenPassingInSmallDataVector) { - std::vector> data(context.ea->size() - 1); + std::vector> data(context.getEA().size() - 1); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i - 1) / 10.0, (i - 1) / 10.0}; } @@ -173,7 +178,7 @@ TEST_P(TestPtxtCKKS, padsWithZerosWhenPassingInSmallDataVector) TEST_P(TestPtxtCKKS, preservesDataPassedIntoConstructorAsDouble) { - std::vector data(context.ea->size() - 1); + std::vector data(context.getEA().size() - 1); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = (i - 1) / 10.0; } @@ -188,255 +193,9 @@ TEST_P(TestPtxtCKKS, preservesDataPassedIntoConstructorAsDouble) } } -TEST_P(TestPtxtCKKS, writesDataCorrectlyToOstream) -{ - std::vector> data(context.ea->size()); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context, data); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::string expected = ss.str(); - std::ostringstream os; - os << ptxt; - - EXPECT_EQ(os.str(), expected); -} - -TEST_P(TestPtxtCKKS, readsDataCorrectlyFromIstream) -{ - std::vector> data(context.ea->size()); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - helib::serialize(ss, *it); - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::istringstream is(ss.str()); - is >> ptxt; - - for (std::size_t i = 0; i < ptxt.size(); ++i) { - EXPECT_NEAR(std::abs(ptxt[i] - data[i]), 0, pre_encryption_epsilon); - } -} - -TEST_P(TestPtxtCKKS, readsSquareBracketsDataCorrectly) -{ - std::vector> data(context.ea->size()); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::istringstream is(ss.str()); - is >> ptxt; - - for (std::size_t i = 0; i < ptxt.size(); ++i) { - EXPECT_NEAR(std::abs(ptxt[i] - data[i]), 0, pre_encryption_epsilon); - } -} - -TEST_P(TestPtxtCKKS, serializeFunctionSerializesStdComplexCorrectly) -{ - // TODO: This test may be removed from the fixture and put as standalone - std::stringstream ss; - std::complex num; - - num = 0.0; - helib::serialize(ss, num); - EXPECT_EQ(ss.str(), "[0, 0]"); - ss.str(""); - - num = 10.3; - helib::serialize(ss, num); - EXPECT_EQ(ss.str(), "[10.3, 0]"); - ss.str(""); - - num = {0, 10.3}; - helib::serialize(ss, num); - EXPECT_EQ(ss.str(), "[0, 10.3]"); - ss.str(""); - - num = {3.3, 16.6}; - helib::serialize(ss, num); - EXPECT_EQ(ss.str(), "[3.3, 16.6]"); - ss.str(""); -} - -TEST_P(TestPtxtCKKS, deserializeFunctionDeserializesStdComplexCorrectly) -{ - // TODO: This test may be removed from the fixture and put as standalone - std::complex num, expected; - std::stringstream ss; - - num = 0.0; - ss << "[1,2,3]"; - expected = 0.0; - EXPECT_THROW(helib::deserialize(ss, num), helib::IOError); - ss.str(""); - - num = 0.0; - ss << "[]"; - expected = 0.0; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); - - num = 0.0; - ss << "[0.0]"; - expected = 0.0; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); - - num = 0.0; - ss << "[0.0,0.0]"; - expected = 0.0; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); - - num = 0.0; - ss << "[5.3,0]"; - expected = 5.3; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); - - num = 0.0; - ss << "[0,8.16]"; - expected = {0.0, 8.16}; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); - - num = 0.0; - ss << "[3.4,9.99]"; - expected = {3.4, 9.99}; - helib::deserialize(ss, num); - EXPECT_NEAR(std::abs(num - expected), 0.0, pre_encryption_epsilon); - ss.str(""); -} - -TEST_P(TestPtxtCKKS, serializeFunctionSerializesCorrectly) -{ - std::vector> data(context.ea->size()); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context, data); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::stringstream serialized_ptxt; - helib::serialize(serialized_ptxt, ptxt); - - EXPECT_EQ(serialized_ptxt.str(), ss.str()); -} - -TEST_P(TestPtxtCKKS, deserializeWorksCorrectly) -{ - std::vector> data(context.ea->size()); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::istringstream is(ss.str()); - is >> ptxt; - - for (std::size_t i = 0; i < ptxt.size(); ++i) { - EXPECT_NEAR(std::abs(ptxt[i] - data[i]), 0, pre_encryption_epsilon); - } -} - -TEST_P(TestPtxtCKKS, deserializeFunctionThrowsIfMoreElementsThanSlots) -{ - std::vector> data(context.ea->size() + 1); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::istringstream is(ss.str()); - EXPECT_THROW(helib::deserialize(is, ptxt), helib::IOError); -} - -TEST_P(TestPtxtCKKS, rightShiftOperatorThrowsIfMoreElementsThanSlots) -{ - std::vector> data(context.ea->size() + 1); - for (std::size_t i = 0; i < data.size(); ++i) { - data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - ss << std::setprecision(std::numeric_limits::digits10); - for (auto it = data.begin(); it != data.end(); it++) { - ss << "[" << it->real() << ", " << it->imag() << "]"; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - std::istringstream is(ss.str()); - EXPECT_THROW(is >> ptxt, helib::IOError); -} - TEST_P(TestPtxtCKKS, deserializeIsInverseOfSerialize) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; } @@ -453,53 +212,14 @@ TEST_P(TestPtxtCKKS, deserializeIsInverseOfSerialize) } } -TEST_P(TestPtxtCKKS, readsManyPtxtsFromStream) -{ - std::vector> data1(context.ea->size()); - std::vector> data2(context.ea->size()); - std::vector> data3(context.ea->size()); - for (std::size_t i = 0; i < data1.size(); ++i) { - data1[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; - data2[i] = data1[i] * 2.0; - data3[i] = data1[i] * 3.5; - } - helib::Ptxt ptxt1(context, data1); - helib::Ptxt ptxt2(context, data2); - helib::Ptxt ptxt3(context, data3); - - std::stringstream ss; - ss << ptxt1 << std::endl; - ss << ptxt2 << std::endl; - ss << ptxt3 << std::endl; - - helib::Ptxt deserialized1(context); - helib::Ptxt deserialized2(context); - helib::Ptxt deserialized3(context); - ss >> deserialized1; - ss >> deserialized2; - ss >> deserialized3; - - for (std::size_t i = 0; i < ptxt1.size(); ++i) { - EXPECT_NEAR(std::abs(ptxt1[i] - deserialized1[i]), - 0, - pre_encryption_epsilon); - EXPECT_NEAR(std::abs(ptxt2[i] - deserialized2[i]), - 0, - pre_encryption_epsilon); - EXPECT_NEAR(std::abs(ptxt3[i] - deserialized3[i]), - 0, - pre_encryption_epsilon); - } -} - TEST_P(TestPtxtCKKS, getSlotReprReturnsData) { - std::vector> data(context.ea->size() - 1); + std::vector> data(context.getEA().size() - 1); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i - 1) / 10.0, (i - 1) / 10.0}; } helib::Ptxt ptxt(context, data); - std::vector> expected_repr(context.ea->size()); + std::vector> expected_repr(context.getEA().size()); for (std::size_t i = 0; i < ptxt.size(); ++i) { expected_repr[i] = i < data.size() ? data[i] : 0; } @@ -508,7 +228,7 @@ TEST_P(TestPtxtCKKS, getSlotReprReturnsData) TEST_P(TestPtxtCKKS, runningSumsWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {i / 1.0, (i * i) / 1.0}; } @@ -516,7 +236,7 @@ TEST_P(TestPtxtCKKS, runningSumsWorksCorrectly) helib::Ptxt ptxt(context, data); ptxt.runningSums(); - std::vector> expected_result(context.ea->size()); + std::vector> expected_result(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) expected_result[i] = {(i * (i + 1)) / 2.0, (i * (i + 1) * (2 * i + 1)) / 6.0}; @@ -526,7 +246,7 @@ TEST_P(TestPtxtCKKS, runningSumsWorksCorrectly) TEST_P(TestPtxtCKKS, totalSumsWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {i / 1.0, (i * i) / 1.0}; } @@ -534,7 +254,7 @@ TEST_P(TestPtxtCKKS, totalSumsWorksCorrectly) helib::Ptxt ptxt(context, data); ptxt.totalSums(); - std::vector> expected_result(context.ea->size()); + std::vector> expected_result(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) expected_result[i] = { ((data.size() - 1) * data.size()) / 2.0, @@ -545,7 +265,7 @@ TEST_P(TestPtxtCKKS, totalSumsWorksCorrectly) TEST_P(TestPtxtCKKS, incrementalProductWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {(i + 1) / 5.0, (i * i + 1) / 10.0}; } @@ -562,7 +282,7 @@ TEST_P(TestPtxtCKKS, incrementalProductWorksCorrectly) TEST_P(TestPtxtCKKS, totalProductWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {(i + 1) / 10.0, (i * i + 1) / 10.0}; } @@ -573,7 +293,7 @@ TEST_P(TestPtxtCKKS, totalProductWorksCorrectly) std::complex product = {1.0, 0.0}; for (std::size_t i = 0; i < data.size(); ++i) product *= data[i]; - std::vector> expected_result(context.ea->size(), + std::vector> expected_result(context.getEA().size(), product); COMPARE_CXDOUBLE_VECS(ptxt.getSlotRepr(), expected_result); @@ -581,7 +301,7 @@ TEST_P(TestPtxtCKKS, totalProductWorksCorrectly) TEST_P(TestPtxtCKKS, innerProductWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {i / 1.0, (i * i) / 1.0}; } @@ -606,7 +326,7 @@ TEST_P(TestPtxtCKKS, innerProductWorksCorrectly) TEST_P(TestPtxtCKKS, mapTo01MapsSlotsCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {i / 1.0, (i * i) / 1.0}; } @@ -615,9 +335,9 @@ TEST_P(TestPtxtCKKS, mapTo01MapsSlotsCorrectly) helib::Ptxt ptxt2(context, data); // Should exist as a free function and a member function ptxt.mapTo01(); - mapTo01(*(context.ea), ptxt2); + mapTo01(context.getEA(), ptxt2); - std::vector> expected_result(context.ea->size()); + std::vector> expected_result(context.getEA().size()); for (std::size_t i = 1; i < data.size(); ++i) { expected_result[i] = {1, 0}; } @@ -628,9 +348,9 @@ TEST_P(TestPtxtCKKS, mapTo01MapsSlotsCorrectly) TEST_P(TestPtxtCKKS, timesEqualsOtherPlaintextWorks) { - std::vector> product_data(context.ea->size(), + std::vector> product_data(context.getEA().size(), {-3.14, -1.0}); - std::vector> multiplier_data(context.ea->size()); + std::vector> multiplier_data(context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data); ++i) { multiplier_data[i] = {(i - 1) / 10.0, (i + 1) / 10.0}; } @@ -650,9 +370,9 @@ TEST_P(TestPtxtCKKS, timesEqualsOtherPlaintextWorks) TEST_P(TestPtxtCKKS, minusEqualsOtherPlaintextWorks) { - std::vector> difference_data(context.ea->size(), + std::vector> difference_data(context.getEA().size(), {2.718, -1.0}); - std::vector> subtrahend_data(context.ea->size()); + std::vector> subtrahend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(subtrahend_data); ++i) { subtrahend_data[i] = {(i - 1) / 10.0, (i + 1) / 10.0}; } @@ -672,7 +392,7 @@ TEST_P(TestPtxtCKKS, minusEqualsOtherPlaintextWorks) TEST_P(TestPtxtCKKS, minusEqualsComplexScalarWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i * i - 1) / 10.0, (i * i + 1) / 10.0}; } @@ -691,7 +411,7 @@ TEST_P(TestPtxtCKKS, minusEqualsComplexScalarWorks) TEST_P(TestPtxtCKKS, minusEqualsNonComplexScalarWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i * i - 1) / 2.0, (i * i + 1) / 5.0}; } @@ -713,13 +433,13 @@ TEST_P(TestPtxtCKKS, minusEqualsNonComplexScalarWorks) TEST_P(TestPtxtCKKS, plusEqualsOtherPlaintextWorks) { - std::vector> augend_data(context.ea->size()); - std::vector> addend_data(context.ea->size()); + std::vector> augend_data(context.getEA().size()); + std::vector> addend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(addend_data); ++i) { augend_data[i] = {i / 10.0, i * i / 10.0}; addend_data[i] = {i / 20.0, i * i / 20.0}; } - std::vector> expected_result(context.ea->size()); + std::vector> expected_result(context.getEA().size()); for (std::size_t i = 0; i < expected_result.size(); ++i) expected_result[i] = augend_data[i] + addend_data[i]; @@ -732,7 +452,7 @@ TEST_P(TestPtxtCKKS, plusEqualsOtherPlaintextWorks) TEST_P(TestPtxtCKKS, plusEqualsComplexScalarWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {-i / 10.0, (3 - i) / 4.0}; } @@ -751,7 +471,7 @@ TEST_P(TestPtxtCKKS, plusEqualsComplexScalarWorks) TEST_P(TestPtxtCKKS, plusEqualsNonComplexScalarWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i + i / 5.0, i - i / 4.0}; } @@ -777,7 +497,7 @@ TEST_P(TestPtxtCKKS, plusEqualsNonComplexScalarWorks) TEST_P(TestPtxtCKKS, timesEqualsScalarWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i * i * i / 100.0, -i / 3.0}; } @@ -803,7 +523,7 @@ TEST_P(TestPtxtCKKS, timesEqualsScalarWorks) TEST_P(TestPtxtCKKS, equalityWithOtherPlaintextWorks) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i * 2.5, (i - 2) * 2.5}; } @@ -815,8 +535,8 @@ TEST_P(TestPtxtCKKS, equalityWithOtherPlaintextWorks) TEST_P(TestPtxtCKKS, notEqualsOperatorWithOtherPlaintextWorks) { - std::vector> data1(context.ea->size()); - std::vector> data2(context.ea->size()); + std::vector> data1(context.getEA().size()); + std::vector> data2(context.getEA().size()); for (long i = 0; i < helib::lsize(data1); ++i) { data1[i] = {(i + 1) * 2.5, -i * 2.5}; // i+1 makes the first element differ from (0,0) @@ -830,7 +550,7 @@ TEST_P(TestPtxtCKKS, notEqualsOperatorWithOtherPlaintextWorks) TEST_P(TestPtxtCKKS, negateNegatesCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const double pi = std::acos(-1); for (long j = 0; j < helib::lsize(data); ++j) { // Spiral with j -> j e^{2*i*pi*j/data.size()} @@ -850,7 +570,7 @@ TEST_P(TestPtxtCKKS, negateNegatesCorrectly) TEST_P(TestPtxtCKKS, addConstantWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) data[i] = {i * 4.5, i / 2.0}; @@ -866,8 +586,8 @@ TEST_P(TestPtxtCKKS, addConstantWorksCorrectly) TEST_P(TestPtxtCKKS, multiplyByMultipliesCorrectly) { - std::vector> product_data(context.ea->size()); - std::vector> multiplier_data(context.ea->size()); + std::vector> product_data(context.getEA().size()); + std::vector> multiplier_data(context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data); ++i) { product_data[i] = {(2 - i) / 10.0, (1 - i) / 10.0}; multiplier_data[i] = {std::exp(i / 100.), std::cos(i) * 12}; @@ -890,9 +610,9 @@ TEST_P(TestPtxtCKKS, multiplyByMultipliesCorrectly) TEST_P(TestPtxtCKKS, multiplyBy2MultipliesCorrectly) { - std::vector> product_data(context.ea->size()); - std::vector> multiplier_data1(context.ea->size()); - std::vector> multiplier_data2(context.ea->size()); + std::vector> product_data(context.getEA().size()); + std::vector> multiplier_data1(context.getEA().size()); + std::vector> multiplier_data2(context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data1); ++i) { product_data[i] = static_cast(i) * std::exp(std::complex{0, static_cast(i)}); @@ -923,7 +643,7 @@ TEST_P(TestPtxtCKKS, multiplyBy2MultipliesCorrectly) TEST_P(TestPtxtCKKS, squareSquaresCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { // Lemniscate of Bernoulli double theta = 2. * std::acos(-1) * i / data.size(); @@ -939,7 +659,7 @@ TEST_P(TestPtxtCKKS, squareSquaresCorrectly) TEST_P(TestPtxtCKKS, cubeCubesCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { // Catenary data[i] = {static_cast(1. * i - data.size() / 2) / data.size(), @@ -955,7 +675,7 @@ TEST_P(TestPtxtCKKS, cubeCubesCorrectly) TEST_P(TestPtxtCKKS, powerCorrectlyRaisesToPowers) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const double pi = std::acos(-1); // Spiral inside the unit disk for (long j = 0; j < helib::lsize(data); ++j) { @@ -994,8 +714,8 @@ TEST_P(TestPtxtCKKS, powerCorrectlyRaisesToPowers) TEST_P(TestPtxtCKKS, shiftShiftsRightCorrectly) { - std::vector> data(context.ea->size()); - std::vector> right_shifted_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> right_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1015,8 +735,8 @@ TEST_P(TestPtxtCKKS, shiftShiftsRightCorrectly) TEST_P(TestPtxtCKKS, shiftShiftsLeftCorrectly) { - std::vector> data(context.ea->size()); - std::vector> left_shifted_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> left_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1036,8 +756,8 @@ TEST_P(TestPtxtCKKS, shiftShiftsLeftCorrectly) TEST_P(TestPtxtCKKS, shift1DShiftsRightCorrectly) { - std::vector> data(context.ea->size()); - std::vector> right_shifted_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> right_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1057,8 +777,8 @@ TEST_P(TestPtxtCKKS, shift1DShiftsRightCorrectly) TEST_P(TestPtxtCKKS, shift1DShiftsLeftCorrectly) { - std::vector> data(context.ea->size()); - std::vector> left_shifted_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> left_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1087,7 +807,7 @@ TEST_P(TestPtxtCKKS, shift1DShiftsLeftCorrectly) // for(long j=0; j<2; ++j) // for(long k=0; k<2; ++k) // indices.push_back(ptxt.coordToIndex({i,j,k})); -// std::vector expected_indices(context.ea->size()); +// std::vector expected_indices(context.getEA().size()); // std::iota(expected_indices.begin(), expected_indices.end(), 0); // EXPECT_EQ(expected_indices, indices); // } @@ -1109,8 +829,8 @@ TEST_P(TestPtxtCKKS, shift1DShiftsLeftCorrectly) TEST_P(TestPtxtCKKS, rotate1DRotatesCorrectly) { - std::vector> data(context.ea->size()); - std::vector> left_rotated_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> left_rotated_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1130,8 +850,8 @@ TEST_P(TestPtxtCKKS, rotate1DRotatesCorrectly) TEST_P(TestPtxtCKKS, rotateRotatesCorrectly) { - std::vector> data(context.ea->size()); - std::vector> left_rotated_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> left_rotated_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1151,8 +871,8 @@ TEST_P(TestPtxtCKKS, rotateRotatesCorrectly) TEST_P(TestPtxtCKKS, automorphWorksCorrectly) { - std::vector> data(context.ea->size()); - std::vector> left_rotated_data(context.ea->size()); + std::vector> data(context.getEA().size()); + std::vector> left_rotated_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -1163,32 +883,32 @@ TEST_P(TestPtxtCKKS, automorphWorksCorrectly) helib::Ptxt ptxt(context, data); helib::Ptxt expected_result(context, data); - long k = context.zMStar.ith_rep(1) ? context.zMStar.ith_rep(1) : 1; + long k = context.getZMStar().ith_rep(1) ? context.getZMStar().ith_rep(1) : 1; ptxt.automorph(k); expected_result.rotate(1); COMPARE_CXDOUBLE_VECS(ptxt, expected_result); - ptxt.automorph(context.zMStar.ith_rep(context.ea->size() - 1)); + ptxt.automorph(context.getZMStar().ith_rep(context.getEA().size() - 1)); expected_result.rotate(-1); COMPARE_CXDOUBLE_VECS(ptxt, expected_result); } TEST_P(TestPtxtCKKS, replicateReplicatesCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i / 10.0, -i / 20.0}; } helib::Ptxt ptxt(context, data); - helib::replicate(*context.ea, ptxt, data.size() - 1); - std::vector> replicated_data(context.ea->size(), + helib::replicate(context.getEA(), ptxt, data.size() - 1); + std::vector> replicated_data(context.getEA().size(), data[data.size() - 1]); COMPARE_CXDOUBLE_VECS(ptxt, replicated_data); } TEST_P(TestPtxtCKKS, replicateAllWorksCorrectly) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i / 10.0, -i / 20.0}; } @@ -1222,7 +942,7 @@ TEST_P(TestPtxtCKKS, randomSetsDataRandomly) TEST_P(TestPtxtCKKS, complexConjCorrectlyConjugates) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const std::complex z{1, -1}; for (long j = 0; j < helib::lsize(data); ++j) { // Line segment starting at 1 - i with gradient 2 @@ -1242,7 +962,7 @@ TEST_P(TestPtxtCKKS, complexConjCorrectlyConjugates) TEST_P(TestPtxtCKKS, extractRealPartIsCorrect) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const std::complex z{1, -1}; for (long j = 0; j < helib::lsize(data); ++j) { // Line segment starting at 1 - i with gradient 2 @@ -1254,14 +974,14 @@ TEST_P(TestPtxtCKKS, extractRealPartIsCorrect) num = std::real(num); helib::Ptxt ptxt(context, data); - context.ea->getCx().extractRealPart(ptxt); + context.getEA().getCx().extractRealPart(ptxt); COMPARE_CXDOUBLE_VECS(ptxt.getSlotRepr(), expected_result); } TEST_P(TestPtxtCKKS, extractImPartIsCorrect) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const std::complex z{1, -1}; for (long j = 0; j < helib::lsize(data); ++j) { // Line segment starting at 1 - i with gradient 2 @@ -1273,14 +993,14 @@ TEST_P(TestPtxtCKKS, extractImPartIsCorrect) num = std::imag(num); helib::Ptxt ptxt(context, data); - context.ea->getCx().extractImPart(ptxt); + context.getEA().getCx().extractImPart(ptxt); COMPARE_CXDOUBLE_VECS(ptxt.getSlotRepr(), expected_result); } TEST_P(TestPtxtCKKS, realExtractsRealPart) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const std::complex z{1, -1}; for (long j = 0; j < helib::lsize(data); ++j) { // Line segment starting at 1 - i with gradient 2 @@ -1299,7 +1019,7 @@ TEST_P(TestPtxtCKKS, realExtractsRealPart) TEST_P(TestPtxtCKKS, imagExtractsImaginaryPart) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); const std::complex z{1, -1}; for (long j = 0; j < helib::lsize(data); ++j) { // Line segment starting at 1 - i with gradient 2 @@ -1318,12 +1038,12 @@ TEST_P(TestPtxtCKKS, imagExtractsImaginaryPart) TEST_P(TestPtxtCKKS, canEncryptAndDecryptComplexPtxtsWithKeys) { - helib::buildModChain(context, 100, 2); + context.buildModChain(100, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i - 3) / 5.0, i + 10.0}; } @@ -1344,12 +1064,12 @@ TEST_P(TestPtxtCKKS, canEncryptAndDecryptComplexPtxtsWithKeys) TEST_P(TestPtxtCKKS, canEncryptAndDecryptRealPtxtsWithKeys) { - helib::buildModChain(context, 100, 2); + context.buildModChain(100, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = (i - 3) / 10.0; } @@ -1373,12 +1093,12 @@ TEST_P(TestPtxtCKKS, canEncryptAndDecryptRealPtxtsWithKeys) TEST_P(TestPtxtCKKS, canEncryptAndDecryptComplexPtxtsWithEa) { - helib::buildModChain(context, 100, 2); + context.buildModChain(100, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {(i - 3) / 10.0, i + 5.0}; } @@ -1399,13 +1119,13 @@ TEST_P(TestPtxtCKKS, canEncryptAndDecryptComplexPtxtsWithEa) TEST_P(TestPtxtCKKS, canEncryptAndDecryptRealPtxtsWithEa) { - helib::buildModChain(context, 100, 2); - const helib::EncryptedArrayCx& ea = context.ea->getCx(); + context.buildModChain(100, 2); + const helib::EncryptedArrayCx& ea = context.getEA().getCx(); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = (i - 3) / 10.0; } @@ -1429,14 +1149,14 @@ TEST_P(TestPtxtCKKS, canEncryptAndDecryptRealPtxtsWithEa) TEST_P(TestPtxtCKKS, plusEqualsWithCiphertextWorks) { - helib::buildModChain(context, 150, 2); + context.buildModChain(150, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the augend, addend is plaintext - std::vector> augend_data(context.ea->size()); - std::vector> addend_data(context.ea->size()); + std::vector> augend_data(context.getEA().size()); + std::vector> addend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(augend_data); ++i) { augend_data[i] = {i / 10.0, -i * i / 63.0}; addend_data[i] = {-i / 20.0, i * i * i * 2.6}; @@ -1462,14 +1182,14 @@ TEST_P(TestPtxtCKKS, plusEqualsWithCiphertextWorks) TEST_P(TestPtxtCKKS, addConstantCKKSWithCiphertextWorks) { - helib::buildModChain(context, 150, 2); + context.buildModChain(150, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the augend, addend is plaintext - std::vector> augend_data(context.ea->size()); - std::vector> addend_data(context.ea->size()); + std::vector> augend_data(context.getEA().size()); + std::vector> addend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(augend_data); ++i) { augend_data[i] = {i / 70.0, -i * 10.5}; addend_data[i] = {-i / 10.0, i * 0.8}; @@ -1495,14 +1215,14 @@ TEST_P(TestPtxtCKKS, addConstantCKKSWithCiphertextWorks) TEST_P(TestPtxtCKKS, minusEqualsWithCiphertextWorks) { - helib::buildModChain(context, 150, 2); + context.buildModChain(150, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the minuend, subtrahend is plaintext - std::vector> minuend_data(context.ea->size()); - std::vector> subtrahend_data(context.ea->size()); + std::vector> minuend_data(context.getEA().size()); + std::vector> subtrahend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(minuend_data); ++i) { minuend_data[i] = {i * i / 30.0, i * i / 4.5}; subtrahend_data[i] = {(i + 3) / 4.0, -i * i / 1.3}; @@ -1528,14 +1248,14 @@ TEST_P(TestPtxtCKKS, minusEqualsWithCiphertextWorks) TEST_P(TestPtxtCKKS, multByConstantCKKSFromCiphertextWorks) { - helib::buildModChain(context, 150, 2); + context.buildModChain(150, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the multiplier, multiplicand is plaintext - std::vector> multiplier_data(context.ea->size()); - std::vector> multiplicand_data(context.ea->size()); + std::vector> multiplier_data(context.getEA().size()); + std::vector> multiplicand_data(context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data); ++i) { multiplier_data[i] = {i * 4.5, -i * i / 12.5}; multiplicand_data[i] = {(i - 2.5) / 3.5, i * 4.2}; @@ -1562,14 +1282,14 @@ TEST_P(TestPtxtCKKS, multByConstantCKKSFromCiphertextWorks) TEST_P(TestPtxtCKKS, timesEqualsFromCiphertextWorks) { - helib::buildModChain(context, 150, 2); + context.buildModChain(150, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the multiplier, multiplicand is plaintext - std::vector> multiplier_data(context.ea->size()); - std::vector> multiplicand_data(context.ea->size()); + std::vector> multiplier_data(context.getEA().size()); + std::vector> multiplicand_data(context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data); ++i) { multiplier_data[i] = {i * 4.5, -i * i / 3.3}; multiplicand_data[i] = {(i - 2.5) / 3.5, i * i / 12.4}; @@ -1596,9 +1316,9 @@ TEST_P(TestPtxtCKKS, timesEqualsFromCiphertextWorks) TEST_P(TestPtxtCKKS, plusOperatorWithOtherPtxtWorks) { - std::vector> augend_data(context.ea->size()); - std::vector> addend_data(context.ea->size()); - std::vector> expected_sum_data(context.ea->size()); + std::vector> augend_data(context.getEA().size()); + std::vector> addend_data(context.getEA().size()); + std::vector> expected_sum_data(context.getEA().size()); for (long i = 0; i < helib::lsize(augend_data); ++i) { augend_data[i] = {i / 10.0, -i * i / 3.0}; addend_data[i] = {-i / 20.0, i * i * i * 42.6}; @@ -1615,9 +1335,9 @@ TEST_P(TestPtxtCKKS, plusOperatorWithOtherPtxtWorks) TEST_P(TestPtxtCKKS, minusOperatorWithOtherPtxtWorks) { - std::vector> minuend_data(context.ea->size()); - std::vector> subtrahend_data(context.ea->size()); - std::vector> expected_diff_data(context.ea->size()); + std::vector> minuend_data(context.getEA().size()); + std::vector> subtrahend_data(context.getEA().size()); + std::vector> expected_diff_data(context.getEA().size()); for (long i = 0; i < helib::lsize(minuend_data); ++i) { minuend_data[i] = {i / 10.0, -i * i / 3.0}; subtrahend_data[i] = {-i / 20.0, i * i * i * 42.6}; @@ -1634,9 +1354,10 @@ TEST_P(TestPtxtCKKS, minusOperatorWithOtherPtxtWorks) TEST_P(TestPtxtCKKS, timesOperatorWithOtherPtxtWorks) { - std::vector> multiplier_data(context.ea->size()); - std::vector> multiplicand_data(context.ea->size()); - std::vector> expected_product_data(context.ea->size()); + std::vector> multiplier_data(context.getEA().size()); + std::vector> multiplicand_data(context.getEA().size()); + std::vector> expected_product_data( + context.getEA().size()); for (long i = 0; i < helib::lsize(multiplier_data); ++i) { multiplier_data[i] = {i / 10.0, -i * i / 3.0}; multiplicand_data[i] = {-i / 20.0, i * i * i * 42.6}; @@ -1659,7 +1380,12 @@ class TestPtxtBGV : public ::testing::TestWithParam p(GetParam().p), r(GetParam().r), ppowr(power(p, r)), - context(m, p, r) + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .buildModChain(false) + .build()) {} static long power(long base, unsigned long exponent) @@ -1707,7 +1433,7 @@ TEST_P(TestPtxtBGV, reportsWhetherItIsValid) TEST_P(TestPtxtBGV, preservesLongDataPassedIntoConstructor) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); EXPECT_EQ(ptxt.size(), data.size()); @@ -1718,7 +1444,7 @@ TEST_P(TestPtxtBGV, preservesLongDataPassedIntoConstructor) TEST_P(TestPtxtBGV, preservesCoefficientVectorDataPassedIntoConstructor) { - std::vector> data(context.ea->size()); + std::vector> data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {1}; } @@ -1731,7 +1457,7 @@ TEST_P(TestPtxtBGV, preservesCoefficientVectorDataPassedIntoConstructor) TEST_P(TestPtxtBGV, preservesZzxDataPassedIntoConstructor) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); EXPECT_EQ(ptxt.size(), data.size()); @@ -1740,62 +1466,10 @@ TEST_P(TestPtxtBGV, preservesZzxDataPassedIntoConstructor) } } -TEST_P(TestPtxtBGV, writesDataCorrectlyToOstream) -{ - const long p2r = context.slotRing->p2r; - const long d = context.zMStar.getOrdP(); - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); - std::stringstream ss; - ss << "["; - for (long i = 0; i < helib::lsize(data); ++i) { - NTL::ZZX input; - NTL::SetCoeff(input, 0, i % p2r); - if (d != 1) { - NTL::SetCoeff(input, 1, (i + 2) % p2r); - } - data[i] = input; - // Serialisation of data[i] (i.e. PolyMod) is tested in `TestPolyMod.cpp` - ss << data[i] << (i != helib::lsize(data) - 1 ? ", " : ""); - } - ss << "]"; - helib::Ptxt ptxt(context, data); - std::string expected = ss.str(); - std::ostringstream os; - os << ptxt; - - EXPECT_EQ(os.str(), expected); -} - -TEST_P(TestPtxtBGV, readsDataCorrectlyFromIstream) -{ - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); - for (long i = 0; i < helib::lsize(data); ++i) { - data[i] = {i, i + 2}; - } - helib::Ptxt ptxt(context); - std::stringstream ss; - ss << "["; - for (auto it = data.begin(); it != data.end(); it++) { - ss << *it; - if (it != data.end() - 1) { - ss << ", "; - } - } - ss << "]"; - - ss >> ptxt; - - for (std::size_t i = 0; i < ptxt.size(); ++i) { - EXPECT_EQ(ptxt[i], data[i]); - } -} - TEST_P(TestPtxtBGV, deserializeIsInverseOfSerialize) { - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); for (long i = 0; i < helib::lsize(data); ++i) { data[i] = {i, i + 2}; } @@ -1810,130 +1484,10 @@ TEST_P(TestPtxtBGV, deserializeIsInverseOfSerialize) EXPECT_EQ(ptxt, deserialized); } -TEST_P(TestPtxtBGV, serializeFunctionSerializesCorrectly) -{ - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); - std::stringstream ptxt_string_stream; - ptxt_string_stream << "["; - for (long i = 0; i < helib::lsize(data); ++i) { - data[i] = 2 * i; - ptxt_string_stream << "[" << helib::mcMod(2 * i, ppowr) << "]"; - if (i < helib::lsize(data) - 1) - ptxt_string_stream << ", "; - } - ptxt_string_stream << "]"; - helib::Ptxt ptxt(context, data); - - std::stringstream ss; - helib::serialize(ss, ptxt); - - EXPECT_EQ(ss.str(), ptxt_string_stream.str()); -} - -TEST_P(TestPtxtBGV, deserializeFunctionDeserializesCorrectly) -{ - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); - std::stringstream ptxt_string_stream; - ptxt_string_stream << "["; - for (long i = 0; i < helib::lsize(data); ++i) { - NTL::ZZX tmp; - ptxt_string_stream << "["; - for (long j = 0; j < context.zMStar.getOrdP(); ++j) { - NTL::SetCoeff(tmp, j, j * j); - ptxt_string_stream << j * j; - if (j < context.zMStar.getOrdP() - 1) - ptxt_string_stream << ","; - } - data[i] = tmp; - ptxt_string_stream << "]"; - if (i < helib::lsize(data) - 1) - ptxt_string_stream << ", "; - } - ptxt_string_stream << "]"; - helib::Ptxt ptxt(context, data); - - helib::Ptxt deserialized_ptxt(context); - helib::deserialize(ptxt_string_stream, deserialized_ptxt); - - EXPECT_EQ(ptxt, deserialized_ptxt); -} - -TEST_P(TestPtxtBGV, deserializeFunctionThrowsIfMoreElementsThanSlots) -{ - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size() + 1, poly); - std::stringstream ptxt_string_stream; - ptxt_string_stream << "["; - for (long i = 0; i < helib::lsize(data); ++i) { - data[i] = {i, i * i}; - ptxt_string_stream << "[" << i << ", " << i * i << "]"; - if (i < helib::lsize(data) - 1) - ptxt_string_stream << ", "; - } - ptxt_string_stream << "]"; - - helib::Ptxt deserialized_ptxt(context); - - EXPECT_THROW(helib::deserialize(ptxt_string_stream, deserialized_ptxt), - helib::IOError); -} - -TEST_P(TestPtxtBGV, rightShiftOperatorThrowsIfMoreElementsThanSlots) -{ - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size() + 1, poly); - std::stringstream ptxt_string_stream; - ptxt_string_stream << "["; - for (long i = 0; i < helib::lsize(data); ++i) { - data[i] = {i, i * i}; - ptxt_string_stream << "[" << i << ", " << i * i << "]"; - if (i < helib::lsize(data) - 1) - ptxt_string_stream << ", "; - } - ptxt_string_stream << "]"; - - helib::Ptxt deserialized_ptxt(context); - EXPECT_THROW(ptxt_string_stream >> deserialized_ptxt, helib::IOError); -} - -TEST_P(TestPtxtBGV, readsManyPtxtsFromStream) -{ - helib::PolyMod poly(context.slotRing); - std::vector data1(context.ea->size(), poly); - std::vector data2(context.ea->size(), poly); - std::vector data3(context.ea->size(), poly); - for (long i = 0; i < helib::lsize(data1); ++i) { - data1[i] = {i, i + 2}; - data2[i] = {2 * i, 2 * (i + 2)}; - data3[i] = {3 * i, 3 * (i + 2)}; - } - helib::Ptxt ptxt1(context, data1); - helib::Ptxt ptxt2(context, data2); - helib::Ptxt ptxt3(context, data3); - - std::stringstream ss; - ss << ptxt1 << std::endl; - ss << ptxt2 << std::endl; - ss << ptxt3 << std::endl; - - helib::Ptxt deserialized1(context); - helib::Ptxt deserialized2(context); - helib::Ptxt deserialized3(context); - ss >> deserialized1; - ss >> deserialized2; - ss >> deserialized3; - - EXPECT_EQ(ptxt1, deserialized1); - EXPECT_EQ(ptxt2, deserialized2); - EXPECT_EQ(ptxt3, deserialized3); -} - TEST_P(TestPtxtBGV, preservesPolyModDataPassedIntoConstructor) { - helib::PolyMod poly(context.slotRing); - std::vector data(context.ea->size(), poly); + helib::PolyMod poly(context.getSlotRing()); + std::vector data(context.getEA().size(), poly); helib::Ptxt ptxt(context, data); EXPECT_EQ(ptxt.size(), data.size()); for (std::size_t i = 0; i < data.size(); ++i) { @@ -1943,9 +1497,9 @@ TEST_P(TestPtxtBGV, preservesPolyModDataPassedIntoConstructor) TEST_P(TestPtxtBGV, throwsIfp2rAndGDoNotMatchThoseFromContext) { - NTL::ZZX G = context.slotRing->G; - long p = context.slotRing->p; - long r = context.slotRing->r; + NTL::ZZX G = context.getSlotRing()->G; + long p = context.getSlotRing()->p; + long r = context.getSlotRing()->r; // Non-matching p^r std::shared_ptr badPolyModRing1( new helib::PolyModRing(p + 1, r, G)); @@ -1959,7 +1513,7 @@ TEST_P(TestPtxtBGV, throwsIfp2rAndGDoNotMatchThoseFromContext) new helib::PolyModRing(p, r, G)); helib::PolyMod goodPolyMod(goodPolyModRing); - std::vector data(context.ea->size(), goodPolyMod); + std::vector data(context.getEA().size(), goodPolyMod); // Make all of them good except 1, make sure it still notices data.back() = badPolyMod1; @@ -1978,21 +1532,21 @@ TEST_P(TestPtxtBGV, throwsIfp2rAndGDoNotMatchThoseFromContext) TEST_P(TestPtxtBGV, lsizeReportsCorrectSize) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); helib::Ptxt ptxt(context, data); EXPECT_EQ(ptxt.lsize(), data.size()); } TEST_P(TestPtxtBGV, sizeReportsCorrectSize) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); helib::Ptxt ptxt(context, data); EXPECT_EQ(ptxt.size(), data.size()); } TEST_P(TestPtxtBGV, padsWithZerosWhenPassingInSmallDataVector) { - std::vector data(context.ea->size() - 1); + std::vector data(context.getEA().size() - 1); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); for (std::size_t i = 0; i < data.size(); ++i) { @@ -2006,7 +1560,7 @@ TEST_P(TestPtxtBGV, padsWithZerosWhenPassingInSmallDataVector) TEST_P(TestPtxtBGV, hasSameNumberOfSlotsAsContext) { helib::Ptxt ptxt(context); - EXPECT_EQ(context.ea->size(), ptxt.size()); + EXPECT_EQ(context.getEA().size(), ptxt.size()); } TEST_P(TestPtxtBGV, randomSetsDataRandomly) @@ -2029,7 +1583,7 @@ TEST_P(TestPtxtBGV, randomSetsDataRandomly) TEST_P(TestPtxtBGV, runningSumsWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 1); std::vector expected_result(data.size()); for (std::size_t i = 0; i < data.size(); ++i) @@ -2045,7 +1599,7 @@ TEST_P(TestPtxtBGV, runningSumsWorksCorrectly) TEST_P(TestPtxtBGV, totalSumsWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 1); std::vector expected_result(data.size()); for (std::size_t i = 0; i < data.size(); ++i) @@ -2061,12 +1615,12 @@ TEST_P(TestPtxtBGV, totalSumsWorksCorrectly) TEST_P(TestPtxtBGV, incrementalProductWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 1); std::vector expected_result(data); for (std::size_t i = 1; i < data.size(); ++i) - expected_result[i] = - (expected_result[i] * expected_result[i - 1]) % context.slotRing->p2r; + expected_result[i] = (expected_result[i] * expected_result[i - 1]) % + context.getSlotRing()->p2r; helib::Ptxt ptxt(context, data); ptxt.incrementalProduct(); @@ -2078,12 +1632,12 @@ TEST_P(TestPtxtBGV, incrementalProductWorksCorrectly) TEST_P(TestPtxtBGV, totalProductWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 1); long product = 1; for (std::size_t i = 0; i < data.size(); ++i) { product *= data[i]; - product %= context.slotRing->p2r; + product %= context.getSlotRing()->p2r; } std::vector expected_result(data.size(), product); @@ -2097,7 +1651,7 @@ TEST_P(TestPtxtBGV, totalProductWorksCorrectly) TEST_P(TestPtxtBGV, innerProductWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); std::vector> first_ptxt_vector(4, ptxt); @@ -2119,7 +1673,7 @@ TEST_P(TestPtxtBGV, innerProductWorksCorrectly) TEST_P(TestPtxtBGV, mapTo01MapsSlotsCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); std::vector expected_result(data.size(), 1); for (std::size_t i = 0; i < data.size(); ++i) @@ -2130,7 +1684,7 @@ TEST_P(TestPtxtBGV, mapTo01MapsSlotsCorrectly) helib::Ptxt ptxt(context, data); helib::Ptxt ptxt2(context, data); ptxt.mapTo01(); - mapTo01(*(context.ea), ptxt2); + mapTo01(context.getEA(), ptxt2); for (std::size_t i = 0; i < ptxt.size(); ++i) { EXPECT_EQ(ptxt[i], expected_result[i]); @@ -2140,10 +1694,15 @@ TEST_P(TestPtxtBGV, mapTo01MapsSlotsCorrectly) TEST(TestPtxtBGV, automorphWorksCorrectly) { - std::vector gens = {11, 2}; - std::vector ords = {6, 2}; - const helib::Context context(45, 19, 1, gens, ords); - std::vector data(context.ea->size()); + const helib::Context context = helib::ContextBuilder() + .m(45) + .p(19) + .r(1) + .gens({11, 2}) + .ords({6, 2}) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { NTL::SetX(data[i]); (data[i] += 1) *= i; @@ -2173,11 +1732,11 @@ TEST(TestPtxtBGV, automorphWorksCorrectly) TEST_P(TestPtxtBGV, frobeniusAutomorphWithConstantsWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); std::vector expected_result(data); helib::Ptxt ptxt(context, data); - for (long i = 0; i <= context.zMStar.getOrdP(); ++i) { + for (long i = 0; i <= context.getOrdP(); ++i) { auto ptxtUnderTest = ptxt; ptxtUnderTest.frobeniusAutomorph(i); for (std::size_t j = 0; j < ptxtUnderTest.size(); ++j) { @@ -2189,8 +1748,13 @@ TEST_P(TestPtxtBGV, frobeniusAutomorphWithConstantsWorksCorrectly) TEST(TestPtxtBGV, frobeniusAutomorphWithPolynomialsWorksCorrectly) { - const helib::Context context(45, 19, 1); - std::vector data(context.ea->size()); + const helib::Context context = helib::ContextBuilder() + .m(45) + .p(19) + .r(1) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) { NTL::SetX(data[i]); (data[i] += 1) *= i; @@ -2220,8 +1784,8 @@ TEST(TestPtxtBGV, frobeniusAutomorphWithPolynomialsWorksCorrectly) TEST_P(TestPtxtBGV, timesEqualsOtherPlaintextWorks) { - std::vector product_data(context.ea->size(), 3); - std::vector multiplier_data(context.ea->size()); + std::vector product_data(context.getEA().size(), 3); + std::vector multiplier_data(context.getEA().size()); std::iota(multiplier_data.begin(), multiplier_data.end(), 0); std::vector expected_result(product_data); @@ -2241,8 +1805,8 @@ TEST_P(TestPtxtBGV, timesEqualsOtherPlaintextWorks) TEST_P(TestPtxtBGV, minusEqualsOtherPlaintextWorks) { - std::vector difference_data(context.ea->size(), 1); - std::vector subtrahend_data(context.ea->size()); + std::vector difference_data(context.getEA().size(), 1); + std::vector subtrahend_data(context.getEA().size()); std::iota(subtrahend_data.begin(), subtrahend_data.end(), 0); std::vector expected_result(difference_data); @@ -2262,7 +1826,7 @@ TEST_P(TestPtxtBGV, minusEqualsOtherPlaintextWorks) TEST_P(TestPtxtBGV, minusEqualsScalarWorks) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); const long scalar = 3; @@ -2281,12 +1845,12 @@ TEST_P(TestPtxtBGV, minusEqualsScalarWorks) TEST_P(TestPtxtBGV, plusEqualsOtherPlaintextWorks) { - std::vector augend_data(context.ea->size()); + std::vector augend_data(context.getEA().size()); std::iota(augend_data.begin(), augend_data.end(), 0); - std::vector addend_data(context.ea->size()); + std::vector addend_data(context.getEA().size()); for (long i = 0; i < helib::lsize(addend_data); ++i) addend_data[i] = helib::mcMod(2 * i + 1, p); - std::vector expected_result(context.ea->size()); + std::vector expected_result(context.getEA().size()); for (long i = 0; i < helib::lsize(expected_result); ++i) expected_result[i] = augend_data[i] + addend_data[i]; @@ -2301,7 +1865,7 @@ TEST_P(TestPtxtBGV, plusEqualsOtherPlaintextWorks) TEST_P(TestPtxtBGV, plusEqualsScalarWorks) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); const long scalar = 3; @@ -2320,7 +1884,7 @@ TEST_P(TestPtxtBGV, plusEqualsScalarWorks) TEST_P(TestPtxtBGV, timesEqualsScalarWorks) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); const long scalar = 3; @@ -2339,7 +1903,7 @@ TEST_P(TestPtxtBGV, timesEqualsScalarWorks) TEST_P(TestPtxtBGV, equalityWithOtherPlaintextWorks) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt1(context, data); @@ -2349,9 +1913,9 @@ TEST_P(TestPtxtBGV, equalityWithOtherPlaintextWorks) TEST_P(TestPtxtBGV, notEqualsOperatorWithOtherPlaintextWorks) { - std::vector data1(context.ea->size()); + std::vector data1(context.getEA().size()); std::iota(data1.begin(), data1.end(), 0); - std::vector data2(context.ea->size()); + std::vector data2(context.getEA().size()); std::iota(data2.begin(), data2.end(), 1); helib::Ptxt ptxt1(context, data1); @@ -2361,7 +1925,7 @@ TEST_P(TestPtxtBGV, notEqualsOperatorWithOtherPlaintextWorks) TEST_P(TestPtxtBGV, negateNegatesCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); std::vector expected_result(data); @@ -2382,8 +1946,8 @@ TEST_P(TestPtxtBGV, addConstantWorksCorrectly) NTL::SetCoeff(input, 0, 2); NTL::SetCoeff(input, 1, 1); - helib::PolyMod poly(input, context.slotRing); - std::vector data(context.ea->size()); + helib::PolyMod poly(input, context.getSlotRing()); + std::vector data(context.getEA().size()); for (std::size_t i = 0; i < data.size(); ++i) data[i] = poly + i; @@ -2401,8 +1965,8 @@ TEST_P(TestPtxtBGV, addConstantWorksCorrectly) TEST_P(TestPtxtBGV, multiplyByMultipliesCorrectly) { - std::vector product_data(context.ea->size(), 3); - std::vector multiplier_data(context.ea->size()); + std::vector product_data(context.getEA().size(), 3); + std::vector multiplier_data(context.getEA().size()); std::iota(multiplier_data.begin(), multiplier_data.end(), 0); std::vector expected_result(product_data); @@ -2422,9 +1986,9 @@ TEST_P(TestPtxtBGV, multiplyByMultipliesCorrectly) TEST_P(TestPtxtBGV, multiplyBy2MultipliesCorrectly) { - std::vector product_data(context.ea->size(), 3); - std::vector multiplier_data1(context.ea->size()); - std::vector multiplier_data2(context.ea->size()); + std::vector product_data(context.getEA().size(), 3); + std::vector multiplier_data1(context.getEA().size()); + std::vector multiplier_data2(context.getEA().size()); std::iota(multiplier_data1.begin(), multiplier_data1.end(), 0); std::iota(multiplier_data2.begin(), multiplier_data2.end(), 0); @@ -2447,7 +2011,7 @@ TEST_P(TestPtxtBGV, multiplyBy2MultipliesCorrectly) TEST_P(TestPtxtBGV, squareSquaresCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); std::vector expected_result(data); for (auto& num : expected_result) @@ -2461,7 +2025,7 @@ TEST_P(TestPtxtBGV, squareSquaresCorrectly) TEST_P(TestPtxtBGV, cubeCubesCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); std::vector expected_result(data); for (auto& num : expected_result) @@ -2475,10 +2039,10 @@ TEST_P(TestPtxtBGV, cubeCubesCorrectly) TEST_P(TestPtxtBGV, powerCorrectlyRaisesToPowers) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), - -(static_cast(context.ea->size()) / 2)); + -(static_cast(context.getEA().size()) / 2)); std::vector exponents{1, 3, 4, 5, 300}; const auto naive_powermod = @@ -2510,8 +2074,8 @@ TEST_P(TestPtxtBGV, powerCorrectlyRaisesToPowers) TEST_P(TestPtxtBGV, shiftShiftsRightCorrectly) { - std::vector data(context.ea->size()); - std::vector right_shifted_data(context.ea->size()); + std::vector data(context.getEA().size()); + std::vector right_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -2531,8 +2095,8 @@ TEST_P(TestPtxtBGV, shiftShiftsRightCorrectly) TEST_P(TestPtxtBGV, shiftShiftsLeftCorrectly) { - std::vector data(context.ea->size()); - std::vector left_shifted_data(context.ea->size()); + std::vector data(context.getEA().size()); + std::vector left_shifted_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -2553,9 +2117,14 @@ TEST_P(TestPtxtBGV, shiftShiftsLeftCorrectly) TEST(TestPtxtBGV, shift1DShiftsRightCorrectly) { long amount = 1; - const helib::Context context(45, 19, 1); - std::vector data(context.ea->size()); - std::vector right_shifted_data(context.ea->size()); + const helib::Context context = helib::ContextBuilder() + .m(45) + .p(19) + .r(1) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size()); + std::vector right_shifted_data(context.getEA().size()); const auto shift_first_dim = [](long amount, std::vector& data) { std::vector new_data(data.size(), 0l); for (long i = 0; i < helib::lsize(data); ++i) @@ -2614,9 +2183,14 @@ TEST(TestPtxtBGV, shift1DShiftsRightCorrectly) TEST(TestPtxtBGV, shift1DShiftsLeftCorrectly) { long amount = -1; - const helib::Context context(45, 19, 1); - std::vector data(context.ea->size()); - std::vector right_shifted_data(context.ea->size()); + const helib::Context context = helib::ContextBuilder() + .m(45) + .p(19) + .r(1) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size()); + std::vector right_shifted_data(context.getEA().size()); const auto shift_first_dim = [](long amount, std::vector& data) { std::vector new_data(data.size(), 0l); for (long i = 0; i < helib::lsize(data); ++i) @@ -2675,9 +2249,14 @@ TEST(TestPtxtBGV, shift1DShiftsLeftCorrectly) TEST(TestPtxtBGV, rotate1DRotatesCorrectly) { long amount = 1; - const helib::Context context(45, 19, 1); - std::vector data(context.ea->size()); - std::vector left_rotated_data(context.ea->size()); + const helib::Context context = helib::ContextBuilder() + .m(45) + .p(19) + .r(1) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size()); + std::vector left_rotated_data(context.getEA().size()); const auto rotate_first_dim = [](long amount, std::vector& data) { amount = helib::mcMod(amount, 12); std::vector new_data(data); @@ -2730,8 +2309,8 @@ TEST(TestPtxtBGV, rotate1DRotatesCorrectly) TEST_P(TestPtxtBGV, rotateRotatesCorrectly) { - std::vector data(context.ea->size()); - std::vector left_rotated_data(context.ea->size()); + std::vector data(context.getEA().size()); + std::vector left_rotated_data(context.getEA().size()); const auto non_neg_mod = [](int x, int mod) { return ((x % mod) + mod) % mod; }; @@ -2754,11 +2333,12 @@ TEST_P(TestPtxtBGV, rotateRotatesCorrectly) TEST_P(TestPtxtBGV, replicateReplicatesCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); - helib::replicate(*context.ea, ptxt, data.size() - 1); - std::vector replicated_data(context.ea->size(), data[data.size() - 1]); + helib::replicate(context.getEA(), ptxt, data.size() - 1); + std::vector replicated_data(context.getEA().size(), + data[data.size() - 1]); for (std::size_t i = 0; i < ptxt.size(); ++i) { EXPECT_EQ(ptxt[i], replicated_data[i]); } @@ -2766,7 +2346,7 @@ TEST_P(TestPtxtBGV, replicateReplicatesCorrectly) TEST_P(TestPtxtBGV, replicateAllWorksCorrectly) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt ptxt(context, data); std::vector> replicated_ptxts = ptxt.replicateAll(); @@ -2779,9 +2359,9 @@ TEST_P(TestPtxtBGV, replicateAllWorksCorrectly) TEST_P(TestPtxtBGV, clearZeroesAllSlots) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); - std::vector expected_result(context.ea->size(), 0); + std::vector expected_result(context.getEA().size(), 0); helib::Ptxt ptxt(context, data); ptxt.clear(); for (std::size_t i = 0; i < ptxt.size(); ++i) { @@ -2817,7 +2397,7 @@ TEST_P(TestPtxtBGV, defaultConstructedPtxtThrowsWhenOperatedOn) TEST_P(TestPtxtBGV, defaultConstructedContextCannotBeRightOperand) { - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt valid_ptxt(context, data); helib::Ptxt invalid_ptxt; @@ -2834,8 +2414,13 @@ TEST_P(TestPtxtBGV, defaultConstructedContextCannotBeRightOperand) TEST_P(TestPtxtBGV, cannotOperateBetweenPtxtsWithDifferentContexts) { - helib::Context different_context(m, p, 2 * r); - std::vector data(context.ea->size(), 1); + helib::Context different_context = helib::ContextBuilder() + .m(m) + .p(p) + .r(2 * r) + .buildModChain(false) + .build(); + std::vector data(context.getEA().size(), 1); helib::Ptxt ptxt1(context, data); helib::Ptxt ptxt2(different_context, data); EXPECT_THROW(ptxt1 *= ptxt2, helib::LogicError); @@ -2862,14 +2447,15 @@ TEST_P(TestPtxtBGV, preservesDataPassedAsZZX) TEST_P(TestPtxtBGV, setDataWorksWithZZXSameOrderAsPhiMX) { NTL::ZZX phi_mx; - switch (context.alMod.getTag()) { + switch (context.getAlMod().getTag()) { case helib::PA_GF2_tag: phi_mx = NTL::conv( - context.alMod.getDerived(helib::PA_GF2()).getPhimXMod()); + context.getAlMod().getDerived(helib::PA_GF2()).getPhimXMod()); break; case helib::PA_zz_p_tag: - helib::convert(phi_mx, - context.alMod.getDerived(helib::PA_zz_p()).getPhimXMod()); + helib::convert( + phi_mx, + context.getAlMod().getDerived(helib::PA_zz_p()).getPhimXMod()); break; case helib::PA_cx_tag: // CKKS: do nothing @@ -2895,7 +2481,7 @@ TEST_P(TestPtxtBGV, decodeSetDataWorks) SetCoeff(input_polynomial, 1, 1); std::vector test_decoded; - context.ea->decode(test_decoded, input_polynomial); + context.getEA().decode(test_decoded, input_polynomial); helib::Ptxt ptxt(context); @@ -2909,14 +2495,15 @@ TEST_P(TestPtxtBGV, decodeSetDataWorks) TEST_P(TestPtxtBGV, decodeSetDataWorksWithZZXSameOrderAsPhiMX) { NTL::ZZX phi_mx; - switch (context.alMod.getTag()) { + switch (context.getAlMod().getTag()) { case helib::PA_GF2_tag: phi_mx = NTL::conv( - context.alMod.getDerived(helib::PA_GF2()).getPhimXMod()); + context.getAlMod().getDerived(helib::PA_GF2()).getPhimXMod()); break; case helib::PA_zz_p_tag: - helib::convert(phi_mx, - context.alMod.getDerived(helib::PA_zz_p()).getPhimXMod()); + helib::convert( + phi_mx, + context.getAlMod().getDerived(helib::PA_zz_p()).getPhimXMod()); break; case helib::PA_cx_tag: // CKKS: do nothing @@ -2930,7 +2517,7 @@ TEST_P(TestPtxtBGV, decodeSetDataWorksWithZZXSameOrderAsPhiMX) helib::Ptxt ptxt(context, input_polynomial); std::vector test_decoded; - context.ea->decode(test_decoded, input_polynomial); + context.getEA().decode(test_decoded, input_polynomial); for (std::size_t i = 0; i < ptxt.size(); ++i) { EXPECT_EQ(ptxt[i], test_decoded[i]); @@ -2939,12 +2526,12 @@ TEST_P(TestPtxtBGV, decodeSetDataWorksWithZZXSameOrderAsPhiMX) TEST_P(TestPtxtBGV, canEncryptAndDecryptPtxts) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); - std::vector data(context.ea->size()); + std::vector data(context.getEA().size()); std::iota(data.begin(), data.end(), 0); helib::Ptxt pre_encryption(context, data); helib::Ctxt ctxt(public_key); @@ -2958,14 +2545,14 @@ TEST_P(TestPtxtBGV, canEncryptAndDecryptPtxts) TEST_P(TestPtxtBGV, plusEqualsWithCiphertextWorks) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the augend, addend is plaintext - std::vector augend_data(context.ea->size()); - std::vector addend_data(context.ea->size()); + std::vector augend_data(context.getEA().size()); + std::vector addend_data(context.getEA().size()); std::iota(augend_data.begin(), augend_data.end(), 0); std::iota(addend_data.begin(), addend_data.end(), 7); helib::Ptxt augend_ptxt(context, augend_data); @@ -2986,14 +2573,14 @@ TEST_P(TestPtxtBGV, plusEqualsWithCiphertextWorks) TEST_P(TestPtxtBGV, addConstantFromCiphertextWorks) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the augend, addend is plaintext - std::vector augend_data(context.ea->size()); - std::vector addend_data(context.ea->size()); + std::vector augend_data(context.getEA().size()); + std::vector addend_data(context.getEA().size()); std::iota(augend_data.begin(), augend_data.end(), 0); std::iota(addend_data.begin(), addend_data.end(), 7); helib::Ptxt augend_ptxt(context, augend_data); @@ -3014,14 +2601,14 @@ TEST_P(TestPtxtBGV, addConstantFromCiphertextWorks) TEST_P(TestPtxtBGV, minusEqualsWithCiphertextWorks) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the minuend, subtrahend is plaintext - std::vector minuend_data(context.ea->size()); - std::vector subtrahend_data(context.ea->size()); + std::vector minuend_data(context.getEA().size()); + std::vector subtrahend_data(context.getEA().size()); std::iota(minuend_data.begin(), minuend_data.end(), 0); std::iota(subtrahend_data.begin(), subtrahend_data.end(), 7); helib::Ptxt minuend_ptxt(context, minuend_data); @@ -3042,14 +2629,14 @@ TEST_P(TestPtxtBGV, minusEqualsWithCiphertextWorks) TEST_P(TestPtxtBGV, timesEqualsWithCiphertextWorks) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the multiplier, multiplicand is plaintext - std::vector multiplier_data(context.ea->size()); - std::vector multiplicand_data(context.ea->size()); + std::vector multiplier_data(context.getEA().size()); + std::vector multiplicand_data(context.getEA().size()); std::iota(multiplier_data.begin(), multiplier_data.end(), 0); std::iota(multiplicand_data.begin(), multiplicand_data.end(), 7); helib::Ptxt multiplier_ptxt(context, multiplier_data); @@ -3070,14 +2657,14 @@ TEST_P(TestPtxtBGV, timesEqualsWithCiphertextWorks) TEST_P(TestPtxtBGV, multByConstantFromCiphertextWorks) { - helib::buildModChain(context, 30, 2); + context.buildModChain(30, 2); helib::SecKey secret_key(context); secret_key.GenSecKey(); const helib::PubKey& public_key(secret_key); // Encrypt the multiplier, multiplicand is plaintext - std::vector multiplier_data(context.ea->size()); - std::vector multiplicand_data(context.ea->size()); + std::vector multiplier_data(context.getEA().size()); + std::vector multiplicand_data(context.getEA().size()); std::iota(multiplier_data.begin(), multiplier_data.end(), 0); std::iota(multiplicand_data.begin(), multiplicand_data.end(), 7); helib::Ptxt multiplier_ptxt(context, multiplier_data); diff --git a/tests/TestSet.cpp b/tests/TestSet.cpp index 88b084ed3..6ce645946 100644 --- a/tests/TestSet.cpp +++ b/tests/TestSet.cpp @@ -56,26 +56,31 @@ class TestSet : public ::testing::TestWithParam p(GetParam().p), r(GetParam().r), bits(GetParam().bits), - context(m, p, r), - secretKey((buildModChain(context, bits), context)), + context(helib::ContextBuilder() + .m(m) + .p(p) + .r(r) + .bits(bits) + .build()), + secretKey(context), publicKey((secretKey.GenSecKey(), addSome1DMatrices(secretKey), addFrbMatrices(secretKey), secretKey)), - ea(*(context.ea)) + ea(context.getEA()) {} virtual void SetUp() override { if (helib_test::verbose) { ea.getPAlgebra().printout(); - std::cout << "r = " << context.alMod.getR() << std::endl; - std::cout << "ctxtPrimes=" << context.ctxtPrimes - << ", specialPrimes=" << context.specialPrimes << std::endl + std::cout << "r = " << context.getAlMod().getR() << std::endl; + std::cout << "ctxtPrimes=" << context.getCtxtPrimes() + << ", specialPrimes=" << context.getSpecialPrimes() << std::endl << std::endl; } - helib::setupDebugGlobals(&secretKey, context.ea); + helib::setupDebugGlobals(&secretKey, context.shareEA()); } virtual void TearDown() override { helib::cleanupDebugGlobals(); } diff --git a/tests/TestVersion.in.cpp b/tests/TestVersion.in.cpp index 113ea8a53..51bfc0995 100644 --- a/tests/TestVersion.in.cpp +++ b/tests/TestVersion.in.cpp @@ -25,7 +25,7 @@ namespace { std::tuple readVersionFromCmakeFile() { // File will be in src/, we are in tests/ - const std::string cmakeFilePath = "@HELIB_SOURCE_DIR@/CMakeLists.txt"; + const std::string cmakeFilePath = "@HELIB_PROJECT_ROOT_DIR@/VERSION"; // Slurp the file. It isn't a large file. std::string fileStr; @@ -42,24 +42,22 @@ std::tuple readVersionFromCmakeFile() // Find the version. // e.g. - // project(helib - // VERSION x.y.z - // LANGUAGES CXX) + // x.y.z std::regex re_version( - R"(project[\s\S]*?helib[\s\S]*?VERSION[\s\S]*?((\d+)\.(\d+)\.(\d)))"); + R"((\d+)\.(\d+)\.(\d))"); std::smatch match; std::regex_search(fileStr, match, re_version); - if (match.size() < 5) { + if (match.size() != 4) { std::ostringstream oss; - oss << "Expected 5 matches, got " << match.size() << "."; + oss << "Expected 4 matches, got " << match.size() << "."; throw std::runtime_error(oss.str()); } - return std::tuple(std::stoi(match[2]), + return std::tuple(std::stoi(match[1]), + std::stoi(match[2]), std::stoi(match[3]), - std::stoi(match[4]), - "v" + match[1].str()); + match[0].str()); } TEST(TestVersion, versionMatchesThatFoundInCMakelists) diff --git a/tests/test_common.cpp b/tests/test_common.cpp index 83791e351..1274715cf 100644 --- a/tests/test_common.cpp +++ b/tests/test_common.cpp @@ -73,8 +73,8 @@ long setThreads = []() -> long { // TODO: Should be a member of EncryptedArray? bool hasBadDimension(const helib::Context& context) { - for (int i = 0; i < context.zMStar.numOfGens(); ++i) - if (!context.ea->nativeDimension(i)) + for (int i = 0; i < context.getZMStar().numOfGens(); ++i) + if (!context.getEA().nativeDimension(i)) return true; return false; } @@ -114,7 +114,8 @@ std::vector> getParams(bool good, for (auto p : p_vals) for (auto m : m_vals) { if (m % p != 0) { - helib::Context context(m, p, 1L); + helib::Context context = + helib::ContextBuilder().m(m).p(p).r(1L).build(); if (good ^ hasBadDimension(context)) { params.emplace_back(m, p); } diff --git a/utils/CMakeLists.txt b/utils/CMakeLists.txt index af8af513e..28be2de9b 100644 --- a/utils/CMakeLists.txt +++ b/utils/CMakeLists.txt @@ -31,7 +31,12 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}") -find_package(helib 1.3.1 EXACT REQUIRED) +# STRINGS avoids having the 2 newline characters at the end of the string. +# Alternatively it's possible to use file(READ ...) and then +# string(REGEX REPLACE "\n$" "" HELIB_VERSION "${HELIB_VERSION}") +file(STRINGS "../VERSION" HELIB_VERSION) + +find_package(helib "${HELIB_VERSION}" EXACT REQUIRED) add_subdirectory(create-context) add_subdirectory(crypto) diff --git a/utils/coders/decode.py b/utils/coders/decode.py index 6b2aef865..642f4b8ed 100755 --- a/utils/coders/decode.py +++ b/utils/coders/decode.py @@ -12,10 +12,10 @@ # limitations under the License. See accompanying LICENSE file. import argparse -import ast from functools import reduce from itertools import islice import re +import json def nSlotsFromParamsOutFile(filename): with open(filename) as f: @@ -28,7 +28,7 @@ def nSlotsFromParamsOutFile(filename): def parsePtxtGetSlots(iterable): for ptxt in iterable: - for slot in ast.literal_eval(ptxt): + for slot in ptxt: yield slot def printoutNums(ptxts, nelements): @@ -50,13 +50,17 @@ def main(): if nslots is None: sys.exit("Could not find nslots in '%s'." % args.infofile) - with open(args.infile) as data: - header = data.readline() + with open(args.infile) as jsonfile: + header = jsonfile.readline() + ptxts = [] + for line in jsonfile: + data = json.loads(line) + ptxts.append(data['content']['slots']) # Set if nelements is set otherwise calculate from info file. nelements = args.nelements if args.nelements is not None \ else reduce((lambda x, y: x * y), map(int, header.split())) * nslots print(nelements) - printoutNums(data, nelements) + printoutNums(ptxts, nelements) if __name__ == '__main__': main() diff --git a/utils/coders/encode.py b/utils/coders/encode.py index 5df807c4f..cb422731f 100755 --- a/utils/coders/encode.py +++ b/utils/coders/encode.py @@ -29,15 +29,23 @@ def nSlotsFromParamsOutFile(filename): return int(match.group(1)) return None +def getVersion(): + with open("../../../VERSION") as f: + return f.readline().replace('\n', '') + def printEmptyPtxts(amount, nslots, scheme): filler = [0] if scheme == "BGV" else [0.0] for _ in range(amount): - print([filler] * nslots) + print(f'{{"HElibVersion":"{getVersion()}","content":{{"scheme":"{scheme}","slots":', end='') + print(f'{[filler] * nslots}'.replace(', ', ','), end='') + print(f'}},"serializationVersion":"0.0.1","type":"Ptxt"}}') -def printPtxts(ptxts, header): +def printPtxts(ptxts, header, scheme): print(str(header)) for ptxt in ptxts: - print(ptxt) + print(f'{{"HElibVersion":"{getVersion()}","content":{{"scheme":"{scheme}","slots":', end='') + print(f'{ptxt}'.replace(', ', ','), end='') + print(f'}},"serializationVersion":"0.0.1","type":"Ptxt"}}') def genSlot(csv, scheme): fn = int if scheme == "BGV" else float @@ -98,10 +106,10 @@ def main(): ptxts = list(genPtxt(csv_reader, nslots, args.scheme)) if args.dims: - printPtxts(ptxts, args.dims) + printPtxts(ptxts, args.dims, args.scheme) printEmptyPtxts(totalPtxts - lenPtxts, nslots, args.scheme) else: - printPtxts(ptxts, len(ptxts)) + printPtxts(ptxts, len(ptxts), args.scheme) if __name__ == '__main__': main() diff --git a/utils/common/Writer.h b/utils/common/Writer.h index 780d1d7b8..ea8741cb8 100644 --- a/utils/common/Writer.h +++ b/utils/common/Writer.h @@ -103,7 +103,7 @@ class Writer void writeByLocation(const D& data, uint64_t row, uint64_t col) { writeStream.seekp(toc->getIdx(row, col)); - data.write(writeStream); + data.writeTo(writeStream); } TOC& getTOC() { return *toc; } diff --git a/utils/common/common.h b/utils/common/common.h index e5eb59296..40bc50f68 100644 --- a/utils/common/common.h +++ b/utils/common/common.h @@ -31,16 +31,6 @@ std::string readline(std::istream& is) return s; } -void readKeyBinary(std::istream& keyFile, helib::PubKey& pk) -{ - helib::readPubKeyBinary(keyFile, pk); -} - -void readKeyBinary(std::istream& keyFile, helib::SecKey& sk) -{ - helib::readSecKeyBinary(keyFile, sk); -} - template using uniq_pair = std::pair, std::unique_ptr>; @@ -55,13 +45,17 @@ uniq_pair loadContextAndKey(const std::string& keyFilePath) unsigned long m, p, r; std::vector gens, ords; - helib::readContextBaseBinary(keyFile, m, p, r, gens, ords); - std::unique_ptr contextp = - std::make_unique(m, p, r, gens, ords); - helib::readContextBinary(keyFile, *contextp); + std::unique_ptr contextp( + helib::Context::readPtrFrom(keyFile)); std::unique_ptr keyp = std::make_unique(*contextp); - readKeyBinary(keyFile, *keyp); + if constexpr (std::is_same_v) { + keyp = std::make_unique( + helib::SecKey::readFrom(keyFile, *contextp)); + } else { + keyp = std::make_unique( + helib::PubKey::readFrom(keyFile, *contextp)); + } return {std::move(contextp), std::move(keyp)}; } @@ -83,6 +77,10 @@ inline long estimateCtxtSize(const helib::Context& context, long offset) long size = 0; + // Header metadata + size += 24; + + // Begin eye-catcher size += 4; // Begin Ctxt metadata @@ -92,7 +90,7 @@ inline long estimateCtxtSize(const helib::Context& context, long offset) // primeSet.write(str); // size of set (long) + each prime (long) - size += 8 + context.ctxtPrimes.card() * 8; + size += 8 + context.getCtxtPrimes().card() * 8; // Begin Ctxt content size // write_raw_vector(str, parts); @@ -111,14 +109,13 @@ inline long estimateCtxtSize(const helib::Context& context, long offset) // this->DoubleCRT::write(str); // map.getIndexSet().write(str); // size of set (long) + each prime (long) - part_size += 8 + context.ctxtPrimes.card() * 8; + part_size += 8 + context.getCtxtPrimes().card() * 8; // DCRT data write as write_ntl_vec_long(str, map[i]); // For each prime in the ctxt modulus chain // size of DCRT column (long) + size of each element (long) + // size of all the slots (column in DCRT) (PhiM long elements) - long dcrt_size = - (8 + 8 * context.zMStar.getPhiM()) * context.ctxtPrimes.card(); + long dcrt_size = (8 + 8 * context.getPhiM()) * context.getCtxtPrimes().card(); part_size += dcrt_size; diff --git a/utils/create-context/create-context.cpp b/utils/create-context/create-context.cpp index 7f212222e..55c3e9f9b 100644 --- a/utils/create-context/create-context.cpp +++ b/utils/create-context/create-context.cpp @@ -78,14 +78,15 @@ void writeKeyToFile(std::string& pathPrefix, } // write the context - helib::writeContextBaseBinary(keysFile, context); - helib::writeContextBinary(keysFile, context); + context.writeTo(keysFile); // write the keys - if (pkNotSk) - helib::writePubKeyBinary(keysFile, secretKey); - else - helib::writeSecKeyBinary(keysFile, secretKey); + if (pkNotSk) { + const helib::PubKey& pk = secretKey; + pk.writeTo(keysFile); + } else { + secretKey.writeTo(keysFile); + } } int main(int argc, char* argv[]) @@ -208,34 +209,37 @@ int main(int argc, char* argv[]) } try { - helib::Context context(paramsOpts.m, - p, - paramsOpts.r, - helib::convert>(paramsOpts.gens), - helib::convert>(paramsOpts.ords)); - if (cmdLineOpts.bootstrappable == "NONE") { - helib::buildModChain(context, paramsOpts.Qbits, paramsOpts.c); - } else { - context.zMStar.set_cM(paramsOpts.c_m / 100.0); - helib::buildModChain(context, - paramsOpts.Qbits, - paramsOpts.c, - /*willBeBootstrappable=*/true); - if (cmdLineOpts.bootstrappable == "THICK") - context.enableBootStrapping(paramsOpts.mvec, - /*build_cache=*/false, - /*alsoThick=*/true); - else if (cmdLineOpts.bootstrappable == "THIN") - context.enableBootStrapping(paramsOpts.mvec, - /*build_cache=*/false, - /*alsoThick=*/false); - } + helib::Context* contextp; - if (p == -1) - context.scale = paramsOpts.scale; + if (cmdLineOpts.scheme == "BGV") { + helib::ContextBuilder cb; + cb.m(paramsOpts.m) + .p(p) + .r(paramsOpts.r) + .gens(helib::convert>(paramsOpts.gens)) + .ords(helib::convert>(paramsOpts.ords)) + .bits(paramsOpts.Qbits) + .c(paramsOpts.c); + + if (cmdLineOpts.bootstrappable != "NONE") { + cb.bootstrappable(true).mvec(paramsOpts.mvec); + if (cmdLineOpts.bootstrappable == "THICK") + cb.thickboot(); + else if (cmdLineOpts.bootstrappable == "THIN") + cb.thinboot(); + } + contextp = cb.buildPtr(); + } else if (cmdLineOpts.scheme == "CKKS") { + contextp = helib::ContextBuilder() + .m(paramsOpts.m) + .precision(paramsOpts.r) + .bits(paramsOpts.Qbits) + .scale(paramsOpts.scale) + .buildPtr(); + } // and a new secret/public key - helib::SecKey secretKey(context); + helib::SecKey secretKey(*contextp); secretKey.GenSecKey(); // A +-1/0 secret key // compute key-switching matrices @@ -267,13 +271,13 @@ int main(int argc, char* argv[]) throw std::runtime_error("Cannot write keys to file at '" + path + "'."); } - printoutToStream(context, + printoutToStream(*contextp, out, cmdLineOpts.noSKM, cmdLineOpts.frobSKM, cmdLineOpts.bootstrappable != "NONE"); } else { - printoutToStream(context, + printoutToStream(*contextp, std::cout, cmdLineOpts.noSKM, cmdLineOpts.frobSKM, @@ -283,7 +287,7 @@ int main(int argc, char* argv[]) NTL::SetNumThreads(2); NTL_EXEC_INDEX(2, skOrPk) - writeKeyToFile(cmdLineOpts.outputPrefixPath, context, secretKey, skOrPk); + writeKeyToFile(cmdLineOpts.outputPrefixPath, *contextp, secretKey, skOrPk); NTL_EXEC_INDEX_END } catch (const std::invalid_argument& e) { diff --git a/utils/crypto/decrypt.cpp b/utils/crypto/decrypt.cpp index 7708efba7..fd04bd407 100644 --- a/utils/crypto/decrypt.cpp +++ b/utils/crypto/decrypt.cpp @@ -188,9 +188,9 @@ int main(int argc, char* argv[]) // Read in, decrypt, output. try { - if (contextp->zMStar.getP() == -1) { + if (contextp->getP() == -1) { decryptFromTo(cmdLineOpts, *contextp, *skp); - } else if (contextp->zMStar.getP() > 0) { + } else if (contextp->getP() > 0) { decryptFromTo(cmdLineOpts, *contextp, *skp); } else { std::cerr << "Unrecognized scheme from context." << std::endl; diff --git a/utils/crypto/encrypt.cpp b/utils/crypto/encrypt.cpp index 9f1a6e4b2..fe7a3dad7 100644 --- a/utils/crypto/encrypt.cpp +++ b/utils/crypto/encrypt.cpp @@ -206,9 +206,9 @@ int main(int argc, char* argv[]) try { // Read in, encrypt, output. - if (contextp->zMStar.getP() == -1) { // CKKS + if (contextp->getP() == -1) { // CKKS encryptFromTo(cmdLineOpts, *contextp, *pkp); - } else if (contextp->zMStar.getP() > 0) { // BGV + } else if (contextp->getP() > 0) { // BGV encryptFromTo(cmdLineOpts, *contextp, *pkp); } else { std::cerr << "Unrecognized scheme from context." << std::endl; diff --git a/utils/test_bootstrapping/test_bootstrap.cpp b/utils/test_bootstrapping/test_bootstrap.cpp index 6e4eeb4bd..241c04939 100644 --- a/utils/test_bootstrapping/test_bootstrap.cpp +++ b/utils/test_bootstrapping/test_bootstrap.cpp @@ -25,7 +25,7 @@ helib::Ptxt generateRandomPtxt(const helib::Context& context) // Consider generating random polynomials if THICK helib::Ptxt ptxt(context); std::mt19937 gen(231087); - std::uniform_int_distribution coinFlipDist(0, context.zMStar.getP() - 1); + std::uniform_int_distribution coinFlipDist(0, context.getP() - 1); for (std::size_t i = 0; i < ptxt.size(); ++i) { ptxt[i] = coinFlipDist(gen); } @@ -70,7 +70,7 @@ int main(int argc, char** argv) std::cerr << "Context is not bootstrappable" << std::endl; return EXIT_FAILURE; } - const helib::EncryptedArray& ea(*context.ea); + const helib::EncryptedArray& ea(context.getEA()); helib::Ptxt ptxt = generateRandomPtxt(context); // Random in [0, p) helib::Ctxt ctxt(publicKey); diff --git a/utils/tests/crypto.bats b/utils/tests/crypto.bats index 75ebecb87..3a855f47f 100755 --- a/utils/tests/crypto.bats +++ b/utils/tests/crypto.bats @@ -189,7 +189,7 @@ function teardown { run $encrypt "${pk_file_bgv}" "${prefix_bgv}_invalid.ptxt" assert [ "$status" -ne 0 ] assert [ "${lines[0]}" == "Exit due to IOError thrown:" ] - assert [ "${lines[1]}" == "Cannot deserialize to PolyMod: Degree is too small. Trying to deserialize 3 coefficients. Degree is 2." ] + assert [ "${lines[1]}" == "Cannot deserialize to PolyMod: Degree is too small. Trying to deserialize 3 coefficients. Slot modulus degree is 2." ] } # CKKS encryption-related tests TESTS @@ -241,5 +241,5 @@ function teardown { run $encrypt "${pk_file_ckks}" "${prefix_ckks}_invalid.ptxt" assert [ "$status" -ne 0 ] assert [ "${lines[0]}" == "Exit due to IOError thrown:" ] - assert [ "${lines[1]}" == "CKKS expects maximum of 2 values per slot (real, imag). Got 3 instead." ] + assert [ "${lines[1]}" == "Bad complex JSON serialization. Expected a maximum of 2 elements, recieved 3" ] } diff --git a/utils/tests/diff-threshold.py b/utils/tests/diff-threshold.py index 40b9bccb7..eb6895eff 100755 --- a/utils/tests/diff-threshold.py +++ b/utils/tests/diff-threshold.py @@ -15,6 +15,7 @@ import sys import ast import math +import json def diff_float(na, nb, threshold): for a, b in zip(na, nb): @@ -40,7 +41,6 @@ def parseCorrectly(la, lb, decrypt): error_msg = "Type mismatch. {0}({1}) and {2}({3}) type do not match." if decrypt: for a, b in zip(la, lb): - a, b = ast.literal_eval(a), ast.literal_eval(b) if type(a) is not type(b): raise TypeError(error_msg.format(a, type(a), b, type(b))) yield a, b @@ -63,17 +63,29 @@ def main(): args = parser.parse_args() with open(args.firstfile, 'r') as f1, open(args.secondfile, 'r') as f2: - l1, l2 = list(f1), list(f2) + header1 = f1.readline() + header2 = f2.readline() + ptxt1 = [] + ptxt2 = [] + if args.decrypt: + for line in f1: + data1 = json.loads(line) + ptxt1.append(data1['content']['slots']) + for line in f2: + data2 = json.loads(line) + ptxt2.append(data2['content']['slots']) + else: + ptxt1, ptxt2 = list(f1), list(f2) - if len(l1) != len(l2): + if len(ptxt1) != len(ptxt2): sys.exit(f"Different number of lines. " - f"First contains {len(l1)} second contains {len(l2)}.") + f"First contains {len(ptxt1)} second contains {len(ptxt2)}.") - if l1[0] != l2[0]: - sys.exit(f"File headers differ. {l1[0]} {l2[0]}.") + if header1 != header2: + sys.exit(f"File headers differ. {header1} {header2}.") try: - for a, b in parseCorrectly(l1[1:], l2[1:], args.decrypt): + for a, b in parseCorrectly(ptxt1, ptxt2, args.decrypt): for sa, sb in zip(a, b): sa, sb = makeSameSize(sa, sb, 2) diff_float(sa, sb, args.threshold) diff --git a/utils/tests/std.bash b/utils/tests/std.bash index b0e64d7dc..90cf5fd0d 100644 --- a/utils/tests/std.bash +++ b/utils/tests/std.bash @@ -15,6 +15,7 @@ function random-char-string { } utils_dir=${utils_dir:-"../.."} +helib_root="../.." diff_threshold="../diff-threshold.py" generate_data="$utils_dir/tests/gen-data.py" @@ -47,6 +48,10 @@ function assert { fi } +function helib_version { + cat "${helib_root}/VERSION" +} + function print-info-location { if [ "$DEBUG" == "true" ] || [ "$DEBUG" == "1" ]; then # Whitespace after because in `-p` flag mode printout (BATS bug) From da02d1728b9410067b89b6b5de5dc43879e04e20 Mon Sep 17 00:00:00 2001 From: jlhcrawford <54402133+jlhcrawford@users.noreply.github.com> Date: Tue, 29 Dec 2020 13:30:05 +0000 Subject: [PATCH 2/8] Fixes when using HELIB_DEBUG=ON --- include/helib/keys.h | 6 ++++++ src/recryption.cpp | 22 ++++++++-------------- tests/GTestBootstrapping.cpp | 2 +- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/include/helib/keys.h b/include/helib/keys.h index d594a0a0e..b177ca759 100644 --- a/include/helib/keys.h +++ b/include/helib/keys.h @@ -391,6 +391,12 @@ class SecKey : public PubKey //! @brief Generate bootstrapping data if needed, returns index of key long genRecryptData(); + /** + * @brief Getter method for the recryption key. + * @return A `const` reference to the recryption key. + **/ + const DoubleCRT& getRecryptKey() const { return sKeys[recryptKeyID]; } + friend std::ostream& operator<<(std::ostream& str, const SecKey& sk); friend std::istream& operator>>(std::istream& str, SecKey& sk); diff --git a/src/recryption.cpp b/src/recryption.cpp index 3e7b49053..0215fba3c 100644 --- a/src/recryption.cpp +++ b/src/recryption.cpp @@ -468,10 +468,7 @@ void PubKey::reCrypt(Ctxt& ctxt) const #ifdef HELIB_DEBUG if (dbgKey) { - checkRecryptBounds(zzParts, - dbgKey->sKeys[recryptKeyID], - ctxt.getContext(), - q); + checkRecryptBounds(zzParts, dbgKey->getRecryptKey(), ctxt.getContext(), q); } #endif @@ -487,10 +484,10 @@ void PubKey::reCrypt(Ctxt& ctxt) const #ifdef HELIB_DEBUG if (dbgKey) { - checkRecryptBounds_v(v, dbgKey->sKeys[recryptKeyID], ctxt.getContext(), q); + checkRecryptBounds_v(v, dbgKey->getRecryptKey(), ctxt.getContext(), q); checkCriticalValue(zzParts, - dbgKey->sKeys[recryptKeyID], - ctxt.getContext().rcData, + dbgKey->getRecryptKey(), + ctxt.getContext().getRcData(), q); } #endif @@ -1066,10 +1063,7 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const #ifdef HELIB_DEBUG if (dbgKey) { - checkRecryptBounds(zzParts, - dbgKey->sKeys[recryptKeyID], - ctxt.getContext(), - q); + checkRecryptBounds(zzParts, dbgKey->getRecryptKey(), ctxt.getContext(), q); } #endif @@ -1085,9 +1079,9 @@ void PubKey::thinReCrypt(Ctxt& ctxt) const #ifdef HELIB_DEBUG if (dbgKey) { - checkRecryptBounds_v(v, dbgKey->sKeys[recryptKeyID], ctxt.getContext(), q); + checkRecryptBounds_v(v, dbgKey->getRecryptKey(), ctxt.getContext(), q); checkCriticalValue(zzParts, - dbgKey->sKeys[recryptKeyID], + dbgKey->getRecryptKey(), ctxt.getContext().getRcData(), q); } @@ -1202,7 +1196,7 @@ static void checkRecryptBounds_v(const std::vector& v, const Context& context, UNUSED long q) { - const RecryptData& rcData = context.rcData; + const RecryptData& rcData = context.getRcData(); long p = context.getP(); long e = rcData.e; diff --git a/tests/GTestBootstrapping.cpp b/tests/GTestBootstrapping.cpp index 1ddb84192..89360d9c6 100644 --- a/tests/GTestBootstrapping.cpp +++ b/tests/GTestBootstrapping.cpp @@ -333,7 +333,7 @@ TEST_P(GTestBootstrapping, bootstrappingWorksCorrectly) #ifdef HELIB_DEBUG // debugging key and ea // EA for plaintext space p^{e+r-e'} - helib::setupDebugGlobals(&secretKey, context.rcData.ea, ptxt_poly); + helib::setupDebugGlobals(&secretKey, context.getRcData().ea, ptxt_poly); if (helib::dbgEa->size() > 100) helib::printFlag = 0; // don't print too many slots #endif From 7ad0cc0c2a361ec64c3f341f4dd4cbe939518e80 Mon Sep 17 00:00:00 2001 From: jlhcrawford <54402133+jlhcrawford@users.noreply.github.com> Date: Wed, 6 Jan 2021 15:31:12 +0000 Subject: [PATCH 3/8] Change file format from dos to unix --- examples/tutorial/01_ckks_basics.cpp | 458 ++++++++++---------- examples/tutorial/02_ckks_depth.cpp | 280 ++++++------ examples/tutorial/03_ckks_data_movement.cpp | 306 ++++++------- examples/tutorial/04_ckks_matmul.cpp | 342 +++++++-------- examples/tutorial/05_ckks_multlowlvl.cpp | 258 +++++------ 5 files changed, 822 insertions(+), 822 deletions(-) diff --git a/examples/tutorial/01_ckks_basics.cpp b/examples/tutorial/01_ckks_basics.cpp index eda1aadfa..5c06b07ee 100644 --- a/examples/tutorial/01_ckks_basics.cpp +++ b/examples/tutorial/01_ckks_basics.cpp @@ -1,229 +1,229 @@ -/* Copyright (C) 2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include - -using namespace std; -using namespace helib; - -// In the CKKS encryption scheme, plaintexts are vectors of real or complex -// numbers. The length, n, of these vectors is determined by the choice of -// parameters, as discussed below. We often refer to the components of these -// vectors as "slots", which are indexed 0, ..., n-1. We can add, subtract, or -// multiply two ciphertexts, and the corresponding operations are carried out -// slot by slot. This is sometimes referred to as a "SIMD operation" (SIMD -// means Single Instruction Multiple Data), since we can effectively perform -// the same scalar operation in parallel on all n slots. - -int main(int argc, char* argv[]) -{ - // To get started, we need to choose some parameters. This is done by - // initializing a Context object. Since there are a lot of parameters, many - // of them optional, HElib provides a "builder pattern" then lets you provide - // these parameters "by name". - - Context context = - - // initialize a Context object using the builder pattern - ContextBuilder() - - .m(16 * 1024) - // m is the "cyclotomic index". For CKKS, m must be a power of 2. As - // m increases, you get more security and more slots, but the - // performance degrades and the size of a ciphertext increases. See - // table below for more information. - - .bits(119) - // bits specifies the number of bits in the "ciphertext modulus". As - // bits increases, you get less security, but you can perform deeper - // homomorphic computations; in addition, the size of a ciphertext - // increases. See table below for more information. Also see - // 02_depth.cpp for more information about how depth and bits are - // related. - - .precision(20) - // precision specifies the number of bits of precision when data is - // encoded, encrypted, or decrypted. More precisely, each of these - // operations are designed to add an error term of at most - // 2^{-precision} to each slot. As precision increases, the allowed - // depth of homomorphic computations decreases (but security and - // performance are not affected). It is not recommended to use - // precision greater than about 40 or so. - - .c(2) - // c specifies the number of columns in key-switching matrices. Yes, - // it sounds very technical, and it is. However, all you have to know - // about this parameter is that as c increases, you get a little more - // security, but performance degrades and the memory requirement for - // the public key increases. c must be at least 2 and it is not - // recommended to set c higher than 8. See table below for more - // information. - - .build(); - // last step of the builder pattern - - // The following table lists settings of m, bits, and c that yield (at least) - // 128-bit security. It is highly recommended to only use settings from this - // table. - // - // m bits c - // 16384 119 2 - // 32768 358 6 - // 32768 299 3 - // 32768 239 2 - // 65536 725 8 - // 65536 717 6 - // 65536 669 4 - // 65536 613 3 - // 65536 558 2 - // 131072 1445 8 - // 131072 1435 6 - // 131072 1387 5 - // 131072 1329 4 - // 131072 1255 3 - // 131072 1098 2 - // 262144 2940 8 - // 262144 2870 6 - // 262144 2763 5 - // 262144 2646 4 - // 262144 2511 3 - // 262144 2234 2 - - // We can print out the estimated security level. - // This estimate is based on the LWE security estimator. - cout << "securityLevel=" << context.securityLevel() << "\n"; - - // Get the number of slots, n. Note that for CKKS, we always have n=m/4. - long n = context.getNSlots(); - - // Construct a secret key. A secret key must be associated with a specific - // Context, which is passed (by reference) to the constructor. Programming - // note: to avoid dangling pointers, the given Context object must not be - // destroyed while any objects associated with it are still in use. - SecKey secretKey(context); - - // Constructing a secret key does not actually do very much. To actually - // build a full-fledged secret key, we have to invoke the GenSecKey method. - secretKey.GenSecKey(); - - // In HElib, the SecKey class is actually a subclass if the PubKey class. So - // one way to initialize a public key object is like this: - const PubKey& publicKey = secretKey; - - // TECHNICAL NOTE: Note the "&" in the declaration of publicKey. Since the - // SecKey class is a subclass of PubKey, this particular PubKey object is - // ultimately a SecKey object, and through the magic of C++ polymorphism, - // encryptions done via publicKey will actually use the secret key, which has - // certain advantages. If one left out the "&", then encryptions done via - // publicKey will NOT use the secret key. - - //=========================================================================== - - // Let's encrypt something! - // HElib provides a number of idioms for encrypting and decrypting. We focus - // on one particular idiom here. - - // We start by declaring a vector of length n, and we fill it with some - // arbitrary numbers. Note that PI is defined by HElib. - vector v0(n); - for (long i = 0; i < n; i++) - v0[i] = sin(2.0 * PI * i / n); - - // Next, we load the plaintext vector v0 into a special type of container, - // called a PtxtArray. Note that a PtxtArray is associated with a Context - // object, which is passed (by reference) to the constructor. - PtxtArray p0(context, v0); - - // Note that many types of vectors can be loaded into a PtxtArray object - // (including, vectors of int, long, double, or even complex). Also - // note that constructing p0 and loading v0 into could have been done in two - // separate steps: - // PtxtArray p0(context); p0.load(v0); - - // Next, we construct a ciphertext c0. A ciphertext is associated with a - // PubKey object, which is passed (by reference) to the constructor. - // Programming note: to avoid dangling pointers, the given PubKey object must - // not be destroyed while any objects associated with it are still in use. - Ctxt c0(publicKey); - - // Finally, we can encrypt p0 and store it in c0: - p0.encrypt(c0); - // Note that since a ciphertext is always associated with a public key, there - // is no need to pass a public key as a separate parameter to the encryption - // method. - - //=========================================================================== - - // We next create another ciphertext c1, in a slightly different way. - // First, we construct another PtxtArray p1: - PtxtArray p1(context); - - // Next, we fill all n slots of p1 with random numbers in the interval [0,1]: - p1.random(); - - // Finally, we encrypt p1 and store it in c1, as above: - Ctxt c1(publicKey); - p1.encrypt(c1); - - //=========================================================================== - - // We next create a ciphertext c2, in the same as was we did c1: - PtxtArray p2(context); - p2.random(); - Ctxt c2(publicKey); - p2.encrypt(c2); - - //=========================================================================== - - // Now we homorphically compute c3 = c0*c1 + c2*1.5: - Ctxt c3 = c0; - c3 *= c1; - Ctxt c4 = c2; - c4 *= 1.5; - c3 += c4; - - // When this is done, if we denote the i-th slot of a ciphertext c by c[i], - // then we have c3[i] = c0[i]*c1[i] + c2[i]*1.5 for i = 0..n-1. - - //=========================================================================== - - // Next we decrypt c3. - // First, we construct a new PtxtArray pp3. - PtxtArray pp3(context); - - // Next, we decrypt c3, storing the plaintext in p3: - pp3.decrypt(c3, secretKey); - - // Finally, we store the PtxtArray p3 into a standard vector v3: - vector v3; - pp3.store(v3); - - //=========================================================================== - - // If we like, we can test the accuracy of the computation. - // First, we perform the same computation directly on plaintexts. - // The PtxtArray class allows this to be done very easily: - PtxtArray p3 = p0; - p3 *= p1; - PtxtArray p4 = p2; - p4 *= 1.5; - p3 += p4; - - // Then, we compute the distance between p3 (computed on plaintexts) and pp3 - // (computed homomorphically on ciphertexts). This is computed as - // max{ |p3[i]-pp3[i]| : i = 0..n-1 } - double distance = Distance(p3, pp3); - - cout << "distance=" << distance << "\n"; - - return 0; -} +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, plaintexts are vectors of real or complex +// numbers. The length, n, of these vectors is determined by the choice of +// parameters, as discussed below. We often refer to the components of these +// vectors as "slots", which are indexed 0, ..., n-1. We can add, subtract, or +// multiply two ciphertexts, and the corresponding operations are carried out +// slot by slot. This is sometimes referred to as a "SIMD operation" (SIMD +// means Single Instruction Multiple Data), since we can effectively perform +// the same scalar operation in parallel on all n slots. + +int main(int argc, char* argv[]) +{ + // To get started, we need to choose some parameters. This is done by + // initializing a Context object. Since there are a lot of parameters, many + // of them optional, HElib provides a "builder pattern" then lets you provide + // these parameters "by name". + + Context context = + + // initialize a Context object using the builder pattern + ContextBuilder() + + .m(16 * 1024) + // m is the "cyclotomic index". For CKKS, m must be a power of 2. As + // m increases, you get more security and more slots, but the + // performance degrades and the size of a ciphertext increases. See + // table below for more information. + + .bits(119) + // bits specifies the number of bits in the "ciphertext modulus". As + // bits increases, you get less security, but you can perform deeper + // homomorphic computations; in addition, the size of a ciphertext + // increases. See table below for more information. Also see + // 02_depth.cpp for more information about how depth and bits are + // related. + + .precision(20) + // precision specifies the number of bits of precision when data is + // encoded, encrypted, or decrypted. More precisely, each of these + // operations are designed to add an error term of at most + // 2^{-precision} to each slot. As precision increases, the allowed + // depth of homomorphic computations decreases (but security and + // performance are not affected). It is not recommended to use + // precision greater than about 40 or so. + + .c(2) + // c specifies the number of columns in key-switching matrices. Yes, + // it sounds very technical, and it is. However, all you have to know + // about this parameter is that as c increases, you get a little more + // security, but performance degrades and the memory requirement for + // the public key increases. c must be at least 2 and it is not + // recommended to set c higher than 8. See table below for more + // information. + + .build(); + // last step of the builder pattern + + // The following table lists settings of m, bits, and c that yield (at least) + // 128-bit security. It is highly recommended to only use settings from this + // table. + // + // m bits c + // 16384 119 2 + // 32768 358 6 + // 32768 299 3 + // 32768 239 2 + // 65536 725 8 + // 65536 717 6 + // 65536 669 4 + // 65536 613 3 + // 65536 558 2 + // 131072 1445 8 + // 131072 1435 6 + // 131072 1387 5 + // 131072 1329 4 + // 131072 1255 3 + // 131072 1098 2 + // 262144 2940 8 + // 262144 2870 6 + // 262144 2763 5 + // 262144 2646 4 + // 262144 2511 3 + // 262144 2234 2 + + // We can print out the estimated security level. + // This estimate is based on the LWE security estimator. + cout << "securityLevel=" << context.securityLevel() << "\n"; + + // Get the number of slots, n. Note that for CKKS, we always have n=m/4. + long n = context.getNSlots(); + + // Construct a secret key. A secret key must be associated with a specific + // Context, which is passed (by reference) to the constructor. Programming + // note: to avoid dangling pointers, the given Context object must not be + // destroyed while any objects associated with it are still in use. + SecKey secretKey(context); + + // Constructing a secret key does not actually do very much. To actually + // build a full-fledged secret key, we have to invoke the GenSecKey method. + secretKey.GenSecKey(); + + // In HElib, the SecKey class is actually a subclass if the PubKey class. So + // one way to initialize a public key object is like this: + const PubKey& publicKey = secretKey; + + // TECHNICAL NOTE: Note the "&" in the declaration of publicKey. Since the + // SecKey class is a subclass of PubKey, this particular PubKey object is + // ultimately a SecKey object, and through the magic of C++ polymorphism, + // encryptions done via publicKey will actually use the secret key, which has + // certain advantages. If one left out the "&", then encryptions done via + // publicKey will NOT use the secret key. + + //=========================================================================== + + // Let's encrypt something! + // HElib provides a number of idioms for encrypting and decrypting. We focus + // on one particular idiom here. + + // We start by declaring a vector of length n, and we fill it with some + // arbitrary numbers. Note that PI is defined by HElib. + vector v0(n); + for (long i = 0; i < n; i++) + v0[i] = sin(2.0 * PI * i / n); + + // Next, we load the plaintext vector v0 into a special type of container, + // called a PtxtArray. Note that a PtxtArray is associated with a Context + // object, which is passed (by reference) to the constructor. + PtxtArray p0(context, v0); + + // Note that many types of vectors can be loaded into a PtxtArray object + // (including, vectors of int, long, double, or even complex). Also + // note that constructing p0 and loading v0 into could have been done in two + // separate steps: + // PtxtArray p0(context); p0.load(v0); + + // Next, we construct a ciphertext c0. A ciphertext is associated with a + // PubKey object, which is passed (by reference) to the constructor. + // Programming note: to avoid dangling pointers, the given PubKey object must + // not be destroyed while any objects associated with it are still in use. + Ctxt c0(publicKey); + + // Finally, we can encrypt p0 and store it in c0: + p0.encrypt(c0); + // Note that since a ciphertext is always associated with a public key, there + // is no need to pass a public key as a separate parameter to the encryption + // method. + + //=========================================================================== + + // We next create another ciphertext c1, in a slightly different way. + // First, we construct another PtxtArray p1: + PtxtArray p1(context); + + // Next, we fill all n slots of p1 with random numbers in the interval [0,1]: + p1.random(); + + // Finally, we encrypt p1 and store it in c1, as above: + Ctxt c1(publicKey); + p1.encrypt(c1); + + //=========================================================================== + + // We next create a ciphertext c2, in the same as was we did c1: + PtxtArray p2(context); + p2.random(); + Ctxt c2(publicKey); + p2.encrypt(c2); + + //=========================================================================== + + // Now we homorphically compute c3 = c0*c1 + c2*1.5: + Ctxt c3 = c0; + c3 *= c1; + Ctxt c4 = c2; + c4 *= 1.5; + c3 += c4; + + // When this is done, if we denote the i-th slot of a ciphertext c by c[i], + // then we have c3[i] = c0[i]*c1[i] + c2[i]*1.5 for i = 0..n-1. + + //=========================================================================== + + // Next we decrypt c3. + // First, we construct a new PtxtArray pp3. + PtxtArray pp3(context); + + // Next, we decrypt c3, storing the plaintext in p3: + pp3.decrypt(c3, secretKey); + + // Finally, we store the PtxtArray p3 into a standard vector v3: + vector v3; + pp3.store(v3); + + //=========================================================================== + + // If we like, we can test the accuracy of the computation. + // First, we perform the same computation directly on plaintexts. + // The PtxtArray class allows this to be done very easily: + PtxtArray p3 = p0; + p3 *= p1; + PtxtArray p4 = p2; + p4 *= 1.5; + p3 += p4; + + // Then, we compute the distance between p3 (computed on plaintexts) and pp3 + // (computed homomorphically on ciphertexts). This is computed as + // max{ |p3[i]-pp3[i]| : i = 0..n-1 } + double distance = Distance(p3, pp3); + + cout << "distance=" << distance << "\n"; + + return 0; +} diff --git a/examples/tutorial/02_ckks_depth.cpp b/examples/tutorial/02_ckks_depth.cpp index d8c1df708..2a600c380 100644 --- a/examples/tutorial/02_ckks_depth.cpp +++ b/examples/tutorial/02_ckks_depth.cpp @@ -1,140 +1,140 @@ -/* Copyright (C) 2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include - -using namespace std; -using namespace helib; - -// In the CKKS encryption scheme, ciphertexts have a certain amount of "noise". -// This noise increases with the depth of a homomorphic computation, where by -// "depth", we mean the depth of the arithmetic circuit representing the -// computation. Noise negatively impacts a homomorphic computation in two ways: -// as it grows, it reduces both the *capacity* and the *accuracy* of a -// ciphertext. -// -// The capacity of a ciphertext starts out as some number which is a little -// less than to the bits parameter specified when building a Context object, -// and it is reduced by some amount by each homomorphic computation. When the -// capacity drops below 1, the ciphertext can no longer be decrypted. -// -// The accuracy can be measured in terms of the *absolute error* of a -// ciphertext c compared to the plaintext p that it should encrypt. The -// absolute error of c is defined to be max{|c[i]-p[i]| : i=1..n-1}. Here, n is -// the number of slots. The absolute error of a freshly encrypted ciphertext -// should be no more than (about) 2^{-precision}, where precision is a -// parameter specified in building a Context object. The absolute error will -// grow as a homomorphic computation proceeds. -// -// Given a ciphertext c, one can obtain its capacity by invoking c.capacity(), -// and one can obtain a bound on its absolute error by invoking c.errorBound(). - -int main(int argc, char* argv[]) -{ - Context context = - ContextBuilder() - .m(32 * 1024) - .bits(358) - .precision(20) - .c(6) - .build(); - - cout << "securityLevel=" << context.securityLevel() << "\n"; - - long n = context.getNSlots(); - - SecKey secretKey(context); - secretKey.GenSecKey(); - const PubKey& publicKey = secretKey; - - //=========================================================================== - - // Let's encrypt something! - vector v(n); - for (long i = 0; i < n; i++) - v[i] = sin(2.0 * PI * i / n); - PtxtArray p(context, v); - Ctxt c(publicKey); - p.encrypt(c); - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // Let's square c a few times and see what happens - - c *= c; - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - c *= c; - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - c *= c; - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - c *= c; - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - c *= c; - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // Let's perform the same computation on the plaintext: - p *= p; - p *= p; - p *= p; - p *= p; - p *= p; - - //=========================================================================== - - // Let's decrypt and compare: - PtxtArray pp(context); - pp.decrypt(c, secretKey); - - double distance = Distance(p, pp); - cout << "distance=" << distance << "\n"; - - //=========================================================================== - - // On my machine, I get the following output: - // - // c.capacity=328.497 c.errorBound=1.28242e-06 - // c.capacity=289.748 c.errorBound=2.69423e-06 - // c.capacity=252.063 c.errorBound=5.71405e-06 - // c.capacity=213.502 c.errorBound=1.1591e-05 - // c.capacity=176.579 c.errorBound=2.37053e-05 - // c.capacity=139.634 c.errorBound=4.79147e-05 - // distance=1.84256e-05 - // - // So we see that we start out with capacity about 328 (which is somewhat - // less than the value 358 of the bits parameter), and an errorBound of - // 1.28242e-06, which is slightly larger than 2^{-20} = 2^{-precision}. - // After each squaring, capacity decreases by 37-39, while errorBound - // increases by about a factor of 2 (i.e., we lose one bit of precision). - // Finally, when we decrypt, we see the actual error (1.84256e-05) is - // somewhat smaller than errorBound (4.79147e-05). - // - // Note that the values returned by capacity() and errorBound() may vary from - // one run of the program to another, even if all the parameters and - // plaintext data are the same. However, they should not change by much from - // one run to another. - - return 0; -} +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, ciphertexts have a certain amount of "noise". +// This noise increases with the depth of a homomorphic computation, where by +// "depth", we mean the depth of the arithmetic circuit representing the +// computation. Noise negatively impacts a homomorphic computation in two ways: +// as it grows, it reduces both the *capacity* and the *accuracy* of a +// ciphertext. +// +// The capacity of a ciphertext starts out as some number which is a little +// less than to the bits parameter specified when building a Context object, +// and it is reduced by some amount by each homomorphic computation. When the +// capacity drops below 1, the ciphertext can no longer be decrypted. +// +// The accuracy can be measured in terms of the *absolute error* of a +// ciphertext c compared to the plaintext p that it should encrypt. The +// absolute error of c is defined to be max{|c[i]-p[i]| : i=1..n-1}. Here, n is +// the number of slots. The absolute error of a freshly encrypted ciphertext +// should be no more than (about) 2^{-precision}, where precision is a +// parameter specified in building a Context object. The absolute error will +// grow as a homomorphic computation proceeds. +// +// Given a ciphertext c, one can obtain its capacity by invoking c.capacity(), +// and one can obtain a bound on its absolute error by invoking c.errorBound(). + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(32 * 1024) + .bits(358) + .precision(20) + .c(6) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // Let's square c a few times and see what happens + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + c *= c; + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // Let's perform the same computation on the plaintext: + p *= p; + p *= p; + p *= p; + p *= p; + p *= p; + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + //=========================================================================== + + // On my machine, I get the following output: + // + // c.capacity=328.497 c.errorBound=1.28242e-06 + // c.capacity=289.748 c.errorBound=2.69423e-06 + // c.capacity=252.063 c.errorBound=5.71405e-06 + // c.capacity=213.502 c.errorBound=1.1591e-05 + // c.capacity=176.579 c.errorBound=2.37053e-05 + // c.capacity=139.634 c.errorBound=4.79147e-05 + // distance=1.84256e-05 + // + // So we see that we start out with capacity about 328 (which is somewhat + // less than the value 358 of the bits parameter), and an errorBound of + // 1.28242e-06, which is slightly larger than 2^{-20} = 2^{-precision}. + // After each squaring, capacity decreases by 37-39, while errorBound + // increases by about a factor of 2 (i.e., we lose one bit of precision). + // Finally, when we decrypt, we see the actual error (1.84256e-05) is + // somewhat smaller than errorBound (4.79147e-05). + // + // Note that the values returned by capacity() and errorBound() may vary from + // one run of the program to another, even if all the parameters and + // plaintext data are the same. However, they should not change by much from + // one run to another. + + return 0; +} diff --git a/examples/tutorial/03_ckks_data_movement.cpp b/examples/tutorial/03_ckks_data_movement.cpp index cbbc18fc6..647eb25f2 100644 --- a/examples/tutorial/03_ckks_data_movement.cpp +++ b/examples/tutorial/03_ckks_data_movement.cpp @@ -1,153 +1,153 @@ -/* Copyright (C) 2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include - -using namespace std; -using namespace helib; - -// In the CKKS encryption scheme, besides SIMD operations that act on the slots -// of a ciphertext in parallel, it is also possible to move data around among -// the slots of a ciphertext. - -int main(int argc, char* argv[]) -{ - Context context = - ContextBuilder() - .m(32 * 1024) - .bits(358) - .precision(30) - .c(6) - .build(); - - cout << "securityLevel=" << context.securityLevel() << "\n"; - - long n = context.getNSlots(); - - SecKey secretKey(context); - secretKey.GenSecKey(); - - // To support data movement, we need to add some information to the public - // key. This is done as follows: - addSome1DMatrices(secretKey); - - // Recall that SecKey is a subclass of PubKey. The call to addSome1DMatrices - // needs data stored in the secret key, but the information it computes is - // stored in the public key. - - const PubKey& publicKey = secretKey; - - //=========================================================================== - - // Let's encrypt something! - vector v(n); - for (long i = 0; i < n; i++) - v[i] = sin(2.0 * PI * i / n); - PtxtArray p(context, v); - Ctxt c(publicKey); - p.encrypt(c); - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // We can rotate the data in the slots by any amount. - - rotate(c, 2); - // rotate c right by 2: - // (c[0], ..., c[n-1]) = (c[n-2], c[n-1], c[0], c[1], ..., c[n-3]) - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - rotate(c, -1); - // rotate c left by 1 - // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], c[0]) - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // We can shift the data in the slots by any amount. - - shift(c, 2); - // rotate c right by 2: - // (c[0], ..., c[n-1]) = (0, 0, c[0], c[1], ..., c[n-3]) - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - shift(c, -1); - // rotate c left by 1 - // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], 0) - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // We can also sum all of slots, leaving the sum in each slot - - totalSums(c); - // (c[0], ..., c[n-1]) = (S, ..., S), where S = sum_{i=0}^{n-1} c[i] - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - // There are a number of other data movement operations available. - - //=========================================================================== - - // Let's perform the same computation on the plaintext: - - rotate(p, 2); - rotate(p, -1); - shift(p, 2); - shift(p, -1); - totalSums(p); - - //=========================================================================== - - // Let's decrypt and compare: - PtxtArray pp(context); - pp.decrypt(c, secretKey); - - double distance = Distance(p, pp); - cout << "distance=" << distance << "\n"; - - // For debugging, you can also make "approximate" comparisons as follows: - if (pp == Approx(p)) - cout << "GOOD\n"; - else - cout << "BAD\n"; - - // Here, p is the "correct value" and you want to test if pp is "close" to it. - - // NOTES: The Approx function (which is really a class constructor) takes two - // optional arguments: - // double tolerance; // default is 0.01 - // double floor; // default is 1.0 - // - // The expression - // a == Approx(b, tolerance, floor) - // is true iff Distance(a,b) <= tolerance*max(Norm(b),floor), The idea is - // that it checks if the relative error is at most tolerance, unless Norm(b) - // itself is too small (as determined by floor). Here, Norm(b) is the max - // absolute value of the slots, and Distance(a,b) = Norm(a-b). - // - // In addition to PtxtArray's, you can compare values of type double or - // complex, and vectors of type double or complex. - - return 0; -} +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, besides SIMD operations that act on the slots +// of a ciphertext in parallel, it is also possible to move data around among +// the slots of a ciphertext. + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(32 * 1024) + .bits(358) + .precision(30) + .c(6) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + // To support data movement, we need to add some information to the public + // key. This is done as follows: + addSome1DMatrices(secretKey); + + // Recall that SecKey is a subclass of PubKey. The call to addSome1DMatrices + // needs data stored in the secret key, but the information it computes is + // stored in the public key. + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can rotate the data in the slots by any amount. + + rotate(c, 2); + // rotate c right by 2: + // (c[0], ..., c[n-1]) = (c[n-2], c[n-1], c[0], c[1], ..., c[n-3]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + rotate(c, -1); + // rotate c left by 1 + // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], c[0]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can shift the data in the slots by any amount. + + shift(c, 2); + // rotate c right by 2: + // (c[0], ..., c[n-1]) = (0, 0, c[0], c[1], ..., c[n-3]) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + shift(c, -1); + // rotate c left by 1 + // (c[0], ..., c[n-1]) = (c[1], c[2], ..., c[n-1], 0) + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We can also sum all of slots, leaving the sum in each slot + + totalSums(c); + // (c[0], ..., c[n-1]) = (S, ..., S), where S = sum_{i=0}^{n-1} c[i] + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + // There are a number of other data movement operations available. + + //=========================================================================== + + // Let's perform the same computation on the plaintext: + + rotate(p, 2); + rotate(p, -1); + shift(p, 2); + shift(p, -1); + totalSums(p); + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + // For debugging, you can also make "approximate" comparisons as follows: + if (pp == Approx(p)) + cout << "GOOD\n"; + else + cout << "BAD\n"; + + // Here, p is the "correct value" and you want to test if pp is "close" to it. + + // NOTES: The Approx function (which is really a class constructor) takes two + // optional arguments: + // double tolerance; // default is 0.01 + // double floor; // default is 1.0 + // + // The expression + // a == Approx(b, tolerance, floor) + // is true iff Distance(a,b) <= tolerance*max(Norm(b),floor), The idea is + // that it checks if the relative error is at most tolerance, unless Norm(b) + // itself is too small (as determined by floor). Here, Norm(b) is the max + // absolute value of the slots, and Distance(a,b) = Norm(a-b). + // + // In addition to PtxtArray's, you can compare values of type double or + // complex, and vectors of type double or complex. + + return 0; +} diff --git a/examples/tutorial/04_ckks_matmul.cpp b/examples/tutorial/04_ckks_matmul.cpp index e218797a7..4a1567ff4 100644 --- a/examples/tutorial/04_ckks_matmul.cpp +++ b/examples/tutorial/04_ckks_matmul.cpp @@ -1,171 +1,171 @@ -/* Copyright (C) 2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include - -using namespace std; -using namespace helib; - -// In the CKKS encryption scheme, since a ciphertext encrypts a vector -// of slots, it makes sense to multiply that vector by a matrix. -// HElib provides highly optimized routines for multiplying -// an encrypted vector by a plaintext matrix. - -// To use these routines, we need to include an extra file: -#include - -// In this example, we will also make some performance measurements. HElib -// provides convenient "timers" to measure running time. We will also be -// measuring space. For this, we will use the getrusage function, if available: - -#if defined(__unix__) || defined(__unix) || defined(unix) -#include -#include -void printMemoryUsage() -{ - struct rusage r; - getrusage(RUSAGE_SELF, &r); - cout << " ru_maxrss=" << r.ru_maxrss << endl; -} -#else -void printMemoryUsage() {} -#endif - -int main(int argc, char* argv[]) -{ - Context context = - ContextBuilder() - .m(16 * 1024) - .bits(119) - .precision(30) - .c(2) - .build(); - - cout << "securityLevel=" << context.securityLevel() << "\n"; - - long n = context.getNSlots(); - - SecKey secretKey(context); - secretKey.GenSecKey(); - - addSome1DMatrices(secretKey); - - const PubKey& publicKey = secretKey; - - //=========================================================================== - - // Let's encrypt something! - vector v(n); - for (long i = 0; i < n; i++) - v[i] = sin(2.0 * PI * i / n); - PtxtArray p(context, v); - Ctxt c(publicKey); - p.encrypt(c); - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - //=========================================================================== - - // We define a plaintext matrix as follows: - MatMul_CKKS mat(context, - [n](long i, long j) { return ((i + j) % n) / double(n); }); - - // Note that the second parameter of the MatMul_CKKS constructor is of type - // std::function, meaning that it should be a - // function-like object that takes two long's and returns a double. In this - // example, the actual parameter is a C++ "lambda" object. - - // We now multiply ciphertext c by this matrix: - c *= mat; - - // Note that this computes c = c*mat, where the slots of c are viewed as a - // row vector - - cout << "c.capacity=" << c.capacity() << " "; - cout << "c.errorBound=" << c.errorBound() << "\n"; - - // We can multiply the plaintext p by the same matrix: - p *= mat; - - //=========================================================================== - - // Let's decrypt and compare: - PtxtArray pp(context); - pp.decrypt(c, secretKey); - - double distance = Distance(p, pp); - cout << "distance=" << distance << "\n"; - - //=========================================================================== - - // If a given matrix is going to be used many times, one can obtain better - // performance by doing a one-time pre-computation. Let's begin by - // performing the same ciphertext/matrix multiplication, but this - // time, let's measure the running time. HElib provides a convenient - // mechanism for doing this: - - Ctxt c0 = c; - HELIB_NTIMER_START(mul0); // starts a timer called "mul0" - c0 *= mat; - HELIB_NTIMER_STOP(mul0); // stops the time "mul0" - printNamedTimer(cout, "mul0"); - // On my machine, this took about 4.6s - - // A pre-computation is performed by "encoding" the matrix, as follows: - HELIB_NTIMER_START(encode); - EncodedMatMul_CKKS emat(mat); - HELIB_NTIMER_STOP(encode); - printNamedTimer(cout, "encode"); - // On my machine, this took about 2.4s - - // We can apply the encoded matrix to a ciphertext as follows: - Ctxt c1 = c; - - { - HELIB_NTIMER_START(mul1); - c1 *= emat; - } // The timer "mul1" automatically gets stopped when control exits the block - printNamedTimer(cout, "mul1"); - // On my machine, this took about 2.4s - - // We can perform even more precomputation, but it takes up more space. - // First, let's see how much space we are currently using: - printMemoryUsage(); - // On my machine, the memory footprint is now about 340MB - - // Now do more pre-computation: - { - HELIB_NTIMER_START(upgrade); - emat.upgrade(); - } - printNamedTimer(cout, "upgrade"); - // On my machine, this took about 1.7s - - // And let's see how much the space increased: - printMemoryUsage(); - // On my machine, the memory footprint is now about 850MB, - // and so the upgrade costs about 510MB of space. - - // Now we apply the upgraded encoded matrix to the ciphertext: - Ctxt c2 = c; - - { - HELIB_NTIMER_START(mul2); - c2 *= emat; - } - printNamedTimer(cout, "mul2"); - // On my machine, this took about 1.4s. Compared the original time of 4.6s, - // we see a roughly 3.3x speedup. - - return 0; -} +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme, since a ciphertext encrypts a vector +// of slots, it makes sense to multiply that vector by a matrix. +// HElib provides highly optimized routines for multiplying +// an encrypted vector by a plaintext matrix. + +// To use these routines, we need to include an extra file: +#include + +// In this example, we will also make some performance measurements. HElib +// provides convenient "timers" to measure running time. We will also be +// measuring space. For this, we will use the getrusage function, if available: + +#if defined(__unix__) || defined(__unix) || defined(unix) +#include +#include +void printMemoryUsage() +{ + struct rusage r; + getrusage(RUSAGE_SELF, &r); + cout << " ru_maxrss=" << r.ru_maxrss << endl; +} +#else +void printMemoryUsage() {} +#endif + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(16 * 1024) + .bits(119) + .precision(30) + .c(2) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + addSome1DMatrices(secretKey); + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector v(n); + for (long i = 0; i < n; i++) + v[i] = sin(2.0 * PI * i / n); + PtxtArray p(context, v); + Ctxt c(publicKey); + p.encrypt(c); + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + //=========================================================================== + + // We define a plaintext matrix as follows: + MatMul_CKKS mat(context, + [n](long i, long j) { return ((i + j) % n) / double(n); }); + + // Note that the second parameter of the MatMul_CKKS constructor is of type + // std::function, meaning that it should be a + // function-like object that takes two long's and returns a double. In this + // example, the actual parameter is a C++ "lambda" object. + + // We now multiply ciphertext c by this matrix: + c *= mat; + + // Note that this computes c = c*mat, where the slots of c are viewed as a + // row vector + + cout << "c.capacity=" << c.capacity() << " "; + cout << "c.errorBound=" << c.errorBound() << "\n"; + + // We can multiply the plaintext p by the same matrix: + p *= mat; + + //=========================================================================== + + // Let's decrypt and compare: + PtxtArray pp(context); + pp.decrypt(c, secretKey); + + double distance = Distance(p, pp); + cout << "distance=" << distance << "\n"; + + //=========================================================================== + + // If a given matrix is going to be used many times, one can obtain better + // performance by doing a one-time pre-computation. Let's begin by + // performing the same ciphertext/matrix multiplication, but this + // time, let's measure the running time. HElib provides a convenient + // mechanism for doing this: + + Ctxt c0 = c; + HELIB_NTIMER_START(mul0); // starts a timer called "mul0" + c0 *= mat; + HELIB_NTIMER_STOP(mul0); // stops the time "mul0" + printNamedTimer(cout, "mul0"); + // On my machine, this took about 4.6s + + // A pre-computation is performed by "encoding" the matrix, as follows: + HELIB_NTIMER_START(encode); + EncodedMatMul_CKKS emat(mat); + HELIB_NTIMER_STOP(encode); + printNamedTimer(cout, "encode"); + // On my machine, this took about 2.4s + + // We can apply the encoded matrix to a ciphertext as follows: + Ctxt c1 = c; + + { + HELIB_NTIMER_START(mul1); + c1 *= emat; + } // The timer "mul1" automatically gets stopped when control exits the block + printNamedTimer(cout, "mul1"); + // On my machine, this took about 2.4s + + // We can perform even more precomputation, but it takes up more space. + // First, let's see how much space we are currently using: + printMemoryUsage(); + // On my machine, the memory footprint is now about 340MB + + // Now do more pre-computation: + { + HELIB_NTIMER_START(upgrade); + emat.upgrade(); + } + printNamedTimer(cout, "upgrade"); + // On my machine, this took about 1.7s + + // And let's see how much the space increased: + printMemoryUsage(); + // On my machine, the memory footprint is now about 850MB, + // and so the upgrade costs about 510MB of space. + + // Now we apply the upgraded encoded matrix to the ciphertext: + Ctxt c2 = c; + + { + HELIB_NTIMER_START(mul2); + c2 *= emat; + } + printNamedTimer(cout, "mul2"); + // On my machine, this took about 1.4s. Compared the original time of 4.6s, + // we see a roughly 3.3x speedup. + + return 0; +} diff --git a/examples/tutorial/05_ckks_multlowlvl.cpp b/examples/tutorial/05_ckks_multlowlvl.cpp index ace59a437..8307f1310 100644 --- a/examples/tutorial/05_ckks_multlowlvl.cpp +++ b/examples/tutorial/05_ckks_multlowlvl.cpp @@ -1,129 +1,129 @@ -/* Copyright (C) 2020 IBM Corp. - * This program is Licensed under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * 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. See accompanying LICENSE file. - */ - -#include - -using namespace std; -using namespace helib; - -// In the CKKS encryption scheme (as well as in BGV), ciphertext multiplication -// is a two-step process. The operation ctxt1 *= ctxt2 is equivalent to the -// following: -// ctxt1.multLowLvl(ctxt2); -// ctxt1.reLinearize(); -// The operation ctxt1.multLowLvl(ctxt2) multiplies ctxt1 by ctxt2, but it -// leaves ctxt1 in a non-canonical state. The operation ctxt1.reLinearize() -// puts ctxt1 back into a canonical state. As it happens, -// ctxt1.multLowLvl(ctxt2) is a very fast operation, while ctxt1.reLinearize() -// is a much slower operation. In addition, some operations, such as -// ciphertext addition, can be applied directly to ciphertexts in non-canonical -// states, yielding ciphertexts also in a non-canonical state. This behavior -// can sometimes be exploited to achieve significant speedups, as illustrated -// here. - -int main(int argc, char* argv[]) -{ - Context context = - ContextBuilder() - .m(16 * 1024) - .bits(119) - .precision(20) - .c(2) - .build(); - - cout << "securityLevel=" << context.securityLevel() << "\n"; - - long n = context.getNSlots(); - - SecKey secretKey(context); - secretKey.GenSecKey(); - - const PubKey& publicKey = secretKey; - - //=========================================================================== - - // Let's encrypt a bunch of random ciphertexts - - int len = 3; - - vector p, q; - for (int i = 0; i < len; i++) { - p.emplace_back(context); - p[i].random(); - q.emplace_back(context); - q[i].random(); - } - - // p[i] is a random PtxtArray for i = 0..len-1 - // q[i] is a random PtxtArray for i = 0..len-1 - - vector c, d; - for (int i = 0; i < len; i++) { - c.emplace_back(publicKey); - p[i].encrypt(c[i]); - d.emplace_back(publicKey); - q[i].encrypt(d[i]); - } - - // c[i] encrypts p[i] for i = 0..len-1 - // d[i] encrypts q[i] for i = 0..len-1 - - //=========================================================================== - - // Now let's compute the inner product e = sum_{i=0}^{len-1} c[i]*d[i] using - // multLowLvl. NOTE: this is for illustration purposes only, as HElib already - // provides a function innerProduct that does the same thing in essentially - // the same way. - - Ctxt e(publicKey); - // We use the fact that a freshly constructed ciphertext acts like an - // encryption of 0 - - for (int i = 0; i < len; i++) { - Ctxt tmp = c[i]; - tmp.multLowLvl(d[i]); - // tmp is now c[i]*d[i] but in a non-canonical state - - e += tmp; - // e is now c[0]*d[0] + ... c[i]*d[i] but in a non-canonical state - } - - e.reLinearize(); - // This puts e back into a canonical state. In this example, we do not really - // have to do this, but if e were to be used in other computations, it would - // likely be more efficient to put e into a canonical state once and for all - // at this point. The point is, if we had written the above loop with - // tmp *= d[i] instead of tmp.multLowLvl(d[i]), we would have preformed len - // expensive reLinearize operations, instead of just one. - - //=========================================================================== - - // Let's do the same computation on plaintexts to check the results. - - PtxtArray r(context); - // We use the fact that a freshly constructed plaintext is 0 - - for (int i = 0; i < len; i++) { - PtxtArray tmp = p[i]; - tmp *= q[i]; - r += tmp; - } - - // Let's decrypt and compare: - PtxtArray rr(context); - rr.decrypt(e, secretKey); - - double distance = Distance(r, rr); - cout << "distance=" << distance << "\n"; - - return 0; -} +/* Copyright (C) 2020 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +#include + +using namespace std; +using namespace helib; + +// In the CKKS encryption scheme (as well as in BGV), ciphertext multiplication +// is a two-step process. The operation ctxt1 *= ctxt2 is equivalent to the +// following: +// ctxt1.multLowLvl(ctxt2); +// ctxt1.reLinearize(); +// The operation ctxt1.multLowLvl(ctxt2) multiplies ctxt1 by ctxt2, but it +// leaves ctxt1 in a non-canonical state. The operation ctxt1.reLinearize() +// puts ctxt1 back into a canonical state. As it happens, +// ctxt1.multLowLvl(ctxt2) is a very fast operation, while ctxt1.reLinearize() +// is a much slower operation. In addition, some operations, such as +// ciphertext addition, can be applied directly to ciphertexts in non-canonical +// states, yielding ciphertexts also in a non-canonical state. This behavior +// can sometimes be exploited to achieve significant speedups, as illustrated +// here. + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder() + .m(16 * 1024) + .bits(119) + .precision(20) + .c(2) + .build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt a bunch of random ciphertexts + + int len = 3; + + vector p, q; + for (int i = 0; i < len; i++) { + p.emplace_back(context); + p[i].random(); + q.emplace_back(context); + q[i].random(); + } + + // p[i] is a random PtxtArray for i = 0..len-1 + // q[i] is a random PtxtArray for i = 0..len-1 + + vector c, d; + for (int i = 0; i < len; i++) { + c.emplace_back(publicKey); + p[i].encrypt(c[i]); + d.emplace_back(publicKey); + q[i].encrypt(d[i]); + } + + // c[i] encrypts p[i] for i = 0..len-1 + // d[i] encrypts q[i] for i = 0..len-1 + + //=========================================================================== + + // Now let's compute the inner product e = sum_{i=0}^{len-1} c[i]*d[i] using + // multLowLvl. NOTE: this is for illustration purposes only, as HElib already + // provides a function innerProduct that does the same thing in essentially + // the same way. + + Ctxt e(publicKey); + // We use the fact that a freshly constructed ciphertext acts like an + // encryption of 0 + + for (int i = 0; i < len; i++) { + Ctxt tmp = c[i]; + tmp.multLowLvl(d[i]); + // tmp is now c[i]*d[i] but in a non-canonical state + + e += tmp; + // e is now c[0]*d[0] + ... c[i]*d[i] but in a non-canonical state + } + + e.reLinearize(); + // This puts e back into a canonical state. In this example, we do not really + // have to do this, but if e were to be used in other computations, it would + // likely be more efficient to put e into a canonical state once and for all + // at this point. The point is, if we had written the above loop with + // tmp *= d[i] instead of tmp.multLowLvl(d[i]), we would have preformed len + // expensive reLinearize operations, instead of just one. + + //=========================================================================== + + // Let's do the same computation on plaintexts to check the results. + + PtxtArray r(context); + // We use the fact that a freshly constructed plaintext is 0 + + for (int i = 0; i < len; i++) { + PtxtArray tmp = p[i]; + tmp *= q[i]; + r += tmp; + } + + // Let's decrypt and compare: + PtxtArray rr(context); + rr.decrypt(e, secretKey); + + double distance = Distance(r, rr); + cout << "distance=" << distance << "\n"; + + return 0; +} From a1d3ac6c2fd12be7d5cfa8ee298d90cb01f02254 Mon Sep 17 00:00:00 2001 From: hamishun <60481960+hamishun@users.noreply.github.com> Date: Fri, 8 Jan 2021 17:54:40 +0000 Subject: [PATCH 4/8] Warn refactor --- include/helib/log.h | 19 ++++++++- src/log.cpp | 3 +- tests/TestLogging.cpp | 92 +++++++++++++++++++--------------------- tests/TestVersion.in.cpp | 3 +- 4 files changed, 64 insertions(+), 53 deletions(-) diff --git a/include/helib/log.h b/include/helib/log.h index 86788eb16..6bf49ff14 100644 --- a/include/helib/log.h +++ b/include/helib/log.h @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -13,6 +13,8 @@ #ifndef HELIB_LOG_H #define HELIB_LOG_H +#include +#include #include #include #include @@ -92,13 +94,26 @@ class Logger **/ extern Logger helog; +/** + * @brief Return a time stamp for now. + * @return A `const std::string` with format `[ HH:mm:ss ]`. + **/ +inline const std::string timestamp() +{ + auto t = std::time(nullptr); + auto now = *std::localtime(&t); + std::ostringstream oss; + oss << std::put_time(&now, "[ %T ]"); + return oss.str(); +} + /** * @brief Function for logging a warning message. * @param msg The warning message. **/ inline void Warning(const char* msg) { - *helog.logStream_p << "WARNING: " << msg << std::endl; + *helog.logStream_p << timestamp() << " WARNING: " << msg << std::endl; } /** diff --git a/src/log.cpp b/src/log.cpp index cedfe20c8..8cced2fc0 100644 --- a/src/log.cpp +++ b/src/log.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -26,6 +26,7 @@ static bool checkDeletable(std::ostream* os) return false; } +// This is the default Logger object. Logger helog = []() -> Logger { Logger defaultLog; helog.setLogToFile("helib.log"); diff --git a/tests/TestLogging.cpp b/tests/TestLogging.cpp index a2266d00e..e4555c293 100644 --- a/tests/TestLogging.cpp +++ b/tests/TestLogging.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -16,15 +16,30 @@ namespace { -static std::string penultimateLine(std::istream& is) +// Find matching line in file. Match substr. Currently, just scans file. +// Fine as for test log files will be relatively small. +static bool findMatchingLine(std::istream& is, const std::string& str) { std::string line; - std::string penultimateLine; - while (!is.eof()) { - penultimateLine = line; - std::getline(is, line); + while (std::getline(is, line)) { + if (line.find(str) != std::string::npos) { + return true; + } } - return penultimateLine; + return false; +} + +// Similar to findMatchingLine above however it looks for s1 first and if found +// continues to look for s2. so s1 comes before s2. +static bool findMatchingLines(std::istream& is, + const std::string& s1, + const std::string& s2) +{ + if (findMatchingLine(is, s1)) { + return findMatchingLine(is, s2); + } + + return false; } // First we run the tests that do not change the default `ostream`. @@ -34,18 +49,12 @@ TEST(TestLogging, testWarningToDefaultLogfile) { const char* filepath = "helib.log"; - helib::Warning("Warning message!"); + const std::string warningMsg = "Warning message 900!"; + helib::Warning(warningMsg); std::ifstream filestream(filepath); ASSERT_TRUE(filestream); - - std::string warningMsg; - - // The default file will append so need to check last line. - // Technically the penultimate as the last line is blank due to a final '\n'. - warningMsg = penultimateLine(filestream); - - EXPECT_EQ("WARNING: Warning message!", warningMsg); + EXPECT_TRUE(findMatchingLine(filestream, warningMsg)); // Should not really delete the default log file } @@ -58,16 +67,12 @@ TEST(TestLogging, testWarningToSetLogfile) helib::helog.setLogToFile(filepath); - helib::Warning("Warning message!"); + const std::string warningMsg = "Warning message 700!"; + helib::Warning(warningMsg); std::ifstream filestream(filepath); ASSERT_TRUE(filestream); - - std::string warningMsg; - std::getline(filestream, warningMsg); - - EXPECT_EQ("WARNING: Warning message!", warningMsg); - + EXPECT_TRUE(findMatchingLine(filestream, warningMsg)); ASSERT_FALSE(std::remove(filepath)); } @@ -79,27 +84,19 @@ TEST(TestLogging, testWarningToSetLogfileAppend) std::ofstream fout(filepath); ASSERT_TRUE(fout); - - fout << "This line was first.\n"; + const std::string firstLine = "This line was first."; + fout << firstLine << std::endl; fout.close(); // Now set helib to it. helib::helog.setLogToFile(filepath); - helib::Warning("Warning message!"); + const std::string warningMsg = "Warning message 600!"; + helib::Warning(warningMsg); std::ifstream filestream(filepath); ASSERT_TRUE(filestream); - - std::string warningMsg; - std::getline(filestream, warningMsg); - - EXPECT_EQ("This line was first.", warningMsg); - - std::getline(filestream, warningMsg); - - EXPECT_EQ("WARNING: Warning message!", warningMsg); - + ASSERT_TRUE(findMatchingLines(filestream, firstLine, warningMsg)); ASSERT_FALSE(std::remove(filepath)); } @@ -111,24 +108,22 @@ TEST(TestLogging, testWarningToSetLogfileOverwrite) std::ofstream fout(filepath); ASSERT_TRUE(fout); - - fout << "This line was first.\n"; + const std::string firstLine = "This line was first."; + fout << firstLine << std::endl; fout.close(); // Now set helib to it. helib::helog.setLogToFile(filepath, true); - helib::Warning("Warning message!"); + const std::string warningMsg = "Warning message 500!"; + helib::Warning(warningMsg); std::ifstream filestream(filepath); ASSERT_TRUE(filestream); - - std::string warningMsg; - std::getline(filestream, warningMsg); - - EXPECT_NE("This line was first.", warningMsg); - EXPECT_EQ("WARNING: Warning message!", warningMsg); - + ASSERT_FALSE(findMatchingLine(filestream, firstLine)); + filestream.clear(); // clear stream flags. + filestream.seekg(0); // file reset. + ASSERT_TRUE(findMatchingLine(filestream, warningMsg)); ASSERT_FALSE(std::remove(filepath)); } @@ -142,12 +137,13 @@ TEST(TestLogging, testWarningToStderr) std::streambuf* sbuf = std::cerr.rdbuf(); std::cerr.rdbuf(capturedStderr.rdbuf()); - helib::Warning("Warning message!"); + const std::string warningMsg = "Warning message 400!"; + helib::Warning(warningMsg); // Reset std cerr buffer std::cerr.rdbuf(sbuf); - EXPECT_EQ("WARNING: Warning message!\n", capturedStderr.str()); + EXPECT_TRUE(capturedStderr.str().find(warningMsg) != std::string::npos); } } // namespace diff --git a/tests/TestVersion.in.cpp b/tests/TestVersion.in.cpp index 51bfc0995..e3a20d71a 100644 --- a/tests/TestVersion.in.cpp +++ b/tests/TestVersion.in.cpp @@ -44,8 +44,7 @@ std::tuple readVersionFromCmakeFile() // e.g. // x.y.z - std::regex re_version( - R"((\d+)\.(\d+)\.(\d))"); + std::regex re_version(R"((\d+)\.(\d+)\.(\d))"); std::smatch match; std::regex_search(fileStr, match, re_version); if (match.size() != 4) { From 202b3e1764b959f4008bee7cb5267d9e335938c5 Mon Sep 17 00:00:00 2001 From: jlhcrawford <54402133+jlhcrawford@users.noreply.github.com> Date: Mon, 11 Jan 2021 15:21:40 +0000 Subject: [PATCH 5/8] Tutorial tweaks Co-authored-by: victorshoup Co-authored-by: Jack Crawford --- examples/tutorial/01_ckks_basics.cpp | 19 +- examples/tutorial/02_ckks_depth.cpp | 14 +- examples/tutorial/03_ckks_data_movement.cpp | 17 +- examples/tutorial/04_ckks_matmul.cpp | 24 +- examples/tutorial/05_ckks_multlowlvl.cpp | 19 +- examples/tutorial/06_ckks_complex.cpp | 144 +++++++++ ...lization.cpp => 07_ckks_serialization.cpp} | 33 +- ...zation.cpp => 08_ckks_deserialization.cpp} | 41 +-- examples/tutorial/CMakeLists.txt | 11 +- examples/tutorial/new-api.cpp | 285 ++++++++++++++++++ 10 files changed, 515 insertions(+), 92 deletions(-) create mode 100644 examples/tutorial/06_ckks_complex.cpp rename examples/tutorial/{06_ckks_serialization.cpp => 07_ckks_serialization.cpp} (77%) rename examples/tutorial/{07_ckks_deserialization.cpp => 08_ckks_deserialization.cpp} (87%) create mode 100644 examples/tutorial/new-api.cpp diff --git a/examples/tutorial/01_ckks_basics.cpp b/examples/tutorial/01_ckks_basics.cpp index 5c06b07ee..91ce310d3 100644 --- a/examples/tutorial/01_ckks_basics.cpp +++ b/examples/tutorial/01_ckks_basics.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -10,11 +10,6 @@ * limitations under the License. See accompanying LICENSE file. */ -#include - -using namespace std; -using namespace helib; - // In the CKKS encryption scheme, plaintexts are vectors of real or complex // numbers. The length, n, of these vectors is determined by the choice of // parameters, as discussed below. We often refer to the components of these @@ -24,11 +19,16 @@ using namespace helib; // means Single Instruction Multiple Data), since we can effectively perform // the same scalar operation in parallel on all n slots. +#include + +using namespace std; +using namespace helib; + int main(int argc, char* argv[]) { // To get started, we need to choose some parameters. This is done by // initializing a Context object. Since there are a lot of parameters, many - // of them optional, HElib provides a "builder pattern" then lets you provide + // of them optional, HElib provides a "builder pattern" than lets you provide // these parameters "by name". Context context = @@ -194,6 +194,9 @@ int main(int argc, char* argv[]) // When this is done, if we denote the i-th slot of a ciphertext c by c[i], // then we have c3[i] = c0[i]*c1[i] + c2[i]*1.5 for i = 0..n-1. + // More generally, for a Ctxt c, one can perform c *= d, c += d, or c -= d, + // where d can be (among other things) a long, a double, or even a PtxtArray. + //=========================================================================== // Next we decrypt c3. @@ -220,7 +223,7 @@ int main(int argc, char* argv[]) // Then, we compute the distance between p3 (computed on plaintexts) and pp3 // (computed homomorphically on ciphertexts). This is computed as - // max{ |p3[i]-pp3[i]| : i = 0..n-1 } + // max{ |p3[i]-pp3[i]| : i = 0..n-1 } double distance = Distance(p3, pp3); cout << "distance=" << distance << "\n"; diff --git a/examples/tutorial/02_ckks_depth.cpp b/examples/tutorial/02_ckks_depth.cpp index 2a600c380..f06f28e37 100644 --- a/examples/tutorial/02_ckks_depth.cpp +++ b/examples/tutorial/02_ckks_depth.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -38,15 +38,15 @@ using namespace helib; // Given a ciphertext c, one can obtain its capacity by invoking c.capacity(), // and one can obtain a bound on its absolute error by invoking c.errorBound(). +#include + +using namespace std; +using namespace helib; + int main(int argc, char* argv[]) { Context context = - ContextBuilder() - .m(32 * 1024) - .bits(358) - .precision(20) - .c(6) - .build(); + ContextBuilder().m(32 * 1024).bits(358).precision(20).c(6).build(); cout << "securityLevel=" << context.securityLevel() << "\n"; diff --git a/examples/tutorial/03_ckks_data_movement.cpp b/examples/tutorial/03_ckks_data_movement.cpp index 647eb25f2..d13d5c0ba 100644 --- a/examples/tutorial/03_ckks_data_movement.cpp +++ b/examples/tutorial/03_ckks_data_movement.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -10,24 +10,19 @@ * limitations under the License. See accompanying LICENSE file. */ +// In the CKKS encryption scheme, besides SIMD operations that act on the slots +// of a ciphertext in parallel, it is also possible to move data around among +// the slots of a ciphertext. + #include using namespace std; using namespace helib; -// In the CKKS encryption scheme, besides SIMD operations that act on the slots -// of a ciphertext in parallel, it is also possible to move data around among -// the slots of a ciphertext. - int main(int argc, char* argv[]) { Context context = - ContextBuilder() - .m(32 * 1024) - .bits(358) - .precision(30) - .c(6) - .build(); + ContextBuilder().m(32 * 1024).bits(358).precision(30).c(6).build(); cout << "securityLevel=" << context.securityLevel() << "\n"; diff --git a/examples/tutorial/04_ckks_matmul.cpp b/examples/tutorial/04_ckks_matmul.cpp index 4a1567ff4..ba4998447 100644 --- a/examples/tutorial/04_ckks_matmul.cpp +++ b/examples/tutorial/04_ckks_matmul.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -10,16 +10,16 @@ * limitations under the License. See accompanying LICENSE file. */ +// In the CKKS encryption scheme, since a ciphertext encrypts a vector of +// slots, it makes sense to multiply that vector by a matrix. HElib provides +// highly optimized routines for multiplying an encrypted vector by a plaintext +// matrix. + #include using namespace std; using namespace helib; -// In the CKKS encryption scheme, since a ciphertext encrypts a vector -// of slots, it makes sense to multiply that vector by a matrix. -// HElib provides highly optimized routines for multiplying -// an encrypted vector by a plaintext matrix. - // To use these routines, we need to include an extra file: #include @@ -43,12 +43,7 @@ void printMemoryUsage() {} int main(int argc, char* argv[]) { Context context = - ContextBuilder() - .m(16 * 1024) - .bits(119) - .precision(30) - .c(2) - .build(); + ContextBuilder().m(16 * 1024).bits(119).precision(30).c(2).build(); cout << "securityLevel=" << context.securityLevel() << "\n"; @@ -76,14 +71,15 @@ int main(int argc, char* argv[]) //=========================================================================== - // We define a plaintext matrix as follows: + // We define an n x n plaintext matrix as follows: MatMul_CKKS mat(context, [n](long i, long j) { return ((i + j) % n) / double(n); }); // Note that the second parameter of the MatMul_CKKS constructor is of type // std::function, meaning that it should be a // function-like object that takes two long's and returns a double. In this - // example, the actual parameter is a C++ "lambda" object. + // example, the actual parameter is a C++ "lambda" object. In input (i, j), + // this should return the value of the matrix in row i and column j. // We now multiply ciphertext c by this matrix: c *= mat; diff --git a/examples/tutorial/05_ckks_multlowlvl.cpp b/examples/tutorial/05_ckks_multlowlvl.cpp index 8307f1310..806ab691d 100644 --- a/examples/tutorial/05_ckks_multlowlvl.cpp +++ b/examples/tutorial/05_ckks_multlowlvl.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -10,11 +10,6 @@ * limitations under the License. See accompanying LICENSE file. */ -#include - -using namespace std; -using namespace helib; - // In the CKKS encryption scheme (as well as in BGV), ciphertext multiplication // is a two-step process. The operation ctxt1 *= ctxt2 is equivalent to the // following: @@ -30,15 +25,15 @@ using namespace helib; // can sometimes be exploited to achieve significant speedups, as illustrated // here. +#include + +using namespace std; +using namespace helib; + int main(int argc, char* argv[]) { Context context = - ContextBuilder() - .m(16 * 1024) - .bits(119) - .precision(20) - .c(2) - .build(); + ContextBuilder().m(16 * 1024).bits(119).precision(20).c(2).build(); cout << "securityLevel=" << context.securityLevel() << "\n"; diff --git a/examples/tutorial/06_ckks_complex.cpp b/examples/tutorial/06_ckks_complex.cpp new file mode 100644 index 000000000..4032da02d --- /dev/null +++ b/examples/tutorial/06_ckks_complex.cpp @@ -0,0 +1,144 @@ +/* Copyright (C) 2020-2021 IBM Corp. + * This program is Licensed under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * 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. See accompanying LICENSE file. + */ + +// In the CKKS encryption scheme, ciphertexts can encrypt vectors of complex +// numbers. + +#include + +#include +// This is only needed if you want to do matrix multiplication + +using namespace std; +using namespace helib; + +int main(int argc, char* argv[]) +{ + Context context = + ContextBuilder().m(32 * 1024).bits(358).precision(30).c(6).build(); + + cout << "securityLevel=" << context.securityLevel() << "\n"; + + long n = context.getNSlots(); + + SecKey secretKey(context); + secretKey.GenSecKey(); + + addSome1DMatrices(secretKey); + // This only needs to be done if you want to do matrix multiplication + + addSomeFrbMatrices(secretKey); + // This only needs to be done if you want to do conjugation + + const PubKey& publicKey = secretKey; + + //=========================================================================== + + // Let's encrypt something! + vector> v0(n); + for (long i = 0; i < n; i++) + v0[i] = std::complex(cos(2.0 * PI * i / n), sin(2.0 * PI * i / n)); + + // A PtxtArray can be initialized with a vector of complex numbers + PtxtArray p0(context, v0); + + // Encryption works the same as with real numbers + Ctxt c0(publicKey); + p0.encrypt(c0); + + //=========================================================================== + + // We next create another ciphertext that encrypts random complex numbers: + + PtxtArray p1(context); + p1.randomComplex(); + // this fills each entry of p1 with a random number in the complex + // unit circle + + Ctxt c1(publicKey); + p1.encrypt(c1); + + //=========================================================================== + + // We can perform homomorphic computations in the same way as we did before: + + Ctxt c2 = c0; + c2 *= 2.5; + c2 += c1; + + // Note that there is no direct support for combining a ciphertext with a + // complex scalar. This can be achieved, however, by first converting the + // complex scaler to a PtxtArray. For example: + + PtxtArray I(context, std::complex(0.0, 1.0)); + // I has the imaginary unit in each slot + + c2 *= I; + + cout << "c2.capacity=" << c2.capacity() << " "; + cout << "c2.errorBound=" << c2.errorBound() << "\n"; + + // Data movement operations, like rotate and shift, work exactly as before. + + // There is also support for multiplying a ciphertext by a plaintext matrix + // of complex numbers. In 04_ckks_matmul.cpp, we showed how you could + // specify an n x n matrix of real numbers using the class MatMul_CKKS. One + // can specify an n x n matrix of complex numbers as follows: + + MatMul_CKKS_Complex mat(context, [n](long i, long j) { + return std::complex(i, j) / double(n); + }); + + c2 *= mat; + + cout << "c2.capacity=" << c2.capacity() << " "; + cout << "c2.errorBound=" << c2.errorBound() << "\n"; + + //=========================================================================== + + // One can homomorphically compute the complex conjugate of each slot + // of a ciphertext as follows: + + conjugate(c2); + + cout << "c2.capacity=" << c2.capacity() << " "; + cout << "c2.errorBound=" << c2.errorBound() << "\n"; + + //=========================================================================== + + // Let's decrypt the results: + + PtxtArray pp2(context); + pp2.decryptComplex(c2, secretKey); + + // Note that if one just writes pp2.decrypt(c2, secretKey) instead of + // pp2.decryptComplex(c2, secretKey), the imaginary part will be discarded. + + // We can store pp2 in a standard vector, as usual: + + std::vector> v2; + pp2.store(v2); + + //=========================================================================== + + // We can also perform the computation on plaintexts and compare: + + PtxtArray p2 = p0; + p2 *= 2.5; + p2 += p1; + p2 *= I; + p2 *= mat; + conjugate(p2); + + double distance = Distance(p2, pp2); + cout << "distance=" << distance << "\n"; +} diff --git a/examples/tutorial/06_ckks_serialization.cpp b/examples/tutorial/07_ckks_serialization.cpp similarity index 77% rename from examples/tutorial/06_ckks_serialization.cpp rename to examples/tutorial/07_ckks_serialization.cpp index 33b02bf73..ce453620c 100644 --- a/examples/tutorial/06_ckks_serialization.cpp +++ b/examples/tutorial/07_ckks_serialization.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -34,21 +34,25 @@ int main(int argc, char* argv[]) { // CKKS context created with a builder. - helib::Context CKKS_context = helib::ContextBuilder() - .m(128) - .precision(20) - .bits(30) - .c(3) - .build(); + helib::Context context = helib::ContextBuilder() + .m(128) + .precision(20) + .bits(30) + .c(3) + .build(); + + // NOTE These chosen parameters are for demonstration only. They do not the + // provide security level that might be required for real use/application + // scenarios. // Print context to stdout std::cout << "*** CKKS context:\n"; // Below we pretty print the JSON. If you do not wish to pretty print an - // alternative is to call `CKKS_context.writeJSON(std::cout);` - std::cout << CKKS_context.writeToJSON().pretty() << std::endl; + // alternative is to call `context.writeJSON(std::cout);` + std::cout << context.writeToJSON().pretty() << std::endl; // Create a secret key associated with the CKKS context - helib::SecKey secret_key(CKKS_context); + helib::SecKey secret_key(context); // Generate the secret key secret_key.GenSecKey(); @@ -67,18 +71,15 @@ int main(int argc, char* argv[]) std::cout << "\n\n*** Public Key:\n"; std::cout << public_key.writeToJSON().pretty() << std::endl; - // Get the EncryptedArray of the context - const helib::EncryptedArray& ea = CKKS_context.getEA(); - // Create a Ptxt data object - std::vector data(ea.size()); + std::vector data(context.getNSlots()); // Generate some data std::iota(data.begin(), data.end(), 0); // Create a ptxt. Note that in this tutorial we make use of the // alternative ptxt API. - helib::Ptxt ptxt(CKKS_context, data); + helib::Ptxt ptxt(context, data); // Print the ptxt to stdout std::cout << "\n\n*** Ptxt:\n"; @@ -88,7 +89,7 @@ int main(int argc, char* argv[]) helib::Ctxt ctxt(public_key); // Encrypt `data` into the ciphertext - ea.getCx().encrypt(ctxt, public_key, data); + public_key.Encrypt(ctxt, ptxt); // Print the ctxt to stdout std::cout << "\n\n*** Ctxt:\n"; diff --git a/examples/tutorial/07_ckks_deserialization.cpp b/examples/tutorial/08_ckks_deserialization.cpp similarity index 87% rename from examples/tutorial/07_ckks_deserialization.cpp rename to examples/tutorial/08_ckks_deserialization.cpp index 62332c3c7..dcc0086c2 100644 --- a/examples/tutorial/07_ckks_deserialization.cpp +++ b/examples/tutorial/08_ckks_deserialization.cpp @@ -1,4 +1,4 @@ -/* Copyright (C) 2020 IBM Corp. +/* Copyright (C) 2020-2021 IBM Corp. * This program is Licensed under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at @@ -34,18 +34,22 @@ int main(int argc, char* argv[]) { // CKKS context created with a builder. - helib::Context CKKSContext = helib::ContextBuilder() - .m(128) - .precision(20) - .bits(30) - .c(3) - .build(); + helib::Context context = helib::ContextBuilder() + .m(128) + .precision(20) + .bits(30) + .c(3) + .build(); + + // NOTE These chosen parameters are for demonstration only. They do not the + // provide security level that might be required for real use/application + // scenarios. std::ofstream outContextFile; outContextFile.open("context.json", std::ios::out); if (outContextFile.is_open()) { // Write the context to a file - CKKSContext.writeToJSON(outContextFile); + context.writeToJSON(outContextFile); // Close the ofstream outContextFile.close(); } else { @@ -68,7 +72,7 @@ int main(int argc, char* argv[]) std::remove("context.json"); // Create a secret key associated with the CKKS context - helib::SecKey secretKey(CKKSContext); + helib::SecKey secretKey(context); // Generate the secret key secretKey.GenSecKey(); @@ -92,10 +96,10 @@ int main(int argc, char* argv[]) if (inSecretKeyFile.is_open()) { // Read in the secret key from the file helib::SecKey deserializedSecretKey = - helib::SecKey::readFromJSON(inSecretKeyFile, CKKSContext); + helib::SecKey::readFromJSON(inSecretKeyFile, context); // Note there are alternative methods for deserialization of SecKey objects. // After initialization - // helib::SecKey deserializedSecretKey(CKKSContext); + // helib::SecKey deserializedSecretKey(context); // One can write // inSecretKeyFile >> deserializedSecretKey; // Or alternatively @@ -129,10 +133,10 @@ int main(int argc, char* argv[]) if (inPublicKeyFile.is_open()) { // Read in the public key from the file helib::PubKey deserializedPublicKey = - helib::PubKey::readFromJSON(inPublicKeyFile, CKKSContext); + helib::PubKey::readFromJSON(inPublicKeyFile, context); // Note there are alternative methods for deserialization of PubKey objects. // After initialization - // helib::PubKey deserializedPublicKey(CKKSContext); + // helib::PubKey deserializedPublicKey(context); // One can write // inPublicKeyFile >> deserializedPublicKey; // Or alternatively @@ -147,18 +151,15 @@ int main(int argc, char* argv[]) // inspect the file. std::remove("pk.json"); - // Get the EncryptedArray of the context - const helib::EncryptedArray& ea = CKKSContext.getEA(); - // Create a Ptxt data object - std::vector data(ea.size()); + std::vector data(context.getNSlots()); // Generate some data std::iota(data.begin(), data.end(), 0); // Create a ptxt. Note that in this tutorial we make use of the // alternative ptxt API. - helib::Ptxt ptxt(CKKSContext, data); + helib::Ptxt ptxt(context, data); std::ofstream outPtxtFile; outPtxtFile.open("ptxt.json", std::ios::out); @@ -176,7 +177,7 @@ int main(int argc, char* argv[]) if (inPtxtFile.is_open()) { // Read in the ptxt from the file helib::Ptxt deserializedPtxt = - helib::Ptxt::readFromJSON(inPtxtFile, CKKSContext); + helib::Ptxt::readFromJSON(inPtxtFile, context); // Note there are alternative methods for deserialization of Ptxt objects. // After initialization // helib::Ptxt deserializedPtxt(publicKey); @@ -198,7 +199,7 @@ int main(int argc, char* argv[]) helib::Ctxt ctxt(publicKey); // Encrypt `data` into the ciphertext - ea.getCx().encrypt(ctxt, publicKey, data); + publicKey.Encrypt(ctxt, ptxt); std::ofstream outCtxtFile; outCtxtFile.open("ctxt.json", std::ios::out); diff --git a/examples/tutorial/CMakeLists.txt b/examples/tutorial/CMakeLists.txt index a20db50bd..0ad54c9fa 100644 --- a/examples/tutorial/CMakeLists.txt +++ b/examples/tutorial/CMakeLists.txt @@ -14,13 +14,16 @@ add_executable(02_ckks_depth 02_ckks_depth.cpp) add_executable(03_ckks_data_movement 03_ckks_data_movement.cpp) add_executable(04_ckks_matmul 04_ckks_matmul.cpp) add_executable(05_ckks_multlowlvl 05_ckks_multlowlvl.cpp) -add_executable(06_ckks_serialization 06_ckks_serialization.cpp) -add_executable(07_ckks_deserialization 07_ckks_deserialization.cpp) +add_executable(06_ckks_complex 06_ckks_complex.cpp) +add_executable(07_ckks_serialization 07_ckks_serialization.cpp) +add_executable(08_ckks_deserialization 08_ckks_deserialization.cpp) target_link_libraries(01_ckks_basics helib) target_link_libraries(02_ckks_depth helib) target_link_libraries(03_ckks_data_movement helib) target_link_libraries(04_ckks_matmul helib) target_link_libraries(05_ckks_multlowlvl helib) -target_link_libraries(06_ckks_serialization helib) -target_link_libraries(07_ckks_deserialization helib) +target_link_libraries(06_ckks_complex helib) +target_link_libraries(07_ckks_serialization helib) +target_link_libraries(08_ckks_deserialization helib) + diff --git a/examples/tutorial/new-api.cpp b/examples/tutorial/new-api.cpp new file mode 100644 index 000000000..24e19a5a6 --- /dev/null +++ b/examples/tutorial/new-api.cpp @@ -0,0 +1,285 @@ + +class EncodedPtxt; +// container holding either a polynomial +// encoding of either a BGV or CKKS constant +// Interface: not really needed for normal users + +class PtxtArray; +// container holding either a either a BGV or CKKS constant +// Interface: see below + +class View +{ + // NOTE: View is really a typedef for EncryptedArray + // but I suggest we start moving away from that + +public: + //========== ENCODING ========= + // BGV-only + void encode(EncodedPtxt& eptxt, const std::vector& array) const; + void encode(EncodedPtxt& eptxt, const std::vector& array) const; + + // CKKS-only encoding functions + // mag: defaults to Norm(array). + // prec: defaults to r=getAlMod().getR(), which + // is usually the same as context.getDefaultPrecision(). + + // mag should be an upper bound on Norm(array). + // If an encoding will be encrypted, the user may wish + // to hide Norm(array) by setting mag to some data-independent + // upper bound. A warning is issued if Norm(array) > mag. + + // The encoding will normally have an accuracy of 2^{-prec}, meaning that + // Norm(array - decode(encode(array))) <= 2^{-prec}. + // Note that prec may be positive, negative, or zero. + // The exact logic is a bit heuristic, and a warning is + // issued if the the accuracy exceeds 2^{-prec}. + + // NOTE: Norm above is the infinity (i.e., max) norm. + + void encode(EncodedPtxt& eptxt, + const std::vector& array, + double mag = -1, + OptLong prec = OptLong()) const; + void encode(EncodedPtxt& eptxt, + const std::vector& array, + double mag = -1, + OptLong prec = OptLong()) const; + + // BGV and CKKS + // The following encoding functions are provided for both + // BGV and CKKS to allow for the creation of "masks". + // For CKKS, mag and prec are set to their default values. + void encode(EncodedPtxt& eptxt, const std::vector& array) const; + void encodeUnitSelector(EncodedPtxt& eptxt, long i) const; + + //========= ENCRYPTING ========== + // BGV only + void encrypt(Ctxt& ctxt, const std::vector& array) const; + void encrypt(Ctxt& ctxt, const std::vector& array) const; + + // CKKS only + // NOTE: mag must be set to non-default value + void encrypt(Ctxt& ctxt, + const std::vector& array, + double mag = -1, + OptLong prec = OptLong()) const; + void encrypt(Ctxt& ctxt, + const std::vector& array, + double mag = -1, + OptLong prec = OptLong()) const; + + //========= DECRYPTING ========== + // BGV-only + void decrypt(const Ctxt& ctxt, + const SecKey& sKey, + std::vector& ptxt) const; + void decrypt(const Ctxt& ctxt, + const SecKey& sKey, + std::vector& ptxt) const; + + // CKKS-only + void decrypt(const Ctxt& ctxt, + const SecKey& sKey, + std::vector& ptxt, + OptLong prec = OptLong()) const; + void decrypt(const Ctxt& ctxt, + const SecKey& sKey, + std::vector& ptxt, + OptLong prec = OptLong()) const; +}; + +// It is recommended to use the PtxtArray class to do encoding, +// encrypting, and decrypting. +// The interface is a bit more uniform and convenient. + +class PtxtArray +{ +public: + // constructors + explicit PtxtArray(const View& view); + explicit PtxtArray(const Context& context); // use default view from context + // NOTE: the View object associated with a PtxtArray + // object never changes + + PtxtArray(const PtxtArray& other); // copy + + // templates that allow construction via convert: + // T can be any type supported by convert(PtxtArray,T) + template + PtxtArray(const View& view, const T& t); + template + PtxtArray(const Context& context, const T& t); + + // assignment + PtxtArray& operator=(const PtxtArray& other); // copy + + // template that allow assignment via load: + // T can be any type supported by PtxtArray::load(T) + template + PtxtArray& operator=(const T& t); + + void randomReal(); + // CKKS only: random number in [0,1] in each slot + + void randomComplex(); + // CKKS only: random number in complex unit sphere in each slot + + void random(); + // BGV: random ring element in each slot + // CKKS: random number in [0,1] in each slot + + // access methods + const View& getView() const; // preferred name + const View& getEA() const; // legacy name + + // The following encode, encrypt, and decrypt operations + // work for both BGV and CKKS + + void encode(EncodedPtxt& eptxt, + double mag = -1, + OptLong prec = OptLong()) const; + // eptxt = encoding of *this + // NOTE: for BGV, mag,prec are ignored + + void encrypt(Ctxt& ctxt, double mag = -1, OptLong prec = OptLong()) const; + // ctxt = encryption of *this + // NOTES: (1) for BGV, mag,prec are ignored; + // (2) for CKKS, default mag is set to 2^(ceil(log2(max(Norm(x),1)))), + // where x is the underlying vector + + void decrypt(const Ctxt& ctxt, const SecKey& sKey, OptLong prec = OptLong()); + // *this = decryption of ctxt under sKey + // prec is ignored for BGV + + // The following are for CKKS only + void decryptReal(const Ctxt& ctxt, + const SecKey& sKey, + OptLong prec = OptLong()); + void decryptComplex(const Ctxt& ctxt, + const SecKey& sKey, + OptLong prec = OptLong()); + void rawDecrypt(const Ctxt& ctxt, const SecKey& sKey); + void rawDecryptReal(const Ctxt& ctxt, const SecKey& sKey); + void rawDecryptComplex(const Ctxt& ctxt, const SecKey& sKey); + + //===== store ===== + // conversion from PtxtArray to std::vector's + + void store(std::vector& vec) const; // BGV only + void store(std::vector& vec) const; // BGV & CKKS + void store(std::vector& vec) const; // CKKS only + void store(std::vector& vec) const; // CKKS only + + // NOTE: For CKKS, conversion to vector projects + // the real part, and conversion to vector projects and + // rounds the real part. + + //===== load ===== + // conversion to PtxtArray from various types + //(this is a much more permissive set of conversions) + + // vectors + void load(const std::vector& vec); // BGV only + void load(const std::vector& vec); // BGV & CKKS + void load(const std::vector& vec); // BGV & CKKS + void load(const std::vector& vec); // CKKS only + void load(const std::vector& vec); // CKKS only + + // scalars: puts the same value in each slot + void load(const NTL::ZZX& scalar); // BGV only + void load(int scalar); // BGV & CKKS + void load(long scalar); // BGV & CKKS + void load(double scalar); // CKKS only + void load(cx_double scalar); // CKKS only + + // NTL vectors of NTL ring types + void load(const NTL::Vec& vec); // BGV only + void load(const NTL::Vec& vec); // BGV only + void load(const NTL::Vec& vec); // BGV only + void load(const NTL::Vec& vec); // BGV only + + // NTL scalar ring types: puts the same value in each slot + void load(NTL::GF2 scalar); // BGV only + void load(const NTL::GF2X& scalar); // BGV only + void load(NTL::zz_p scalar); // BGV only + void load(const NTL::zz_pX& scalar); // BGV only + + // NOTE: for conversion to PtxtArray from vectors, the input + // vector will effectively be truncated or zero-padded to + // match the number of slots in a PtxtArray +}; + +std::ostream& operator<<(std::ostream& s, const PtxtArray& a); + +bool operator==(const PtxtArray& a, const PtxtArray& b); +bool operator!=(const PtxtArray& a, const PtxtArray& b); +// The above are exact comparisons. +// They are not very useful for CKKS. + +// norm and distance functions +double Norm(const PtxtArray& a); +double Distance(const PtxtArray& a, const PtxtArray& b); +// NOTES: +// (1) for BGV, the underlying norm is the trivial norm. +// (2) for CKKS, the underlying norm is the l-infty norm. + +// These functions, together with the functions defined in NumbTh.h, +// allow one to write +a == + Approx(b) + // or + a + != + Approx(b) + + // The Approx function takes two optional parameters: + double tolerance; // default is 0.01 +double floor; // default is 1.0 + +// The expression +a == Approx(b, tolerance, floor) + // is true iff Distance(a,b) <= tolerance*max(Norm(b),floor). + // The idea is that it checks if the relative error is + // at most tolerance, unless Norm(b) itself is too small + // (as determined by floor). + // For BGV, with the default parameters, a == Approx(b) + // is equivalent to an exact equality test. + + // arithmetic: + PtxtArray& + operator+=(PtxtArray& a, const PtxtArray& b); +PtxtArray& operator-=(PtxtArray& a, const PtxtArray& b); +PtxtArray& operator*=(PtxtArray& a, const PtxtArray& b); + +// also for b of of any type T supported by PtxtArray::load(T): +// NOTE: SFINAE is used to truly limit T +template +PtxtArray& operator+=(PtxtArray& a, const T& b); +template +PtxtArray& operator-=(PtxtArray& a, const T& b); +template +PtxtArray& operator*=(PtxtArray& a, const T& b); + +void negate(PtxtArray& a); +void power(PtxtArray& a, long e); + +// data movement +void rotate(PtxtArray& a, long k); +void shift(PtxtArray& a, long k); + +voud rotate1D(PtxtArray& a, long i, long k); +voud shift1D(PtxtArray& a, long i, long k); + +void applyPerm(PtxtArray& a, const NTL::Vec& pi); + +// For CKKS, these use complex conjugation, rather than Frobenius +void frobeniusAutomorph(PtxtArray& a, long j); +void frobeniusAutomorph(PtxtArray& a, const NTL::Vec& vec); +void conjugate(PtxtArray& a); // synonym for frobeniusAutomorph(ctxt, 1); + +void extractRealPart(PtxtArray& a); // CKKS only +void extractImPart(PtxtArray& a); // CKKS only + +void totalSums(PtxtArray& a); +void runningSums(PtxtArray& a); From 84a150546e50ccb835e5c5a7e4d21b8b08d27e7b Mon Sep 17 00:00:00 2001 From: jlhcrawford <54402133+jlhcrawford@users.noreply.github.com> Date: Wed, 13 Jan 2021 17:35:24 +0000 Subject: [PATCH 6/8] PtxtArray serialisation Co-authored-by: Hamish Hunt --- examples/tutorial/07_ckks_serialization.cpp | 9 +- examples/tutorial/08_ckks_deserialization.cpp | 18 +- include/helib/EncryptedArray.h | 31 +- src/EncryptedArray.cpp | 143 ++++++ tests/TestIO.cpp | 417 +++++++++++++++++- 5 files changed, 595 insertions(+), 23 deletions(-) diff --git a/examples/tutorial/07_ckks_serialization.cpp b/examples/tutorial/07_ckks_serialization.cpp index ce453620c..0fa0995ca 100644 --- a/examples/tutorial/07_ckks_serialization.cpp +++ b/examples/tutorial/07_ckks_serialization.cpp @@ -71,15 +71,14 @@ int main(int argc, char* argv[]) std::cout << "\n\n*** Public Key:\n"; std::cout << public_key.writeToJSON().pretty() << std::endl; - // Create a Ptxt data object + // Create a data object std::vector data(context.getNSlots()); // Generate some data std::iota(data.begin(), data.end(), 0); - // Create a ptxt. Note that in this tutorial we make use of the - // alternative ptxt API. - helib::Ptxt ptxt(context, data); + // Create a PtxtArray. + helib::PtxtArray ptxt(context, data); // Print the ptxt to stdout std::cout << "\n\n*** Ptxt:\n"; @@ -89,7 +88,7 @@ int main(int argc, char* argv[]) helib::Ctxt ctxt(public_key); // Encrypt `data` into the ciphertext - public_key.Encrypt(ctxt, ptxt); + ptxt.encrypt(ctxt); // Print the ctxt to stdout std::cout << "\n\n*** Ctxt:\n"; diff --git a/examples/tutorial/08_ckks_deserialization.cpp b/examples/tutorial/08_ckks_deserialization.cpp index dcc0086c2..3620edfae 100644 --- a/examples/tutorial/08_ckks_deserialization.cpp +++ b/examples/tutorial/08_ckks_deserialization.cpp @@ -151,21 +151,23 @@ int main(int argc, char* argv[]) // inspect the file. std::remove("pk.json"); - // Create a Ptxt data object + // Create a data object std::vector data(context.getNSlots()); // Generate some data std::iota(data.begin(), data.end(), 0); - // Create a ptxt. Note that in this tutorial we make use of the - // alternative ptxt API. - helib::Ptxt ptxt(context, data); + // Create a ptxt. + helib::PtxtArray ptxt(context, data); std::ofstream outPtxtFile; outPtxtFile.open("ptxt.json", std::ios::out); if (outPtxtFile.is_open()) { // Write the ptxt to a file ptxt.writeToJSON(outPtxtFile); + // Alternatively one can use + // outPtxtFile << ptxt; + // Close the ofstream outPtxtFile.close(); } else { @@ -176,11 +178,11 @@ int main(int argc, char* argv[]) inPtxtFile.open("ptxt.json"); if (inPtxtFile.is_open()) { // Read in the ptxt from the file - helib::Ptxt deserializedPtxt = - helib::Ptxt::readFromJSON(inPtxtFile, context); + helib::PtxtArray deserializedPtxt = + helib::PtxtArray::readFromJSON(inPtxtFile, context); // Note there are alternative methods for deserialization of Ptxt objects. // After initialization - // helib::Ptxt deserializedPtxt(publicKey); + // helib::PtxtArray deserializedPtxt(publicKey); // One can write // inPtxtFile >> deserializedPtxt; // Or alternatively @@ -199,7 +201,7 @@ int main(int argc, char* argv[]) helib::Ctxt ctxt(publicKey); // Encrypt `data` into the ciphertext - publicKey.Encrypt(ctxt, ptxt); + ptxt.encrypt(ctxt); std::ofstream outCtxtFile; outCtxtFile.open("ctxt.json", std::ios::out); diff --git a/include/helib/EncryptedArray.h b/include/helib/EncryptedArray.h index 9f76e45d4..73df49039 100644 --- a/include/helib/EncryptedArray.h +++ b/include/helib/EncryptedArray.h @@ -2144,6 +2144,12 @@ void runningSums(const EncryptedArray& ea, PlaintextArray& pa); class PtxtArray { public: + /** + * @brief Class label to be added to JSON serialization as object type + * information. + */ + static constexpr std::string_view typeName = "PtxtArray"; + // These two data fields should really be private, but there are // a lot of internal functions that need to access them const EncryptedArray& ea; @@ -2189,6 +2195,8 @@ class PtxtArray const EncryptedArray& getView() const { return ea; } const EncryptedArray& getEA() const { return ea; } + long size() const { return ea.size(); } + // direct encode, encrypt, and decrypt methods void encode(EncodedPtxt& eptxt, double mag = -1, @@ -2256,6 +2264,7 @@ class PtxtArray void random() { helib::random(ea, pa); } //======== load ======== + // Puts vector or scalar data into a PtxtArray void load(const std::vector& array) { @@ -2349,6 +2358,7 @@ class PtxtArray } //============== store ============ + // Puts data into a std::vector aka `unload` void store(std::vector& array) const { decode(ea, array, pa); } @@ -2362,12 +2372,23 @@ class PtxtArray // this is here for consistency with Ctxt class void negate() { helib::negate(ea, pa); } -}; -inline std::ostream& operator<<(std::ostream& s, const PtxtArray& a) -{ - return s << a.pa; -} + void writeToJSON(std::ostream& os) const; + + JsonWrapper writeToJSON() const; + + static PtxtArray readFromJSON(std::istream& is, const Context& context); + + static PtxtArray readFromJSON(const JsonWrapper& jw, const Context& context); + + void readJSON(std::istream& is); + + void readJSON(const JsonWrapper& jw); + + friend std::istream& operator>>(std::istream& is, PtxtArray& pa); + + friend std::ostream& operator<<(std::ostream& os, const PtxtArray& pa); +}; inline void rotate(PtxtArray& a, long k) { rotate(a.ea, a.pa, k); } diff --git a/src/EncryptedArray.cpp b/src/EncryptedArray.cpp index 33083c44e..1d551a97b 100644 --- a/src/EncryptedArray.cpp +++ b/src/EncryptedArray.cpp @@ -19,6 +19,8 @@ #include #include +#include "io.h" + namespace helib { EncryptedArrayBase* buildEncryptedArray(const Context& context, @@ -547,6 +549,147 @@ void EncryptedArrayDerived::initNormalBasisMatrix() const } while (0); } +// PtxtArray member functions + +void PtxtArray::writeToJSON(std::ostream& os) const +{ + executeRedirectJsonError([&]() { os << this->writeToJSON(); }); +} + +JsonWrapper PtxtArray::writeToJSON() const +{ + auto body = [this]() { + json jslots; + + if (ea.isCKKS()) { + // When it is CKKS + std::vector> data; + store(data); + jslots = data; + } else { + // When is it BGV + std::vector data; + store(data); + std::vector> slots(data.size()); + for (std::size_t i = 0; i < data.size(); ++i) { + long deg = NTL::deg(data[i]); + if (deg == -1) { + slots[i].emplace_back(0); + } + for (long j = 0; j <= deg; ++j) { + slots[i].emplace_back(NTL::conv(data[i][j])); + } + } + jslots = slots; + } + + json j{{"scheme", (ea.isCKKS() ? "CKKS" : "BGV")}, {"slots", jslots}}; + + return wrap(toTypedJson(j)); + }; + + return executeRedirectJsonError(body); +} + +PtxtArray PtxtArray::readFromJSON(std::istream& is, const Context& context) +{ + PtxtArray ret{context}; + ret.readJSON(is); + return ret; +} + +PtxtArray PtxtArray::readFromJSON(const JsonWrapper& tjw, + const Context& context) +{ + PtxtArray ret{context}; + ret.readJSON(tjw); + return ret; +} + +void PtxtArray::readJSON(std::istream& is) +{ + executeRedirectJsonError([&]() { + json j; + is >> j; + this->readJSON(wrap(j)); + }); +} + +void PtxtArray::readJSON(const JsonWrapper& tjw) +{ + auto body = [&]() { + json tj = unwrap(tjw); + json jslots; + // if the input is just an array short-circuit to slot deserialization + // (assuming there is no type-header). + if (tj.is_array()) { + jslots = tj; + + } else { + json j = fromTypedJson(tj); + + std::string expected_scheme{j.at("scheme").get()}; + assertTrue( + expected_scheme == (ea.isCKKS() ? "CKKS" : "BGV"), + "Scheme mismatch in deserialization.\nExpected: " + expected_scheme + + ", actual: " + std::string(ea.isCKKS() ? "CKKS" : "BGV") + "."); + + jslots = j.at("slots"); + + if (!jslots.is_array()) { + throw IOError("Slot content is not a JSON array"); + } + } + + if (static_cast(jslots.size()) > this->getEA().size()) { + std::stringstream err_msg; + err_msg << "Cannot deserialize to PtxtArray: not enough slots. " + << "Trying to deserialize " << jslots.size() << " elements. " + << "Got " << this->getEA().size() << " slots."; + throw IOError(err_msg.str()); + } + + if (ea.isCKKS()) { + // Scheme is CKKS + this->load(jslots.get>>()); + } else { + // Scheme is BGV + auto json2data = [](const json& jslots) { + std::vector data; + data.reserve(jslots.size()); + for (const auto& jslot : jslots) { + NTL::ZZX slot; + if (jslot.is_array()) { + for (std::size_t i = 0; i < jslot.size(); ++i) { + NTL::SetCoeff(slot, i, static_cast(jslot[i])); + } + } else { + // Slot is a single number + slot = static_cast(jslot); + } + data.emplace_back(slot); + } + return data; + }; + this->load(json2data(jslots)); + } + }; + + executeRedirectJsonError(body); +} + +std::istream& operator>>(std::istream& is, PtxtArray& pa) +{ + pa.readJSON(is); + return is; +} + +std::ostream& operator<<(std::ostream& os, const PtxtArray& pa) +{ + pa.writeToJSON(os); + return os; +} + // Other functions... void runningSums(const EncryptedArray& ea, Ctxt& ctxt) diff --git a/tests/TestIO.cpp b/tests/TestIO.cpp index e69617804..72ebcdc12 100644 --- a/tests/TestIO.cpp +++ b/tests/TestIO.cpp @@ -13,6 +13,8 @@ /* Note this file only tests JSON (de)serialization.*/ /* If you are searching for binary (de)serialization go to TestBinIO.cpp*/ +#include + #include #include #include @@ -22,11 +24,49 @@ namespace { -std::string addHeader(const std::string& data, const std::string& scheme) +// Returns the data vector and the expected string for BGV +static std::pair, std::string> createData(long size, + long p2r, + long deg) +{ + std::vector data(size); + std::stringstream ss; + ss << "["; + for (long i = 0; i < size; ++i) { + NTL::ZZX input; + NTL::SetCoeff(input, 0, i % p2r); + ss << "[" << (i % p2r); + long num = (i + 2) % p2r; + if (deg != 1 && num != 0) { + NTL::SetCoeff(input, 1, num); + ss << "," << num; + } + data[i] = input; + ss << "]" << (i != size - 1 ? "," : ""); + } + ss << "]"; + + return {std::move(data), ss.str()}; +} + +// Returns the data vector and the expected string for CKKS +static std::vector> createData(long size) +{ + std::vector> data(size); + for (long i = 0; i < size; ++i) { + data[i] = {(i + 2) / 10.0, (2 * i) / 2.5}; + } + + return data; +} + +static std::string addHeader(const std::string& data, + const std::string& scheme, + const std::string& type = "Ptxt") { return "{\"HElibVersion\":\"" + std::string(helib::version::asString) + "\",\"content\":{\"scheme\":\"" + scheme + "\",\"slots\":" + data + - "},\"serializationVersion\":\"0.0.1\",\"type\":\"Ptxt\"}"; + "},\"serializationVersion\":\"0.0.1\",\"type\":\"" + type + "\"}"; } struct BGVParameters @@ -217,6 +257,7 @@ TEST(TestIO, TypedJSONLabelsAreTypeNames) EXPECT_EQ(helib::SecKey::typeName, "SecKey"); EXPECT_EQ(helib::KeySwitch::typeName, "KeySwitch"); EXPECT_EQ(helib::Ptxt::typeName, "Ptxt"); + EXPECT_EQ(helib::PtxtArray::typeName, "PtxtArray"); } TEST(TestIO, toTypedJSONWorks) @@ -238,6 +279,8 @@ TEST(TestIO, toTypedJSONWorks) helib::KeySwitch::typeName); EXPECT_EQ(helib::toTypedJson>(jcont).at("type"), helib::Ptxt::typeName); + EXPECT_EQ(helib::toTypedJson(jcont).at("type"), + helib::PtxtArray::typeName); EXPECT_EQ( helib::toTypedJson(jcont).at("serializationVersion"), @@ -274,6 +317,9 @@ TEST(TestIO, fromTypedJSONWorks) EXPECT_EQ(helib::fromTypedJson>( helib::toTypedJson>(jcont)), jcont); + EXPECT_EQ(helib::fromTypedJson( + helib::toTypedJson(jcont)), + jcont); EXPECT_EQ(helib::fromTypedJson( helib::toTypedJson(jcont)), @@ -300,6 +346,7 @@ TEST(TestIO, fromTypedJSONThrowsWhenMetadataIsWrong) EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); EXPECT_THROW(helib::fromTypedJson>(tj), helib::IOError); + EXPECT_THROW(helib::fromTypedJson(tj), helib::IOError); tj = tj_orig; std::stringstream ss; @@ -1089,6 +1136,237 @@ TEST_P(TestIO_BGV, ptxtReadsManyPtxtsFromStream) EXPECT_EQ(ptxt3, deserialized3); } +// This test should be moved to a set of PtxtArray tests +TEST(TestPtxtArray, ptxtArrayLoadsDataWithLessSlotsThanMax) +{ + // nslots = 18 + helib::Context context = + helib::ContextBuilder().m(127).p(2).build(); + + std::vector data(10, 1); + helib::PtxtArray pa(context); + + EXPECT_NO_THROW(pa.store(data)); +} + +TEST_P(TestIO_BGV, ptxtArrayWritesDataCorrectlyToOstream) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + + auto [data, expectedString] = createData(context.getNSlots(), p2r, d); + + std::string expected = addHeader(expectedString, "BGV", "PtxtArray"); + + helib::PtxtArray pa(context, data); + std::ostringstream os; + os << pa; + + EXPECT_EQ(os.str(), expected); +} + +TEST_P(TestIO_BGV, ptxtArrayReadsDataCorrectlyFromIstream) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + + auto [data, expectedString] = createData(context.getNSlots(), p2r, d); + + helib::PtxtArray pa(context); + std::string expected = addHeader(expectedString, "BGV", "PtxtArray"); + std::stringstream ss(expectedString); + ss >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_BGV, ptxtArrayReadsJSONVectorFromIstream) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + + auto [data, expectedString] = createData(context.getNSlots(), p2r, d); + + helib::PtxtArray pa(context); + std::stringstream ss(expectedString); + ss >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_BGV, ptxtArrayWriteToJSONFunctionSerializesPtxtCorrectly) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + + auto [data, expectedString] = createData(context.getNSlots(), p2r, d); + + helib::PtxtArray pa(context, data); + + std::stringstream ss; + pa.writeToJSON(ss); + + EXPECT_EQ(ss.str(), addHeader(expectedString, "BGV", "PtxtArray")); +} + +TEST_P(TestIO_BGV, ptxtArrayReadFromJSONFunctionDeserializesPtxtCorrectly) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + + auto [data, expectedString] = createData(context.getNSlots(), p2r, d); + + std::string expected = addHeader(expectedString, "BGV", "PtxtArray"); + std::stringstream ss(expectedString); + + helib::PtxtArray pa(context, data); + helib::PtxtArray deserialized_pa = + helib::PtxtArray::readFromJSON(ss, context); + + EXPECT_EQ(pa, deserialized_pa); +} + +TEST_P(TestIO_BGV, ptxtArrayReadFromJSONFunctionThrowsIfMoreElementsThanSlots) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + std::string expectedString; + + std::tie(std::ignore, expectedString) = + createData(context.getNSlots() + 1, p2r, d); + + std::stringstream ss(addHeader(expectedString, "BGV", "PtxtArray")); + + EXPECT_THROW(helib::PtxtArray::readFromJSON(ss, context), helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtArrayRightShiftOperatorThrowsIfMoreElementsThanSlots) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + std::string expectedString; + + std::tie(std::ignore, expectedString) = + createData(context.getNSlots() + 1, p2r, d); + + std::stringstream ss(addHeader(expectedString, "BGV", "PtxtArray")); + helib::PtxtArray pa(context); + + EXPECT_THROW(ss >> pa, helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtArrayWriteToJSONCorrectlyWritesMetdata) +{ + helib::PtxtArray pa(context); + std::stringstream ss; + ss << pa; + json j; + ss >> j; + + EXPECT_TRUE(j.contains("type")); + EXPECT_EQ(j.at("type").get(), helib::PtxtArray::typeName); + + EXPECT_TRUE(j.contains("serializationVersion")); + EXPECT_EQ(j.at("serializationVersion").get(), + helib::jsonSerializationVersion); + + EXPECT_TRUE(j.contains("HElibVersion")); + EXPECT_EQ(j.at("HElibVersion").get(), helib::version::asString); + + j = j.at("content"); + EXPECT_TRUE(j.contains("scheme")); + EXPECT_EQ(j.at("scheme").get(), helib::BGV::schemeName); + + EXPECT_TRUE(j.contains("slots")); + EXPECT_EQ(j.at("slots").size(), ea.size()); +} + +TEST_P(TestIO_BGV, ptxtArrayReadFromJSONFailsWhenBadMetadata) +{ + const long p2r = context.getSlotRing()->p2r; + const long d = context.getOrdP(); + std::vector data; + + std::tie(data, std::ignore) = createData(context.getNSlots(), p2r, d); + + helib::PtxtArray pa(context, data); + helib::JsonWrapper jw = pa.writeToJSON(); + + helib::PtxtArray destPa(context); + json jmod = unwrap(jw); + jmod.at("type") = "wrong"; + EXPECT_THROW(destPa.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("serializationVersion") = "wrong"; + EXPECT_THROW(destPa.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("HElibVersion") = "wrong"; + EXPECT_THROW(destPa.readJSON(helib::wrap(jmod)), helib::IOError); + + jmod = unwrap(jw); + jmod.at("content") = "wrong"; + EXPECT_THROW(destPa.readJSON(helib::wrap(jmod)), helib::IOError); +} + +TEST_P(TestIO_BGV, ptxtArrayReadFromJSONCorrectlyPadsData) +{ + std::stringstream ss(addHeader("[]", "BGV", "PtxtArray")); + helib::PtxtArray pa(context); + ss >> pa; + + EXPECT_EQ(pa.size(), ea.size()); + + ss.str(""); + ss.clear(); + + std::vector data(context.getNSlots() / 2, 1); + json j = data; + ss.str(addHeader(j.dump(), "BGV", "PtxtArray")); + ss >> pa; + + EXPECT_EQ(pa.size(), ea.size()); + std::vector deserialized; + pa.store(deserialized); + + EXPECT_EQ(pa.size(), deserialized.size()); + + for (long i = 0; i < pa.size(); ++i) { + if (i < static_cast(data.size())) { + EXPECT_EQ(deserialized[i], 1); + } else { + EXPECT_EQ(deserialized[i], {}); + } + } +} + +TEST_P(TestIO_BGV, ptxtArrayReadsManyPtxtsFromStream) +{ + helib::PtxtArray pa1(context); + helib::PtxtArray pa2(context); + helib::PtxtArray pa3(context); + pa1.random(); + pa2.random(); + pa3.random(); + + std::stringstream ss; + ss << pa1 << std::endl; + ss << pa2 << std::endl; + ss << pa3 << std::endl; + + helib::PtxtArray deserialized1(context); + helib::PtxtArray deserialized2(context); + helib::PtxtArray deserialized3(context); + ss >> deserialized1; + ss >> deserialized2; + ss >> deserialized3; + + EXPECT_EQ(pa1, deserialized1); + EXPECT_EQ(pa2, deserialized2); + EXPECT_EQ(pa3, deserialized3); +} + TEST_P(TestIO_CKKS, serializeContextWithStreamOperator) { std::stringstream strm; @@ -1374,13 +1652,18 @@ TEST_P(TestIO_CKKS, ptxtReadsDataCorrectlyFromIstream) TEST_P(TestIO_CKKS, ptxtReadsSquareBracketsDataCorrectly) { std::vector> data(context.getEA().size()); + std::stringstream ss; + + ss << "[" << std::setprecision(std::numeric_limits::max_digits10); for (std::size_t i = 0; i < data.size(); ++i) { data[i] = {(i * i) / 10.0, (i * i * i) / 7.5}; + ss << "[" << data[i].real() << "," << data[i].imag() << "]" + << (i != data.size() - 1 ? "," : ""); } + ss << "]"; + helib::Ptxt ptxt(context); - json j = data; - std::string expected = addHeader(j.dump(), "CKKS"); - std::istringstream is(expected); + std::istringstream is(ss.str()); is >> ptxt; COMPARE_CXDOUBLE_VECS(ptxt, data); @@ -1503,6 +1786,130 @@ TEST_P(TestIO_CKKS, ptxtReadsManyPtxtsFromStream) COMPARE_CXDOUBLE_VECS(ptxt3, deserialized3); } +TEST_P(TestIO_CKKS, ptxtArrayWritesDataCorrectlyToOstream) +{ + auto data = createData(context.getNSlots()); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS", "PtxtArray"); + + helib::PtxtArray pa(context, data); + std::ostringstream os; + os << pa; + + EXPECT_EQ(os.str(), expected); +} + +TEST_P(TestIO_CKKS, ptxtArrayReadsDataCorrectlyFromIstream) +{ + auto data = createData(context.getNSlots()); + helib::PtxtArray pa(context); + json j = data; + std::stringstream ss; + ss << addHeader(j.dump(), "CKKS", "PtxtArray"); + std::istringstream is(ss.str()); + is >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_CKKS, ptxtArrayReadsSquareBracketsDataCorrectly) +{ + auto data = createData(context.getNSlots()); + + std::stringstream ss; + ss << "[" << std::setprecision(std::numeric_limits::digits10); + for (auto it = data.begin(); it != data.end(); ++it) { + ss << "[" << it->real() << "," << it->imag() << "]" + << (it != data.end() - 1 ? "," : ""); + } + ss << "]"; + + helib::PtxtArray pa(context); + std::istringstream is(ss.str()); + is >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_CKKS, ptxtArrayWriteToJSONSerializesPtxtCorrectly) +{ + auto data = createData(context.getNSlots()); + helib::PtxtArray pa(context, data); + json j = data; + std::string expected = addHeader(j.dump(), "CKKS", "PtxtArray"); + std::stringstream ss; + pa.writeToJSON(ss); + + EXPECT_EQ(ss.str(), expected); +} + +TEST_P(TestIO_CKKS, ptxtArrayRightShiftDeserializeCorrectly) +{ + auto data = createData(context.getNSlots()); + helib::PtxtArray pa(context); + json j = data; + std::istringstream is(addHeader(j.dump(), "CKKS", "PtxtArray")); + is >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_CKKS, ptxtArrayReadsJSONVectorFromIstream) +{ + auto data = createData(context.getNSlots()); + helib::PtxtArray pa(context); + json j = data; + std::istringstream is(j.dump()); + is >> pa; + + EXPECT_EQ(pa, helib::PtxtArray(context, data)); +} + +TEST_P(TestIO_CKKS, ptxtArrayReadFromJSONThrowsIfMoreElementsThanSlots) +{ + auto data = createData(context.getNSlots() + 1); + json j = data; + std::istringstream is(j.dump()); + + EXPECT_THROW(helib::PtxtArray::readFromJSON(is, context), helib::IOError); +} + +TEST_P(TestIO_CKKS, ptxtArrayRightShiftOperatorThrowsIfMoreElementsThanSlots) +{ + auto data = createData(context.getNSlots() + 1); + helib::PtxtArray pa(context); + json j = data; + std::istringstream is(j.dump()); + + EXPECT_THROW(is >> pa, helib::IOError); +} + +TEST_P(TestIO_CKKS, ptxtArrayReadsManyPtxtsFromStream) +{ + helib::PtxtArray pa1(context); + helib::PtxtArray pa2(context); + helib::PtxtArray pa3(context); + pa1.random(); + pa2.random(); + pa3.random(); + + std::stringstream ss; + ss << pa1 << std::endl; + ss << pa2 << std::endl; + ss << pa3 << std::endl; + + helib::PtxtArray deserialized1(context); + helib::PtxtArray deserialized2(context); + helib::PtxtArray deserialized3(context); + ss >> deserialized1; + ss >> deserialized2; + ss >> deserialized3; + + EXPECT_EQ(pa1, deserialized1); + EXPECT_EQ(pa2, deserialized2); + EXPECT_EQ(pa3, deserialized3); +} + TEST_P(TestIO_BGV, contextBuilderLogsCorrectly) { long c = 3; From 5fe2a8a966159103b3a766f7566a2bb130f852d9 Mon Sep 17 00:00:00 2001 From: Flavio Bergamaschi Date: Tue, 19 Jan 2021 10:44:02 -0500 Subject: [PATCH 7/8] v2.0.0 Release Docs Updates * v2.0.0 Release Docs Updates Co-authored-by: Hamish Hunt Co-authored-by: Jack Crawford --- CHANGES.md | 7 ++++--- CONTRIBUTING.md | 7 +++---- README.md | 14 ++++++++++---- examples/README.md | 17 ++++++++++------- include/helib/NumbTh.h | 11 +---------- 5 files changed, 28 insertions(+), 28 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 81ce7f330..dd61799fa 100644 --- a/CHANGES.md +++ b/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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3034f3f20..fdaa42446 100644 --- a/CONTRIBUTING.md +++ b/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. - diff --git a/README.md b/README.md index 47be27881..235116c61 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ HElib ===== -[![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" + diff --git a/examples/README.md b/examples/README.md index 3617f39d8..6ddaae558 100644 --- a/examples/README.md +++ b/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. diff --git a/include/helib/NumbTh.h b/include/helib/NumbTh.h index 725318da2..415987041 100644 --- a/include/helib/NumbTh.h +++ b/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 -std::unique_ptr build_unique(Args&&... args) -{ - return std::unique_ptr(new T(std::forward(args)...)); -} -#endif - -// Generic routines for domputing absolute values and distances +// Generic routines for computing absolute values and distances // on real and complex numbers template From 0232d6043a3c4af2455f81b732f16c4ecdd59d75 Mon Sep 17 00:00:00 2001 From: Flavio Bergamaschi Date: Tue, 19 Jan 2021 13:45:15 -0500 Subject: [PATCH 8/8] v2.0.0 Release Docs Updates * Doxygen Docs Updates --- CHANGES.md | 5 +++-- documentation/Doxyfile | 3 +++ documentation/mainpage.dox | 15 ++++++++------- examples/README.md | 2 +- 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index dd61799fa..c4240e5c5 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,9 +1,10 @@ +Release Changes +=============== + HElib 2.0.0, January 2021 ========================= (tagged as v2.0.0) -December-January 2021 ---------------------- * Contains API changes that are not backwards compatible with v1.x.x * Changes to Context API * Must use ContextBuilder to build context diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 5f5800f6c..253b5cc7f 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -827,12 +827,15 @@ INPUT = ./mainpage.dox \ ../CONTRIBUTING.md \ ../CODE_OF_CONDUCT.md \ ../LICENSE.md \ + ../CHANGES.md \ ../INSTALL.md \ ../TESTS.md \ + ../examples/README.md \ ../include/helib \ ../src \ ../utils \ ../misc/psi \ + ../CKKS-security.md \ ../ISSUES.md # This tag can be used to specify the character encoding of the source files diff --git a/documentation/mainpage.dox b/documentation/mainpage.dox index 1b3bc192d..d830f91f1 100644 --- a/documentation/mainpage.dox +++ b/documentation/mainpage.dox @@ -2,17 +2,19 @@ @mainpage HElib Documentation HElib is an open-source (Apache License v2.0) -software library that implements homomorphic encryption (HE). +software library that implements homomorphic encryption (HE). Currently available schemes are the implementations of the -Brakerski-Gentry-Vaikuntanathan (BGV) scheme and the Approximate Number +Brakerski-Gentry-Vaikuntanathan (BGV) scheme with bootstrapping and the Approximate Number scheme of Cheon-Kim-Kim-Song (CKKS), along with many optimizations to make homomorphic evaluation runs faster, focusing mostly on effective use of the Smart-Vercauteren ciphertext packing techniques and -the Gentry-Halevi-Smart optimizations. +the Gentry-Halevi-Smart optimizations. + +Please refer to CKKS-security.md for the latest discussion on the security of the CKKS scheme implementation in HElib. Articles that describe some aspects of HElib include: - - HElib Design Principles, Shai Halevi and Victor Shoup, August 2020. + - HElib Design Principles, Shai Halevi and Victor Shoup, November 2020. - Algorithms in HElib, Shai Halevi and Victor Shoup, published in CRYPTO 2014. - Bootstrapping for HElib, Shai Halevi and Victor Shoup, EUROCRYPT 2015. @@ -24,12 +26,11 @@ HElib supports an "assembly language for HE", providing low-level routine (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 for more details. -HElib is written in C++14 and uses the NTL mathematical library. +HElib is written in C++17 and uses the NTL mathematical library. HElib is distributed under the terms of the Apache License v2.0. -For code downloads and full installation instructions, visit HElib GitHub Pages. +For code downloads, full installation instructions, example programs and tutorials, visit HElib GitHub Pages. **/ diff --git a/examples/README.md b/examples/README.md index 6ddaae558..0409d3e49 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,4 @@ -# Examples +# Examples and Tutorials ## Introduction