From a06f044af12022344a58e1d09281d506edf26bae Mon Sep 17 00:00:00 2001 From: Oliver P Masters Date: Fri, 29 Nov 2019 10:15:39 +0000 Subject: [PATCH 01/15] Test renaming (#235) * Changed naming convention from snake case to camel case * Removed underscores from test names * Removed duplicate test names * Refactored CMakeLists --- src/tests/CMakeLists.txt | 113 ++++++------ ...est_approxNums.cpp => GTestApproxNums.cpp} | 14 +- .../{GTest_Bin_IO.cpp => GTestBinIO.cpp} | 18 +- ...t_binaryArith.cpp => GTestBinaryArith.cpp} | 20 +-- ...naryCompare.cpp => GTestBinaryCompare.cpp} | 12 +- ...otstrapping.cpp => GTestBootstrapping.cpp} | 14 +- src/tests/{GTest_EaCx.cpp => GTestEaCx.cpp} | 8 +- .../{GTest_EvalMap.cpp => GTestEvalMap.cpp} | 8 +- ...tractDigits.cpp => GTestExtractDigits.cpp} | 10 +- .../{GTest_fatboot.cpp => GTestFatboot.cpp} | 10 +- .../{GTest_General.cpp => GTestGeneral.cpp} | 8 +- src/tests/{GTest_IO.cpp => GTestIO.cpp} | 12 +- ...GTest_intraSlot.cpp => GTestIntraSlot.cpp} | 8 +- .../{GTest_matmul.cpp => GTestMatmul.cpp} | 8 +- .../{GTest_PAlgebra.cpp => GTestPAlgebra.cpp} | 8 +- src/tests/{GTest_PGFFT.cpp => GTestPGFFT.cpp} | 6 +- ...Permutations.cpp => GTestPermutations.cpp} | 8 +- .../{GTest_PolyEval.cpp => GTestPolyEval.cpp} | 10 +- .../{GTest_Powerful.cpp => GTestPowerful.cpp} | 10 +- ...GTest_PtrVector.cpp => GTestPtrVector.cpp} | 6 +- ...GTest_Replicate.cpp => GTestReplicate.cpp} | 14 +- ...t_tableLookup.cpp => GTestTableLookup.cpp} | 12 +- ...rapping.cpp => GTestThinBootstrapping.cpp} | 12 +- ...t_ThinEvalMap.cpp => GTestThinEvalMap.cpp} | 8 +- .../{GTest_thinboot.cpp => GTestThinboot.cpp} | 10 +- src/tests/{Test_ArgMap.cpp => TestArgMap.cpp} | 64 +++---- ... TestBootstrappingWithMultiplications.cpp} | 20 +-- src/tests/{Test_CKKS.cpp => TestCKKS.cpp} | 32 ++-- .../{Test_Context.cpp => TestContext.cpp} | 6 +- ...rrorHandling.cpp => TestErrorHandling.cpp} | 170 +++++++++--------- 30 files changed, 330 insertions(+), 329 deletions(-) rename src/tests/{GTest_approxNums.cpp => GTestApproxNums.cpp} (97%) rename src/tests/{GTest_Bin_IO.cpp => GTestBinIO.cpp} (96%) rename src/tests/{GTest_binaryArith.cpp => GTestBinaryArith.cpp} (98%) rename src/tests/{GTest_binaryCompare.cpp => GTestBinaryCompare.cpp} (96%) rename src/tests/{GTest_bootstrapping.cpp => GTestBootstrapping.cpp} (97%) rename src/tests/{GTest_EaCx.cpp => GTestEaCx.cpp} (94%) rename src/tests/{GTest_EvalMap.cpp => GTestEvalMap.cpp} (97%) rename src/tests/{GTest_extractDigits.cpp => GTestExtractDigits.cpp} (94%) rename src/tests/{GTest_fatboot.cpp => GTestFatboot.cpp} (97%) rename src/tests/{GTest_General.cpp => GTestGeneral.cpp} (97%) rename src/tests/{GTest_IO.cpp => GTestIO.cpp} (97%) rename src/tests/{GTest_intraSlot.cpp => GTestIntraSlot.cpp} (94%) rename src/tests/{GTest_matmul.cpp => GTestMatmul.cpp} (98%) rename src/tests/{GTest_PAlgebra.cpp => GTestPAlgebra.cpp} (93%) rename src/tests/{GTest_PGFFT.cpp => GTestPGFFT.cpp} (98%) rename src/tests/{GTest_Permutations.cpp => GTestPermutations.cpp} (98%) rename src/tests/{GTest_PolyEval.cpp => GTestPolyEval.cpp} (94%) rename src/tests/{GTest_Powerful.cpp => GTestPowerful.cpp} (96%) rename src/tests/{GTest_PtrVector.cpp => GTestPtrVector.cpp} (97%) rename src/tests/{GTest_Replicate.cpp => GTestReplicate.cpp} (94%) rename src/tests/{GTest_tableLookup.cpp => GTestTableLookup.cpp} (97%) rename src/tests/{GTest_ThinBootstrapping.cpp => GTestThinBootstrapping.cpp} (97%) rename src/tests/{GTest_ThinEvalMap.cpp => GTestThinEvalMap.cpp} (97%) rename src/tests/{GTest_thinboot.cpp => GTestThinboot.cpp} (98%) rename src/tests/{Test_ArgMap.cpp => TestArgMap.cpp} (87%) rename src/tests/{Test_bootstrapping_with_multiplications.cpp => TestBootstrappingWithMultiplications.cpp} (92%) rename src/tests/{Test_CKKS.cpp => TestCKKS.cpp} (93%) rename src/tests/{Test_Context.cpp => TestContext.cpp} (90%) rename src/tests/{Test_errorHandling.cpp => TestErrorHandling.cpp} (64%) diff --git a/src/tests/CMakeLists.txt b/src/tests/CMakeLists.txt index 5844bfd46..670773039 100644 --- a/src/tests/CMakeLists.txt +++ b/src/tests/CMakeLists.txt @@ -2,38 +2,38 @@ set(GTEST_SRC "test_common.cpp" - "Test_errorHandling.cpp" - "Test_CKKS.cpp" - "Test_ArgMap.cpp" - "Test_bootstrapping_with_multiplications.cpp" - "Test_Context.cpp" + "TestErrorHandling.cpp" + "TestCKKS.cpp" + "TestArgMap.cpp" + "TestBootstrappingWithMultiplications.cpp" + "TestContext.cpp" ) set(PORTED_LEGACY_TEST_SRC - "GTest_Bin_IO.cpp" - "GTest_EaCx.cpp" - "GTest_EvalMap.cpp" - "GTest_General.cpp" - "GTest_IO.cpp" - "GTest_PAlgebra.cpp" - "GTest_Permutations.cpp" - "GTest_PolyEval.cpp" - "GTest_Powerful.cpp" - "GTest_PtrVector.cpp" - "GTest_Replicate.cpp" - "GTest_ThinBootstrapping.cpp" - "GTest_thinboot.cpp" - "GTest_fatboot.cpp" - "GTest_PGFFT.cpp" - "GTest_ThinEvalMap.cpp" - "GTest_approxNums.cpp" - "GTest_binaryArith.cpp" - "GTest_binaryCompare.cpp" - "GTest_bootstrapping.cpp" - "GTest_extractDigits.cpp" - "GTest_intraSlot.cpp" - "GTest_matmul.cpp" - "GTest_tableLookup.cpp" + "GTestApproxNums.cpp" + "GTestBinaryArith.cpp" + "GTestBinaryCompare.cpp" + "GTestBinIO.cpp" + "GTestBootstrapping.cpp" + "GTestEaCx.cpp" + "GTestEvalMap.cpp" + "GTestExtractDigits.cpp" + "GTestFatboot.cpp" + "GTestGeneral.cpp" + "GTestIntraSlot.cpp" + "GTestIO.cpp" + "GTestMatmul.cpp" + "GTestPAlgebra.cpp" + "GTestPermutations.cpp" + "GTestPGFFT.cpp" + "GTestPolyEval.cpp" + "GTestPowerful.cpp" + "GTestPtrVector.cpp" + "GTestReplicate.cpp" + "GTestTableLookup.cpp" + "GTestThinboot.cpp" + "GTestThinBootstrapping.cpp" + "GTestThinEvalMap.cpp" ) # Adding the test binary target @@ -43,35 +43,36 @@ target_link_libraries(runTests gtest) target_link_libraries(runTests helib) set(TEST_NAMES - "GTest_Bin_IO" - "GTest_EaCx" - "GTest_EvalMap" - "GTest_General" - "GTest_IO" - "GTest_PAlgebra" - "GTest_Permutations" - "GTest_PolyEval" - "GTest_Powerful" - "GTest_PtrVector" - "GTest_Replicate" - "GTest_ThinBootstrapping" - "GTest_thinboot" - "GTest_fatboot" + "GTestApproxNums" + "GTestBinaryArith" + "GTestBinaryCompare" + "GTestBinIO" + "GTestBootstrapping" + "GTestEaCx" + "GTestEvalMap" + "GTestExtractDigits" + "GTestFatboot" + "GTestGeneral" + "GTestIntraSlot" + "GTestIO" + "GTestMatmul" + "GTestPAlgebra" + "GTestPermutations" "GTestPGFFT" - "GTest_ThinEvalMap" - "GTest_approxNums" - "GTest_binaryArith" - "GTest_binaryCompare" - "GTest_bootstrapping" - "GTest_extractDigits" - "GTest_intraSlot" - "GTest_matmul" - "GTest_tableLookup" - "Test_errorHandling" - "Test_CKKS" - "Test_ArgMap" - "Test_bootstrapping_with_multiplications" + "GTestPolyEval" + "GTestPowerful" + "GTestPtrVector" + "GTestReplicate" + "GTestTableLookup" + "GTestThinboot" + "GTestThinBootstrapping" + "GTestThinEvalMap" + "TestArgMap" + "TestCKKS" "TestContext" + "TestErrorHandling" + "TestFatBootstrappingWithMultiplications" + "TestThinBootstrappingWithMultiplications" ) foreach(TEST_NAME ${TEST_NAMES}) diff --git a/src/tests/GTest_approxNums.cpp b/src/tests/GTestApproxNums.cpp similarity index 97% rename from src/tests/GTest_approxNums.cpp rename to src/tests/GTestApproxNums.cpp index 34e6fbbe0..5fa2a6b5f 100644 --- a/src/tests/GTest_approxNums.cpp +++ b/src/tests/GTestApproxNums.cpp @@ -151,7 +151,7 @@ struct Parameters { p = tmp; } -class GTest_approxNums : public ::testing::TestWithParam { +class GTestApproxNums : public ::testing::TestWithParam { protected: const long R; const long m; @@ -164,7 +164,7 @@ class GTest_approxNums : public ::testing::TestWithParam { const helib::FHEPubKey publicKey; const helib::EncryptedArrayCx& ea; - GTest_approxNums () : + GTestApproxNums () : R(GetParam().R), m(GetParam().m), r(GetParam().r), @@ -201,7 +201,7 @@ class GTest_approxNums : public ::testing::TestWithParam { }; -TEST_P(GTest_approxNums, basic_arithmetic_works) +TEST_P(GTestApproxNums, basicArithmeticWorks) { if (helib_test::verbose) std::cout << "Test Arithmetic "; // Test objects @@ -273,7 +273,7 @@ TEST_P(GTest_approxNums, basic_arithmetic_works) << ", maxDiff=" << calcMaxDiff(vd,vd1) << std::endl << std::endl; } -TEST_P(GTest_approxNums, complex_arithmetic_works) +TEST_P(GTestApproxNums, complexArithmeticWorks) { // Test complex conjugate helib::Ctxt c1(publicKey), c2(publicKey); @@ -333,7 +333,7 @@ TEST_P(GTest_approxNums, complex_arithmetic_works) << ", maxDiff=" << calcMaxDiff(imParts,im_dec) << std::endl << std::endl; } -TEST_P(GTest_approxNums, rotates_and_shifts_work) +TEST_P(GTestApproxNums, rotatesAndShiftsWork) { std::srand(std::time(0)); // set seed, current time. int nplaces = rand() % static_cast(ea.size()/2.0) + 1; @@ -365,7 +365,7 @@ TEST_P(GTest_approxNums, rotates_and_shifts_work) << ", maxDiff=" << calcMaxDiff(vd_dec,vd1) << std::endl << std::endl; } -TEST_P(GTest_approxNums, general_ops_works) { +TEST_P(GTestApproxNums, generalOpsWorks) { /************** Each round consists of the following: 1. c1.multiplyBy(c0) 2. c0 += random constant @@ -530,7 +530,7 @@ TEST_P(GTest_approxNums, general_ops_works) { helib::resetAllTimers(); } -INSTANTIATE_TEST_SUITE_P(typical_parameters, GTest_approxNums, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, GTestApproxNums, ::testing::Values( //SLOW Parameters(1, 1024, 8, 150, 0.01) //FAST diff --git a/src/tests/GTest_Bin_IO.cpp b/src/tests/GTestBinIO.cpp similarity index 96% rename from src/tests/GTest_Bin_IO.cpp rename to src/tests/GTestBinIO.cpp index f850b7868..2918edcda 100644 --- a/src/tests/GTest_Bin_IO.cpp +++ b/src/tests/GTestBinIO.cpp @@ -123,7 +123,7 @@ struct Parameters { }; -class GTest_Bin_IO : public ::testing::TestWithParam { +class GTestBinIO : public ::testing::TestWithParam { protected: const long m; const long r; @@ -154,7 +154,7 @@ class GTest_Bin_IO : public ::testing::TestWithParam { return testResourcePath; }; - GTest_Bin_IO () : + GTestBinIO () : m(GetParam().m), r(GetParam().r), p(GetParam().p), @@ -185,13 +185,13 @@ class GTest_Bin_IO : public ::testing::TestWithParam { }; }; -std::string GTest_Bin_IO::testResourcePath; -std::string GTest_Bin_IO::asciiFile1; -std::string GTest_Bin_IO::asciiFile2; -std::string GTest_Bin_IO::binFile1; -std::string GTest_Bin_IO::otherEndianFileOut; +std::string GTestBinIO::testResourcePath; +std::string GTestBinIO::asciiFile1; +std::string GTestBinIO::asciiFile2; +std::string GTestBinIO::binFile1; +std::string GTestBinIO::otherEndianFileOut; -TEST_P(GTest_Bin_IO, implements_binary_file_io_correctly) +TEST_P(GTestBinIO, implementsBinaryFileIoCorrectly) { { // 1. Write ASCII and bin files std::ofstream asciiFile(asciiFile1); @@ -401,7 +401,7 @@ TEST_P(GTest_Bin_IO, implements_binary_file_io_correctly) } } -INSTANTIATE_TEST_SUITE_P(representative_parameters, GTest_Bin_IO, ::testing::Values( +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) diff --git a/src/tests/GTest_binaryArith.cpp b/src/tests/GTestBinaryArith.cpp similarity index 98% rename from src/tests/GTest_binaryArith.cpp rename to src/tests/GTestBinaryArith.cpp index 97f5f4398..ed4da711b 100644 --- a/src/tests/GTest_binaryArith.cpp +++ b/src/tests/GTestBinaryArith.cpp @@ -73,7 +73,7 @@ struct Parameters }; }; -class GTest_binaryArith : +class GTestBinaryArith : public ::testing::TestWithParam> { protected: @@ -231,7 +231,7 @@ class GTest_binaryArith : helib::FHEcontext context; helib::FHESecKey secKey; - GTest_binaryArith() : + GTestBinaryArith() : prm(validatePrm(std::get<0>(GetParam()).prm)), bitSize(correctBitSize(5, std::get<0>(GetParam()).bitSize)), bitSize2(correctBitSize(bitSize, std::get<0>(GetParam()).bitSize2)), @@ -282,10 +282,10 @@ class GTest_binaryArith : helib::printAllTimers(std::cout); }; }; -constexpr long GTest_binaryArith::mValues[8][15]; -std::vector GTest_binaryArith::unpackSlotEncoding; +constexpr long GTestBinaryArith::mValues[8][15]; +std::vector GTestBinaryArith::unpackSlotEncoding; -TEST_P(GTest_binaryArith, fifteenForFour) +TEST_P(GTestBinaryArith, fifteenForFour) { // Randomly generate up to 15 integers from {0,1} with some entries // randomly set to null. We then encrypt and use the fifteenOrLess4Four @@ -342,7 +342,7 @@ TEST_P(GTest_binaryArith, fifteenForFour) } }; -TEST_P(GTest_binaryArith, product) +TEST_P(GTestBinaryArith, product) { // Randomly generate a pair of numbers of a specified bit size and then // encrypt them in binary representation. Then use multTwoNumbers to @@ -486,7 +486,7 @@ TEST_P(GTest_binaryArith, product) #endif }; -TEST_P(GTest_binaryArith, add) +TEST_P(GTestBinaryArith, add) { // Randomly generate a pair of numbers of a specified bit size and then // encrypt them in binary representation. Then use addTwoNumbers to add the @@ -582,7 +582,7 @@ TEST_P(GTest_binaryArith, add) #endif }; -TEST_P(GTest_binaryArith, addManyNumbers) +TEST_P(GTestBinaryArith, addManyNumbers) { // Randomly generate a vector of numbers of a specified bit size and then // encrypt them in binary representation. Then use addManyNumbers to add @@ -664,8 +664,8 @@ TEST_P(GTest_binaryArith, addManyNumbers) } INSTANTIATE_TEST_SUITE_P( - small_parameter_sizes_repeated, - GTest_binaryArith, + smallParameterSizesRepeated, + GTestBinaryArith, ::testing::Combine( ::testing::Values( // SLOW diff --git a/src/tests/GTest_binaryCompare.cpp b/src/tests/GTestBinaryCompare.cpp similarity index 96% rename from src/tests/GTest_binaryCompare.cpp rename to src/tests/GTestBinaryCompare.cpp index c1f43d15f..86b4cc647 100644 --- a/src/tests/GTest_binaryCompare.cpp +++ b/src/tests/GTestBinaryCompare.cpp @@ -62,7 +62,7 @@ struct Parameters { }; }; -class GTest_binaryCompare : public ::testing::TestWithParam> { +class GTestBinaryCompare : public ::testing::TestWithParam> { protected: static std::vector unpackSlotEncoding; constexpr static long mValues[][15] = { @@ -173,7 +173,7 @@ class GTest_binaryCompare : public ::testing::TestWithParam(GetParam()).prm)), bitSize(correctBitSize(5, std::get<0>(GetParam()).bitSize)), bootstrap(std::get<0>(GetParam()).bootstrap), @@ -220,10 +220,10 @@ class GTest_binaryCompare : public ::testing::TestWithParam GTest_binaryCompare::unpackSlotEncoding; -constexpr long GTest_binaryCompare::mValues[5][15]; +std::vector GTestBinaryCompare::unpackSlotEncoding; +constexpr long GTestBinaryCompare::mValues[5][15]; -TEST_P(GTest_binaryCompare, comparison) +TEST_P(GTestBinaryCompare, comparison) { const helib::EncryptedArray& ea = *context.ea; @@ -309,7 +309,7 @@ TEST_P(GTest_binaryCompare, comparison) #endif } -INSTANTIATE_TEST_SUITE_P(small_paramater_sizes_repeated, GTest_binaryCompare, ::testing::Combine( +INSTANTIATE_TEST_SUITE_P(smallParamaterSizesRepeated, GTestBinaryCompare, ::testing::Combine( ::testing::Values( //SLOW Parameters(1, 5, false, 0, 1) diff --git a/src/tests/GTest_bootstrapping.cpp b/src/tests/GTestBootstrapping.cpp similarity index 97% rename from src/tests/GTest_bootstrapping.cpp rename to src/tests/GTestBootstrapping.cpp index 7bde2bd82..e039da341 100644 --- a/src/tests/GTest_bootstrapping.cpp +++ b/src/tests/GTestBootstrapping.cpp @@ -89,7 +89,7 @@ struct Parameters { }; }; -class GTest_bootstrapping : public ::testing::TestWithParam { +class GTestBootstrapping : public ::testing::TestWithParam { protected: static constexpr long mValues[][14] = { //{ p, phi(m), m, d, m1, m2, m3, g1, g2, g3,ord1,ord2,ord3, c_m} @@ -150,7 +150,7 @@ class GTest_bootstrapping : public ::testing::TestWithParam { throw std::invalid_argument("could not find row in mValues corresponding to p=" + std::to_string(p) + ", N=" + std::to_string(N)); }; - GTest_bootstrapping () : + GTestBootstrapping () : old_fhe_test_force_bsgs(helib::fhe_test_force_bsgs), old_fhe_test_force_hoist(helib::fhe_test_force_hoist), p(GetParam().p), @@ -199,10 +199,10 @@ class GTest_bootstrapping : public ::testing::TestWithParam { } }; -constexpr long GTest_bootstrapping::mValues[][14]; -constexpr std::size_t GTest_bootstrapping::num_mValues; +constexpr long GTestBootstrapping::mValues[][14]; +constexpr std::size_t GTestBootstrapping::num_mValues; -TEST_P(GTest_bootstrapping, bootstrapping_works_correctly) +TEST_P(GTestBootstrapping, bootstrappingWorksCorrectly) { NTL::Vec mvec; std::vector gens; @@ -223,7 +223,7 @@ TEST_P(GTest_bootstrapping, bootstrapping_works_correctly) if (abs(mValues[idx][12])>1) ords.push_back(mValues[idx][12]); if (!helib_test::noPrint) { - std::cout << "*** GTest_bootstrapping"; + std::cout << "*** GTestBootstrapping"; if (helib::isDryRun()) std::cout << " (dry run)"; std::cout << ": p=" << p << ", r=" << r @@ -360,7 +360,7 @@ TEST_P(GTest_bootstrapping, bootstrapping_works_correctly) #endif }; -INSTANTIATE_TEST_SUITE_P(non_conservative_representative_parameters, GTest_bootstrapping, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(nonConservativeRepresentativeParameters, GTestBootstrapping, ::testing::Values( //SLOW Parameters(2, 1, 3, 600, 512, 0, 1, 0, 1, 0, 0), Parameters(2, 4, 3, 600, 2300, 0, 1, 0, 1, 0, 0), diff --git a/src/tests/GTest_EaCx.cpp b/src/tests/GTestEaCx.cpp similarity index 94% rename from src/tests/GTest_EaCx.cpp rename to src/tests/GTestEaCx.cpp index 34753af55..f94823ca6 100644 --- a/src/tests/GTest_EaCx.cpp +++ b/src/tests/GTestEaCx.cpp @@ -39,7 +39,7 @@ struct Parameters { }; }; -class GTest_EaCx : public ::testing::TestWithParam { +class GTestEaCx : public ::testing::TestWithParam { protected: const long m; @@ -47,7 +47,7 @@ class GTest_EaCx : public ::testing::TestWithParam { helib::FHEcontext context; const helib::EncryptedArrayCx& eacx; - GTest_EaCx() : + GTestEaCx() : m(GetParam().m), r(GetParam().r), context(m, /*p=*/-1, r), @@ -88,7 +88,7 @@ class GTest_EaCx : public ::testing::TestWithParam { } }; -TEST_P(GTest_EaCx, encoding_works_correctly) +TEST_P(GTestEaCx, encodingWorksCorrectly) { std::vector vl; eacx.random(vl); @@ -125,7 +125,7 @@ TEST_P(GTest_EaCx, encoding_works_correctly) } -INSTANTIATE_TEST_SUITE_P(small_parameters, GTest_EaCx, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(smallParameters, GTestEaCx, ::testing::Values( Parameters(16, 8) )); diff --git a/src/tests/GTest_EvalMap.cpp b/src/tests/GTestEvalMap.cpp similarity index 97% rename from src/tests/GTest_EvalMap.cpp rename to src/tests/GTestEvalMap.cpp index e44373323..d569b18a0 100644 --- a/src/tests/GTest_EvalMap.cpp +++ b/src/tests/GTestEvalMap.cpp @@ -72,7 +72,7 @@ struct Parameters { }; }; -class GTest_EvalMap : public ::testing::TestWithParam { +class GTestEvalMap : public ::testing::TestWithParam { protected: long p; long r; @@ -146,7 +146,7 @@ class GTest_EvalMap : public ::testing::TestWithParam { } }; - GTest_EvalMap() : + GTestEvalMap() : p(GetParam().p), r(GetParam().r), c(GetParam().c), @@ -194,7 +194,7 @@ class GTest_EvalMap : public ::testing::TestWithParam { }; -TEST_P(GTest_EvalMap, eval_map_behaves_correctly) +TEST_P(GTestEvalMap, evalMapBehavesCorrectly) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; @@ -293,7 +293,7 @@ TEST_P(GTest_EvalMap, eval_map_behaves_correctly) } }; -INSTANTIATE_TEST_SUITE_P(some_parameters, GTest_EvalMap, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(someParameters, GTestEvalMap, ::testing::Values( //SLOW Parameters(2, 1, 2, 80, 300, 0, 0, helib::convert, std::vector>(std::vector{7, 3, 221}), std::vector{3979, 3095, 3760}, std::vector{6, 2, -8}, 1, 0) //FAST diff --git a/src/tests/GTest_extractDigits.cpp b/src/tests/GTestExtractDigits.cpp similarity index 94% rename from src/tests/GTest_extractDigits.cpp rename to src/tests/GTestExtractDigits.cpp index f177e53b5..39304254b 100644 --- a/src/tests/GTest_extractDigits.cpp +++ b/src/tests/GTestExtractDigits.cpp @@ -10,7 +10,7 @@ * limitations under the License. See accompanying LICENSE file. */ -/* GTest_extractDigits.cpp - extracting digits. +/* GTestextractDigits.cpp - extracting digits. * For a plaintext space modulo a prime-power $p^e$, extracting * the base-$p$ representation of an encrypted values. */ @@ -46,7 +46,7 @@ struct Parameters { }; }; -class GTest_extractDigits : public ::testing::TestWithParam { +class GTestExtractDigits : public ::testing::TestWithParam { protected: long p; long r; @@ -76,7 +76,7 @@ class GTest_extractDigits : public ::testing::TestWithParam { return 30*(r*ll*3 + 2); }; - GTest_extractDigits() : + GTestExtractDigits() : p(GetParam().p), r(correctLifting(GetParam().r, p)), m(GetParam().m ? GetParam().m : p + 1), // FindM(/*secparam=*/80, L, /*c=*/4, p, /*d=*/1, 0, m); @@ -116,7 +116,7 @@ class GTest_extractDigits : public ::testing::TestWithParam { } }; -TEST_P(GTest_extractDigits, correctly_extracts_digits) +TEST_P(GTestExtractDigits, correctlyExtractsDigits) { helib::EncryptedArray ea(context); std::vector v; @@ -166,7 +166,7 @@ TEST_P(GTest_extractDigits, correctly_extracts_digits) } } -INSTANTIATE_TEST_SUITE_P(various_plaintext_bases, GTest_extractDigits, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(variousPlaintextBases, GTestExtractDigits, ::testing::Values( //SLOW Parameters(5, 0, 2047) //FAST diff --git a/src/tests/GTest_fatboot.cpp b/src/tests/GTestFatboot.cpp similarity index 97% rename from src/tests/GTest_fatboot.cpp rename to src/tests/GTestFatboot.cpp index 7bcaac9b1..4962d0554 100644 --- a/src/tests/GTest_fatboot.cpp +++ b/src/tests/GTestFatboot.cpp @@ -104,14 +104,14 @@ namespace { }; - class GTest_fatboot : public ::testing::TestWithParam { + class GTestFatboot : public ::testing::TestWithParam { private: void preContextSetup() { if (!helib_test::noPrint) helib::fhe_stats = true; if (!helib_test::noPrint) { - std::cout << "*** GTest_fatboot"; + std::cout << "*** GTestFatboot"; if (helib::isDryRun()) std::cout << " (dry run)"; std::cout << ": p=" << p @@ -186,7 +186,7 @@ namespace { double time; helib::FHEcontext context; - GTest_fatboot() : + GTestFatboot() : old_fhe_test_force_bsgs(helib::fhe_test_force_bsgs), old_fhe_test_force_hoist(helib::fhe_test_force_hoist), old_fhe_force_chen_han(helib::fhe_force_chen_han), @@ -230,7 +230,7 @@ namespace { }; - TEST_P(GTest_fatboot, correctly_performs_fatboot) { + TEST_P(GTestFatboot, correctlyPerformsFatboot) { helib::buildModChain(context, bits, c, /*willBeBootstrappable=*/true, /*t=*/skHwt); if (!helib_test::noPrint) { @@ -331,7 +331,7 @@ namespace { //long useCache=1; //int c_m = 100; - INSTANTIATE_TEST_SUITE_P(typical_parameters, GTest_fatboot, ::testing::Values( + INSTANTIATE_TEST_SUITE_P(typicalParameters, GTestFatboot, ::testing::Values( //SLOW Parameters(2, 1, 3, 600, 64, 1, 0, 1, 100, 0, 0, 0, 0, 0, {1026, 249}, {30, -2}, {31, 41}, 1, 1), Parameters(17, 1, 3, 600, 64, 1, 0, 1, 100, 0, 0, 0, 0, 0, {556, 1037}, {6, 4}, {7, 5, 37}, 1, 1) diff --git a/src/tests/GTest_General.cpp b/src/tests/GTestGeneral.cpp similarity index 97% rename from src/tests/GTest_General.cpp rename to src/tests/GTestGeneral.cpp index a2e988cfd..79fce707f 100644 --- a/src/tests/GTest_General.cpp +++ b/src/tests/GTestGeneral.cpp @@ -110,7 +110,7 @@ struct Parameters { }; }; -class GTest_General : public ::testing::TestWithParam { +class GTestGeneral : public ::testing::TestWithParam { protected: long R; long p; @@ -131,7 +131,7 @@ class GTest_General : public ::testing::TestWithParam { const helib::FHEPubKey &publicKey; - GTest_General () : + GTestGeneral () : R(GetParam().R), p(GetParam().p), r(GetParam().r), @@ -168,7 +168,7 @@ class GTest_General : public ::testing::TestWithParam { } }; -TEST_P(GTest_General, correctly_implements_mix_of_operations_over_four_ciphertexts) +TEST_P(GTestGeneral, correctlyImplementsMixOfOperationsOverFourCiphertexts) { char buffer[32]; if (!helib_test::noPrint) { @@ -335,7 +335,7 @@ TEST_P(GTest_General, correctly_implements_mix_of_operations_over_four_ciphertex } }; -INSTANTIATE_TEST_SUITE_P(various_parameters, GTest_General, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(variousParameters, GTestGeneral, ::testing::Values( // R, p, r, d, c, k, L, s, m, mvec, gens, ords, seed, nt //FAST //Parameters(1, 2, 1, 1, 2, 80, 500, 0, 91, NTL::Vec{}, NTL::Vec{}, NTL::Vec{}, 0, 1) diff --git a/src/tests/GTest_IO.cpp b/src/tests/GTestIO.cpp similarity index 97% rename from src/tests/GTest_IO.cpp rename to src/tests/GTestIO.cpp index 5c31cb3f5..cd5d70d57 100644 --- a/src/tests/GTest_IO.cpp +++ b/src/tests/GTestIO.cpp @@ -46,7 +46,7 @@ struct Parameters { }; }; -class GTest_IO : public ::testing::TestWithParam { +class GTestIO : public ::testing::TestWithParam { protected: #define N_TESTS 3 static constexpr long ms[N_TESTS][10] = { @@ -76,7 +76,7 @@ class GTest_IO : public ::testing::TestWithParam { return testResourcePath; }; - GTest_IO () : + GTestIO () : r(GetParam().r), p(GetParam().p), c(GetParam().c), @@ -124,12 +124,12 @@ class GTest_IO : public ::testing::TestWithParam { }; }; -constexpr long GTest_IO::ms[N_TESTS][10]; -std::string GTest_IO::keyFilePath; +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(GTest_IO, important_classes_remain_consistent_under_io) +TEST_P(GTestIO, importantClassesRemainConsistentUnderIo) { // first loop: generate stuff and write it to file @@ -341,7 +341,7 @@ TEST_P(GTest_IO, important_classes_remain_consistent_under_io) }} } -INSTANTIATE_TEST_SUITE_P(some_small_parameters, GTest_IO, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(someSmallParameters, GTestIO, ::testing::Values( //FAST Parameters(1, 2, 2, 91) )); diff --git a/src/tests/GTest_intraSlot.cpp b/src/tests/GTestIntraSlot.cpp similarity index 94% rename from src/tests/GTest_intraSlot.cpp rename to src/tests/GTestIntraSlot.cpp index 93801bc47..e87010078 100644 --- a/src/tests/GTest_intraSlot.cpp +++ b/src/tests/GTestIntraSlot.cpp @@ -48,7 +48,7 @@ struct Parameters { }; }; -class GTest_intraSlot : public ::testing::TestWithParam { +class GTestIntraSlot : public ::testing::TestWithParam { static helib::FHEcontext& setupContext(helib::FHEcontext& context, long L) { @@ -60,7 +60,7 @@ class GTest_intraSlot : public ::testing::TestWithParam { }; protected: - GTest_intraSlot () : + GTestIntraSlot () : p(GetParam().p), n(GetParam().n), r(GetParam().r), @@ -101,7 +101,7 @@ class GTest_intraSlot : public ::testing::TestWithParam { } }; -TEST_P(GTest_intraSlot, packing_and_unpacking_works) +TEST_P(GTestIntraSlot, packingAndUnpackingWorks) { NTL::ZZX G = context.alMod.getFactorsOverZZ()[0]; helib::EncryptedArray ea(context, G); @@ -135,7 +135,7 @@ TEST_P(GTest_intraSlot, packing_and_unpacking_works) "p2["< std::unique_ptr buildMat(const helib::EncryptedArray //}; template -class GTest_matmul : public ::testing::Test { +class GTestMatmul : public ::testing::Test { protected: static void setGlobals(long force_bsgs, long force_hoist) { @@ -170,7 +170,7 @@ class GTest_matmul : public ::testing::Test { return context; } - GTest_matmul () : + GTestMatmul () : minimal((setGlobals(T::parameters.force_bsgs, T::parameters.force_hoist), T::parameters.ks_strategy == 3)), m(T::parameters.m), @@ -268,9 +268,9 @@ using TypesToTest = ::testing::Types< MatrixTypeAndParams >; -TYPED_TEST_SUITE(GTest_matmul, TypesToTest); +TYPED_TEST_SUITE(GTestMatmul, TypesToTest); -TYPED_TEST(GTest_matmul, multiplies_without_errors) { +TYPED_TEST(GTestMatmul, multipliesWithoutErrors) { FHE_NTIMER_START(EncodeMartix_MatMul); // Templated class so explicit 'this' necessary const typename TypeParam::MatrixType& mat = *(this->matrixPtr); diff --git a/src/tests/GTest_PAlgebra.cpp b/src/tests/GTestPAlgebra.cpp similarity index 93% rename from src/tests/GTest_PAlgebra.cpp rename to src/tests/GTestPAlgebra.cpp index 12bffb7d7..e0dac650c 100644 --- a/src/tests/GTest_PAlgebra.cpp +++ b/src/tests/GTestPAlgebra.cpp @@ -50,9 +50,9 @@ struct Parameters { }; }; -class GTest_PAlgebra : public ::testing::TestWithParam { +class GTestPAlgebra : public ::testing::TestWithParam { protected: - GTest_PAlgebra() : + GTestPAlgebra() : m(GetParam().m), p(GetParam().p), r(GetParam().r), @@ -93,7 +93,7 @@ class GTest_PAlgebra : public ::testing::TestWithParam { } }; -TEST_P(GTest_PAlgebra, reads_and_writes_contexts_as_strings) +TEST_P(GTestPAlgebra, readsAndWritesContextsAsStrings) { std::stringstream s1; helib::writeContextBase(s1, context); @@ -117,7 +117,7 @@ TEST_P(GTest_PAlgebra, reads_and_writes_contexts_as_strings) EXPECT_EQ(context, c1); }; -INSTANTIATE_TEST_SUITE_P(small_parameters, GTest_PAlgebra, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(smallParameters, GTestPAlgebra, ::testing::Values( //FAST Parameters(91, 2, 1, std::vector{}, std::vector{}) )); diff --git a/src/tests/GTest_PGFFT.cpp b/src/tests/GTestPGFFT.cpp similarity index 98% rename from src/tests/GTest_PGFFT.cpp rename to src/tests/GTestPGFFT.cpp index eec992c49..8129fafc8 100644 --- a/src/tests/GTest_PGFFT.cpp +++ b/src/tests/GTestPGFFT.cpp @@ -315,21 +315,21 @@ namespace { } } - TEST(GTestPGFFT, PGFFT_works_in_range_1_100_points) { + TEST(GTestPGFFT, PGFFTWorksInRange1to100Points) { SetSeed(); for (long n = 1; n <= 100; n++) TestIt(n); } - TEST(GTestPGFFT, PGFFT_works_in_range_256_32768_power_of_two_points) { + TEST(GTestPGFFT, PGFFTWorksInRange256to32768PowerOfTwoPoints) { SetSeed(); for (long n = 256; n <= 32 * 1024; n *= 2) TestIt(n); } - TEST(GTestPGFFT, PGFFT_works_in_range_10000_20000_points) { + TEST(GTestPGFFT, PGFFTWorksInRange10000to20000Points) { SetSeed(); for (long i = 0; i < 100; i++) { diff --git a/src/tests/GTest_Permutations.cpp b/src/tests/GTestPermutations.cpp similarity index 98% rename from src/tests/GTest_Permutations.cpp rename to src/tests/GTestPermutations.cpp index 2cfbfe8e3..aea84b673 100644 --- a/src/tests/GTest_Permutations.cpp +++ b/src/tests/GTestPermutations.cpp @@ -75,9 +75,9 @@ struct Parameters { }; }; -class GTest_Permutations : public ::testing::TestWithParam { +class GTestPermutations : public ::testing::TestWithParam { protected: - GTest_Permutations() : + GTestPermutations() : test(GetParam().test), p(GetParam().p), r(GetParam().r), @@ -261,7 +261,7 @@ void testCtxt(long m, long p, long widthBound, long L, long r) generator 13661 has order (== Z_m^*) of 2 */ -TEST_P(GTest_Permutations, ciphertext_permutations) +TEST_P(GTestPermutations, ciphertextPermutations) { if (test==0 || helib_test::dry!=0) { NTL::Vec vec; @@ -296,7 +296,7 @@ TEST_P(GTest_Permutations, ciphertext_permutations) } }; -INSTANTIATE_TEST_SUITE_P(default_parameters, GTest_Permutations, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(defaultParameters, GTestPermutations, ::testing::Values( //FAST //Parameters(1, 91, 2, 1, 5, 0, 30, 0, 0, 0, 1, 1, 1, 1) //SLOW diff --git a/src/tests/GTest_PolyEval.cpp b/src/tests/GTestPolyEval.cpp similarity index 94% rename from src/tests/GTest_PolyEval.cpp rename to src/tests/GTestPolyEval.cpp index 7ac3d5e0f..41f3aebd6 100644 --- a/src/tests/GTest_PolyEval.cpp +++ b/src/tests/GTestPolyEval.cpp @@ -60,7 +60,7 @@ struct Parameters { }; }; -class GTest_PolyEval : public ::testing::TestWithParam +class GTestPolyEval : public ::testing::TestWithParam { protected: long p; @@ -77,7 +77,7 @@ class GTest_PolyEval : public ::testing::TestWithParam helib::FHESecKey secretKey; const helib::FHEPubKey &publicKey; - GTest_PolyEval() : + GTestPolyEval() : p(GetParam().p), r(GetParam().r), d(GetParam().d), @@ -110,7 +110,7 @@ class GTest_PolyEval : public ::testing::TestWithParam }; -TEST_P(GTest_PolyEval, encrypted_polynomials_evaluate_at_encrypted_point_correctly) +TEST_P(GTestPolyEval, encryptedPolynomialsEvaluateAtEncryptedPointCorrectly) { NTL::zz_pBak bak; bak.save(); NTL::zz_p::init(p); NTL::zz_pXModulus phimX = NTL::conv(ea.getPAlgebra().getPhimX()); @@ -146,7 +146,7 @@ TEST_P(GTest_PolyEval, encrypted_polynomials_evaluate_at_encrypted_point_correct EXPECT_EQ(cres, pres) << "encrypted poly MISMATCH"; }; -TEST_P(GTest_PolyEval, evaluate_polynomial_on_ciphertext) +TEST_P(GTestPolyEval, evaluatePolynomialOnCiphertext) { // evaluate at random points (at least one co-prime with p) std::vector x; @@ -211,6 +211,6 @@ std::vector getParameters() return allParams; }; -INSTANTIATE_TEST_SUITE_P(many_degrees, GTest_PolyEval, ::testing::ValuesIn(getParameters())); +INSTANTIATE_TEST_SUITE_P(manyDegrees, GTestPolyEval, ::testing::ValuesIn(getParameters())); } // namespace diff --git a/src/tests/GTest_Powerful.cpp b/src/tests/GTestPowerful.cpp similarity index 96% rename from src/tests/GTest_Powerful.cpp rename to src/tests/GTestPowerful.cpp index c519175b9..227caa2aa 100644 --- a/src/tests/GTest_Powerful.cpp +++ b/src/tests/GTestPowerful.cpp @@ -46,7 +46,7 @@ struct Parameters { }; }; -class GTest_Powerful : public ::testing::TestWithParam +class GTestPowerful : public ::testing::TestWithParam { protected: NTL::Vec mvec; @@ -67,7 +67,7 @@ class GTest_Powerful : public ::testing::TestWithParam return mvec; }; - GTest_Powerful () : + GTestPowerful () : mvec(computeMvec(GetParam().m1, GetParam().m2, GetParam().m3)), m(helib::computeProd(mvec)), p(GetParam().p), @@ -86,7 +86,7 @@ class GTest_Powerful : public ::testing::TestWithParam } }; -TEST_P(GTest_Powerful, simple_conversion_works) +TEST_P(GTestPowerful, simpleConversionWorks) { helib::PowerfulTranslationIndexes ind(mvec); helib::PowerfulConversion pConv; @@ -102,7 +102,7 @@ TEST_P(GTest_Powerful, simple_conversion_works) EXPECT_EQ(poly, poly2); } -TEST_P(GTest_Powerful, high_level_conversion_works) +TEST_P(GTestPowerful, highLevelConversionWorks) { helib::PowerfulDCRT p2d(context, mvec); helib::DoubleCRT dcrt(context, context.fullPrimes()); @@ -140,7 +140,7 @@ TEST_P(GTest_Powerful, high_level_conversion_works) EXPECT_EQ(poly1, poly2) << getErrorOutput(); } -INSTANTIATE_TEST_SUITE_P(standard_parameters, GTest_Powerful, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(standardParameters, GTestPowerful, ::testing::Values( //FAST Parameters(3, 5, 7, 2, 1) )); diff --git a/src/tests/GTest_PtrVector.cpp b/src/tests/GTestPtrVector.cpp similarity index 97% rename from src/tests/GTest_PtrVector.cpp rename to src/tests/GTestPtrVector.cpp index 163c44608..9494eb0d0 100644 --- a/src/tests/GTest_PtrVector.cpp +++ b/src/tests/GTestPtrVector.cpp @@ -32,9 +32,9 @@ class MyClass { void set(int i) { myInt=i; } }; -class GTest_PtrVector : public ::testing::Test { +class GTestPtrVector : public ::testing::Test { protected: - GTest_PtrVector () : + GTestPtrVector () : vLength(6), zero(0) {}; @@ -160,7 +160,7 @@ void test5(const MyPtrMat& mat, const T& array) ASSERT_TRUE(pointersEqual(mat[i], *array[i])); } -TEST_F(GTest_PtrVector, pointer_vectors_remain_consistent) +TEST_F(GTestPtrVector, pointerVectorsRemainConsistent) { MyClass zero(0); std::vector v1(vLength, zero); diff --git a/src/tests/GTest_Replicate.cpp b/src/tests/GTestReplicate.cpp similarity index 94% rename from src/tests/GTest_Replicate.cpp rename to src/tests/GTestReplicate.cpp index 5fd565ea3..fa1c03cb1 100644 --- a/src/tests/GTest_Replicate.cpp +++ b/src/tests/GTestReplicate.cpp @@ -10,7 +10,7 @@ * limitations under the License. See accompanying LICENSE file. */ -/* GTest_Replicate.cpp - Testing the functionality of replicating one +/* GTestReplicate.cpp - Testing the functionality of replicating one * slot from a vector acress the whole vector (or replicating each slot * to a full cipehrtext) */ @@ -60,7 +60,7 @@ struct Parameters { }; }; -class GTest_Replicate : public ::testing::TestWithParam { +class GTestReplicate : public ::testing::TestWithParam { protected: static void printContextAndG(const helib::FHEcontext& context, const NTL::ZZX& G) { @@ -76,7 +76,7 @@ class GTest_Replicate : public ::testing::TestWithParam { return (d == 0) ? context.alMod.getFactorsOverZZ()[0] : helib::makeIrredPoly(p, d); }; - GTest_Replicate() : + GTestReplicate() : m(GetParam().m), p(GetParam().p), r(GetParam().r), @@ -203,7 +203,7 @@ class ReplicateTester : public helib::ReplicateHandler { -TEST_P(GTest_Replicate, replicate_works) +TEST_P(GTestReplicate, replicateWorks) { if (!helib_test::noPrint) { std::cout << "** Testing replicate():\n"; @@ -214,7 +214,7 @@ TEST_P(GTest_Replicate, replicate_works) if (!helib_test::noPrint) CheckCtxt(xc1, "after replicate"); }; -TEST_P(GTest_Replicate, repeated_replication_works) +TEST_P(GTestReplicate, repeatedReplicationWorks) { // Get some timing results for (long i=0; i<20 && i { +class GTestTableLookup : public ::testing::TestWithParam { protected: static constexpr long mValues[][15] = { // { p, phi(m), m, d, m1, m2, m3, g1, g2, g3, ord1,ord2,ord3, B,c} @@ -194,7 +194,7 @@ class GTest_tableLookup : public ::testing::TestWithParam { if (nthreads>1) NTL::SetNumThreads(nthreads); }; - GTest_tableLookup () : + GTestTableLookup () : prm(validatePrm(GetParam().prm)), bitSize(validateBitSize(GetParam().bitSize)), outSize(GetParam().outSize), @@ -261,9 +261,9 @@ class GTest_tableLookup : public ::testing::TestWithParam { }; }; -constexpr long GTest_tableLookup::mValues[][15]; +constexpr long GTestTableLookup::mValues[][15]; -TEST_P(GTest_tableLookup, lookup_functions_correctly) +TEST_P(GTestTableLookup, lookupFunctionsCorrectly) { // Build a table s.t. T[i] = 2^{outSize -1}/(i+1), i=0,...,2^bitSize -1 std::vector T; @@ -286,7 +286,7 @@ TEST_P(GTest_tableLookup, lookup_functions_correctly) } }; -TEST_P(GTest_tableLookup, writein_functions_correctly) +TEST_P(GTestTableLookup, writeinFunctionsCorrectly) { const helib::EncryptedArray& ea = *(secretKey.getContext().ea); long tSize = 1L << bitSize; // table size @@ -324,7 +324,7 @@ TEST_P(GTest_tableLookup, writein_functions_correctly) } }; -INSTANTIATE_TEST_SUITE_P(typical_parameters, GTest_tableLookup, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, GTestTableLookup, ::testing::Values( //SLOW Parameters(1, 5, 0, 3, false, 0, 1) //FAST diff --git a/src/tests/GTest_ThinBootstrapping.cpp b/src/tests/GTestThinBootstrapping.cpp similarity index 97% rename from src/tests/GTest_ThinBootstrapping.cpp rename to src/tests/GTestThinBootstrapping.cpp index cc8540e76..5fd29f6b4 100644 --- a/src/tests/GTest_ThinBootstrapping.cpp +++ b/src/tests/GTestThinBootstrapping.cpp @@ -79,7 +79,7 @@ struct Parameters { }; -class GTest_ThinBootstrapping : public ::testing::TestWithParam { +class GTestThinBootstrapping : public ::testing::TestWithParam { protected: constexpr static long mValues[][14] = { //{ p, phi(m), m, d, m1, m2, m3, g1, g2, g3,ord1,ord2,ord3, c_m} @@ -266,7 +266,7 @@ class GTest_ThinBootstrapping : public ::testing::TestWithParam { return secKey; } - GTest_ThinBootstrapping() : + GTestThinBootstrapping() : old_fhe_test_force_bsgs(helib::fhe_test_force_bsgs), old_fhe_test_force_hoist(helib::fhe_test_force_hoist), // Squeeze global-setting in as the first operation @@ -351,10 +351,10 @@ class GTest_ThinBootstrapping : public ::testing::TestWithParam { }; }; -constexpr long GTest_ThinBootstrapping::mValues[][14]; -constexpr long GTest_ThinBootstrapping::num_mValues; +constexpr long GTestThinBootstrapping::mValues[][14]; +constexpr long GTestThinBootstrapping::num_mValues; -TEST_P(GTest_ThinBootstrapping, correctly_performs_thin_bootstrapping) +TEST_P(GTestThinBootstrapping, correctlyPerformsThinBootstrapping) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; @@ -399,7 +399,7 @@ TEST_P(GTest_ThinBootstrapping, correctly_performs_thin_bootstrapping) }; -INSTANTIATE_TEST_SUITE_P(typical_parameters, GTest_ThinBootstrapping, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, GTestThinBootstrapping, ::testing::Values( //SLOW Parameters(2, 1, 3, 600, 512, 0, 1, 0, 1, 0, 0), Parameters(2, 4, 3, 600, 2300, 0, 1, 0, 1, 0, 0), diff --git a/src/tests/GTest_ThinEvalMap.cpp b/src/tests/GTestThinEvalMap.cpp similarity index 97% rename from src/tests/GTest_ThinEvalMap.cpp rename to src/tests/GTestThinEvalMap.cpp index 26784a69d..a8cbf3770 100644 --- a/src/tests/GTest_ThinEvalMap.cpp +++ b/src/tests/GTestThinEvalMap.cpp @@ -70,7 +70,7 @@ struct Parameters { }; }; -class GTest_ThinEvalMap : public ::testing::TestWithParam { +class GTestThinEvalMap : public ::testing::TestWithParam { protected: @@ -130,7 +130,7 @@ class GTest_ThinEvalMap : public ::testing::TestWithParam { return secretKey; } - GTest_ThinEvalMap() : + GTestThinEvalMap() : p(GetParam().p), r(GetParam().r), c(GetParam().c), @@ -189,7 +189,7 @@ class GTest_ThinEvalMap : public ::testing::TestWithParam { }; -TEST_P(GTest_ThinEvalMap, thin_eval_map_is_correct) +TEST_P(GTestThinEvalMap, thinEvalMapIsCorrect) { // GG defines the plaintext space Z_p[X]/GG(X) NTL::ZZX GG; @@ -289,7 +289,7 @@ TEST_P(GTest_ThinEvalMap, thin_eval_map_is_correct) }; -INSTANTIATE_TEST_SUITE_P(various_parameters, GTest_ThinEvalMap, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(variousParameters, GTestThinEvalMap, ::testing::Values( //SLOW Parameters(2, 1, 2, 80, 300, 0, 0, helib::convert, std::vector>(std::vector{7, 3, 221}), std::vector{3979, 3095, 3760}, std::vector{6, 2, -8}, 1, 0) //FAST diff --git a/src/tests/GTest_thinboot.cpp b/src/tests/GTestThinboot.cpp similarity index 98% rename from src/tests/GTest_thinboot.cpp rename to src/tests/GTestThinboot.cpp index d5005ead6..b0b2b7751 100644 --- a/src/tests/GTest_thinboot.cpp +++ b/src/tests/GTestThinboot.cpp @@ -119,14 +119,14 @@ namespace { }; - class GTest_thinboot : public ::testing::TestWithParam { + class GTestThinboot : public ::testing::TestWithParam { private: void preContextSetup() { if (!helib_test::noPrint) { - std::cout << "*** GTest_thinboot"; + std::cout << "*** GTestThinboot"; if (helib::isDryRun()) std::cout << " (dry run)"; std::cout << ": p=" << p @@ -202,7 +202,7 @@ namespace { std::string v_values_name; - GTest_thinboot() : + GTestThinboot() : old_fhe_test_force_bsgs(helib::fhe_test_force_bsgs), old_fhe_test_force_hoist(helib::fhe_test_force_hoist), old_fhe_force_chen_han(helib::fhe_force_chen_han), @@ -334,7 +334,7 @@ namespace { - TEST_P(GTest_thinboot, correctly_performs_thinboot) { + TEST_P(GTestThinboot, correctlyPerformsThinboot) { helib::buildModChain(context, bits, c, /*willBeBootstrappable=*/true, /*t=*/skHwt); if (!helib_test::noPrint) { @@ -505,7 +505,7 @@ namespace { //long useCache=1; //int c_m = 100; - INSTANTIATE_TEST_SUITE_P(typical_parameters, GTest_thinboot, ::testing::Values( + INSTANTIATE_TEST_SUITE_P(typicalParameters, GTestThinboot, ::testing::Values( //SLOW Parameters(2, 1, 3, 600, 64, 1, 0, 1, 100, 0, 0, 0, 0, 0, {1026, 249}, {30, -2}, {31, 41}, 1, ""), Parameters(17, 1, 3, 600, 64, 1, 0, 1, 100, 0, 0, 0, 0, 0, {556, 1037}, {6, 4}, {7, 5, 37}, 1, "") diff --git a/src/tests/Test_ArgMap.cpp b/src/tests/TestArgMap.cpp similarity index 87% rename from src/tests/Test_ArgMap.cpp rename to src/tests/TestArgMap.cpp index 287494198..b46ab86e8 100644 --- a/src/tests/Test_ArgMap.cpp +++ b/src/tests/TestArgMap.cpp @@ -32,7 +32,7 @@ std::vector lineToVector(const std::string& line) { return std::vector(isiter, {}); } -class Test_ArgMap_CmdLine : public ::testing::Test { +class TestArgMapCmdLine : public ::testing::Test { protected: int argc = 0; @@ -55,7 +55,7 @@ class Test_ArgMap_CmdLine : public ::testing::Test { }; // Need to delete argv nicely. - ~Test_ArgMap_CmdLine() override { + ~TestArgMapCmdLine() override { for (int i = 0; i < this->argc; i++) { delete[] argv[i]; } @@ -63,7 +63,7 @@ class Test_ArgMap_CmdLine : public ::testing::Test { }; }; -class Test_ArgMap_SampleFile : public ::testing::Test { +class TestArgMapSampleFile : public ::testing::Test { private: bool del_file_flag = false; @@ -88,7 +88,7 @@ class Test_ArgMap_SampleFile : public ::testing::Test { return true; } - ~Test_ArgMap_SampleFile() override { + ~TestArgMapSampleFile() override { if (!this->filepath.empty() && del_file_flag) { // Delete the tmp test file if (remove(filepath.c_str()) != 0) { @@ -100,10 +100,10 @@ class Test_ArgMap_SampleFile : public ::testing::Test { }; // For death tests naming convention -using DeathTest_ArgMap_CmdLine = Test_ArgMap_CmdLine; +using DeathTestArgMapCmdLine = TestArgMapCmdLine; -TEST_F(DeathTest_ArgMap_CmdLine, - documentation_shown_are_shown_if_help_selected) { +TEST_F(DeathTestArgMapCmdLine, + documentationShownAreShownIfHelpSelected) { mockCmdLineArgs("./prog -h"); struct Opts { @@ -123,8 +123,8 @@ TEST_F(DeathTest_ArgMap_CmdLine, "Usage.*"); } -TEST_F(Test_ArgMap_SampleFile, - documentation_shown_are_shown_if_help_selected_from_file) { +TEST_F(TestArgMapSampleFile, + documentationShownAreShownIfHelpSelectedFromFile) { std::ostringstream oss; oss << "-h\n"; @@ -146,7 +146,7 @@ TEST_F(Test_ArgMap_SampleFile, EXPECT_THROW(amap.parse(filepath), helib::RuntimeError); } -TEST_F(DeathTest_ArgMap_CmdLine, ill_formed_cmdline) { +TEST_F(DeathTestArgMapCmdLine, illFormedCmdline) { mockCmdLineArgs("./prog alic"); struct Opts { @@ -163,7 +163,7 @@ TEST_F(DeathTest_ArgMap_CmdLine, ill_formed_cmdline) { "Unrecognised argument alic\nUsage.*"); } -TEST_F(Test_ArgMap_SampleFile, ill_formed_sample_file) { +TEST_F(TestArgMapSampleFile, illFormedSampleFile) { std::ostringstream oss; oss << "alice=5\n" << "bo\n"; @@ -183,7 +183,7 @@ TEST_F(Test_ArgMap_SampleFile, ill_formed_sample_file) { EXPECT_THROW(amap.parse(filepath), helib::RuntimeError); } -TEST_F(DeathTest_ArgMap_CmdLine, nullptr_and_empty_strings_for_no_defaults) { +TEST_F(DeathTestArgMapCmdLine, nullptrAndEmptyStringsForNoDefaults) { mockCmdLineArgs("./prog -h"); struct Opts { @@ -200,7 +200,7 @@ TEST_F(DeathTest_ArgMap_CmdLine, nullptr_and_empty_strings_for_no_defaults) { "Usage.*\n.*string\n.*bob.*string\n$"); } -TEST_F(Test_ArgMap_CmdLine, perfect_cmdline_args_are_read_in) { +TEST_F(TestArgMapCmdLine, perfectCmdlineArgsAreReadIn) { mockCmdLineArgs("./prog alice=1 bob=2.2 chris=NotIn"); struct Opts { @@ -220,7 +220,7 @@ TEST_F(Test_ArgMap_CmdLine, perfect_cmdline_args_are_read_in) { EXPECT_EQ(opts.arg3, "NotIn"); } -TEST_F(DeathTest_ArgMap_CmdLine, setting_same_name_twice) { +TEST_F(DeathTestArgMapCmdLine, settingSameNameTwice) { mockCmdLineArgs("./prog bob=2 bob=1"); struct Opts { @@ -234,7 +234,7 @@ TEST_F(DeathTest_ArgMap_CmdLine, setting_same_name_twice) { EXPECT_EQ(opts.arg1, 1); } -TEST_F(Test_ArgMap_SampleFile, setting_same_name_twice_from_file) { +TEST_F(TestArgMapSampleFile, settingSameNameTwiceFromFile) { std::ostringstream oss; oss << "bob=2\n" << "bob=1\n"; @@ -252,7 +252,7 @@ TEST_F(Test_ArgMap_SampleFile, setting_same_name_twice_from_file) { EXPECT_THROW(amap.parse(filepath), helib::RuntimeError); } -TEST_F(Test_ArgMap_CmdLine, setting_same_variable_twice) { +TEST_F(TestArgMapCmdLine, settingSameVariableTwice) { mockCmdLineArgs("./prog alice=1 bob=2"); struct Opts { @@ -266,7 +266,7 @@ TEST_F(Test_ArgMap_CmdLine, setting_same_variable_twice) { helib::RuntimeError); } -TEST_F(Test_ArgMap_SampleFile, setting_same_variable_twice) { +TEST_F(TestArgMapSampleFile, settingSameVariableTwice) { std::ostringstream oss; oss << "alice=1\n" << "bob=2\n"; @@ -285,7 +285,7 @@ TEST_F(Test_ArgMap_SampleFile, setting_same_variable_twice) { helib::RuntimeError); } -TEST_F(Test_ArgMap_CmdLine, spaced_cmdline_args_are_read_in) { +TEST_F(TestArgMapCmdLine, spacedCmdlineArgsAreReadIn) { mockCmdLineArgs("./prog alice= 1 bob = 2.2 chris =NotIn"); struct Opts { @@ -305,7 +305,7 @@ TEST_F(Test_ArgMap_CmdLine, spaced_cmdline_args_are_read_in) { EXPECT_EQ(opts.arg3, "NotIn"); } -TEST_F(Test_ArgMap_SampleFile, spaced_cmdline_args_are_read_in) { +TEST_F(TestArgMapSampleFile, spacedCmdlineArgsAreReadIn) { std::ostringstream oss; oss << "alice= 1\n" << "bob = 2.2\n" @@ -331,7 +331,7 @@ TEST_F(Test_ArgMap_SampleFile, spaced_cmdline_args_are_read_in) { EXPECT_EQ(opts.arg3, "NotIn"); } -TEST_F(DeathTest_ArgMap_CmdLine, unrecognised_cmdline_args_are_read_in) { +TEST_F(DeathTestArgMapCmdLine, unrecognisedCmdlineArgsAreReadIn) { mockCmdLineArgs("./prog lice=1 bob=2.2 chris=NotIn"); struct Opts { @@ -350,7 +350,7 @@ TEST_F(DeathTest_ArgMap_CmdLine, unrecognised_cmdline_args_are_read_in) { "Unrecognised argument lice\nUsage.*"); } -TEST_F(Test_ArgMap_SampleFile, unrecognised_cmdline_args_are_read_in) { +TEST_F(TestArgMapSampleFile, unrecognisedCmdlineArgsAreReadIn) { std::ostringstream oss; oss << "lice=1\n" << "bob=2.2\n" @@ -373,7 +373,7 @@ TEST_F(Test_ArgMap_SampleFile, unrecognised_cmdline_args_are_read_in) { EXPECT_THROW(amap.parse(filepath), helib::RuntimeError); } -TEST_F(Test_ArgMap_CmdLine, changing_kv_separator) { +TEST_F(TestArgMapCmdLine, changingKvSeparator) { mockCmdLineArgs("./prog alice:1 bob:7.5 chris:Hi"); struct Opts { @@ -394,7 +394,7 @@ TEST_F(Test_ArgMap_CmdLine, changing_kv_separator) { EXPECT_EQ(opts.arg3, "Hi"); } -TEST_F(Test_ArgMap_SampleFile, changing_kv_separator) { +TEST_F(TestArgMapSampleFile, changingKvSeparator) { std::ostringstream oss; oss << "alice:1\n" << "bob:7.5\n" @@ -421,7 +421,7 @@ TEST_F(Test_ArgMap_SampleFile, changing_kv_separator) { EXPECT_EQ(opts.arg3, "Hi"); } -TEST_F(Test_ArgMap_CmdLine, compulsory_argument_given) { +TEST_F(TestArgMapCmdLine, compulsoryArgumentGiven) { mockCmdLineArgs("./prog alice=1 bob=7.5"); struct Opts { @@ -443,7 +443,7 @@ TEST_F(Test_ArgMap_CmdLine, compulsory_argument_given) { EXPECT_EQ(opts.arg3, ""); } -TEST_F(Test_ArgMap_SampleFile, compulsory_argument_given) { +TEST_F(TestArgMapSampleFile, compulsoryArgumentGiven) { std::ostringstream oss; oss << "alice=1\n" << "bob=7.5\n"; @@ -470,7 +470,7 @@ TEST_F(Test_ArgMap_SampleFile, compulsory_argument_given) { EXPECT_EQ(opts.arg3, ""); } -TEST_F(DeathTest_ArgMap_CmdLine, compulsory_argument_not_given) { +TEST_F(DeathTestArgMapCmdLine, compulsoryArgumentNotGiven) { mockCmdLineArgs("./prog alice=1"); struct Opts { @@ -491,7 +491,7 @@ TEST_F(DeathTest_ArgMap_CmdLine, compulsory_argument_not_given) { R"(Required argument\(s\) not given:.*)"); } -TEST_F(Test_ArgMap_SampleFile, compulsory_argument_not_given) { +TEST_F(TestArgMapSampleFile, compulsoryArgumentNotGiven) { std::ostringstream oss; oss << "alice=1\n"; @@ -514,7 +514,7 @@ TEST_F(Test_ArgMap_SampleFile, compulsory_argument_not_given) { EXPECT_THROW(amap.parse(filepath), helib::RuntimeError); } -TEST_F(Test_ArgMap_CmdLine, read_in_a_vector) { +TEST_F(TestArgMapCmdLine, readInAVector) { mockCmdLineArgs("./prog alice=[1 2]"); struct Opts { @@ -533,7 +533,7 @@ TEST_F(Test_ArgMap_CmdLine, read_in_a_vector) { EXPECT_EQ(opts.arg1, test_v); } -TEST_F(Test_ArgMap_SampleFile, read_in_a_vector) { +TEST_F(TestArgMapSampleFile, readInAVector) { std::ostringstream oss; oss << "alice=[1 2]\n"; @@ -556,7 +556,7 @@ TEST_F(Test_ArgMap_SampleFile, read_in_a_vector) { EXPECT_EQ(opts.arg1, test_v); } -TEST_F(Test_ArgMap_SampleFile, arguments_from_simple_file) { +TEST_F(TestArgMapSampleFile, argumentsFromSimpleFile) { std::ostringstream oss; oss << "alice = 1\n" << "bob=7.5\n"; @@ -581,7 +581,7 @@ TEST_F(Test_ArgMap_SampleFile, arguments_from_simple_file) { EXPECT_EQ(opts.arg3, ""); } -TEST_F(Test_ArgMap_SampleFile, handling_comments_from_simple_file) { +TEST_F(TestArgMapSampleFile, handlingCommentsFromSimpleFile) { std::ostringstream oss; oss << "# An initial comment line.\n" << "alice = 1\n" @@ -609,7 +609,7 @@ TEST_F(Test_ArgMap_SampleFile, handling_comments_from_simple_file) { EXPECT_EQ(opts.arg3, ""); } -TEST_F(Test_ArgMap_SampleFile, file_does_not_exist) { +TEST_F(TestArgMapSampleFile, fileDoesNotExist) { struct Opts { int arg1; } opts; diff --git a/src/tests/Test_bootstrapping_with_multiplications.cpp b/src/tests/TestBootstrappingWithMultiplications.cpp similarity index 92% rename from src/tests/Test_bootstrapping_with_multiplications.cpp rename to src/tests/TestBootstrappingWithMultiplications.cpp index e359a5103..908da621f 100644 --- a/src/tests/Test_bootstrapping_with_multiplications.cpp +++ b/src/tests/TestBootstrappingWithMultiplications.cpp @@ -66,7 +66,7 @@ struct Parameters { }; -class Test_fat_bootstrapping_with_multiplications : public ::testing::TestWithParam { +class TestFatBootstrappingWithMultiplications : public ::testing::TestWithParam { protected: const long n; // Number of multiplications to perform @@ -75,7 +75,7 @@ class Test_fat_bootstrapping_with_multiplications : public ::testing::TestWithPa helib::FHEPubKey publicKey; const helib::EncryptedArray& ea; - Test_fat_bootstrapping_with_multiplications () : + TestFatBootstrappingWithMultiplications () : n(GetParam().n), context(GetParam().m, GetParam().p, GetParam().r, GetParam().gens, GetParam().ords), @@ -195,7 +195,7 @@ void multiplyPtxt(std::vector ptxt, } } -TEST_P(Test_fat_bootstrapping_with_multiplications, correctly_performs_fat_bootstrapping_with_no_multiplications) { +TEST_P(TestFatBootstrappingWithMultiplications, correctlyPerformsFatBootstrappingWithNoMultiplications) { const long nslots = ea.size(); std::vector ptxt(generateRandomBinaryVector(nslots)); // Random 0s and 1s helib::Ctxt ctxt(publicKey); @@ -217,7 +217,7 @@ TEST_P(Test_fat_bootstrapping_with_multiplications, correctly_performs_fat_boots EXPECT_EQ(decrypted, ptxt); } -TEST_P(Test_fat_bootstrapping_with_multiplications, correctly_performs_fat_bootstrapping_with_multiplications) { +TEST_P(TestFatBootstrappingWithMultiplications, correctlyPerformsFatBootstrappingWithMultiplications) { const long nslots = ea.size(); const long p2r = context.alMod.getPPowR(); std::vector ptxt(generateRandomBinaryVector(nslots)); // Random 0s and 1s @@ -258,7 +258,7 @@ TEST_P(Test_fat_bootstrapping_with_multiplications, correctly_performs_fat_boots } } -INSTANTIATE_TEST_SUITE_P(typical_parameters, Test_fat_bootstrapping_with_multiplications, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, TestFatBootstrappingWithMultiplications, ::testing::Values( //FAST Parameters(31*41, 2, 1, 2, 380, 64, 100, 30, {31, 41}, {1026, 249}, {30, -2}), Parameters(7*5*37, 17, 1, 3, 600, 64, 100, 40, {7, 5, 37}, {556, 1037}, {6, 4}) @@ -268,7 +268,7 @@ INSTANTIATE_TEST_SUITE_P(typical_parameters, Test_fat_bootstrapping_with_multipl )); -class Test_thin_bootstrapping_with_multiplications : public ::testing::TestWithParam { +class TestThinBootstrappingWithMultiplications : public ::testing::TestWithParam { protected: const long n; // Number of multiplications to perform @@ -277,7 +277,7 @@ class Test_thin_bootstrapping_with_multiplications : public ::testing::TestWithP helib::FHEPubKey publicKey; const helib::EncryptedArray& ea; - Test_thin_bootstrapping_with_multiplications () : + TestThinBootstrappingWithMultiplications () : n(GetParam().n), context(GetParam().m, GetParam().p, GetParam().r, GetParam().gens, GetParam().ords), @@ -336,7 +336,7 @@ class Test_thin_bootstrapping_with_multiplications : public ::testing::TestWithP } }; -TEST_P(Test_thin_bootstrapping_with_multiplications, correctly_performs_thin_bootstrapping_with_no_multiplications) { +TEST_P(TestThinBootstrappingWithMultiplications, correctlyPerformsThinBootstrappingWithNoMultiplications) { const long nslots = ea.size(); std::vector ptxt(generateRandomBinaryVector(nslots)); // Random 0s and 1s helib::Ctxt ctxt(publicKey); @@ -358,7 +358,7 @@ TEST_P(Test_thin_bootstrapping_with_multiplications, correctly_performs_thin_boo EXPECT_EQ(decrypted, ptxt); } -TEST_P(Test_thin_bootstrapping_with_multiplications, correctly_performs_thin_bootstrapping_with_multiplications) { +TEST_P(TestThinBootstrappingWithMultiplications, correctlyPerformsThinBootstrappingWithMultiplications) { const long nslots = ea.size(); const long p2r = context.alMod.getPPowR(); std::vector ptxt(generateRandomBinaryVector(nslots)); // Random 0s and 1s @@ -399,7 +399,7 @@ TEST_P(Test_thin_bootstrapping_with_multiplications, correctly_performs_thin_boo } } -INSTANTIATE_TEST_SUITE_P(typical_parameters, Test_thin_bootstrapping_with_multiplications, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, TestThinBootstrappingWithMultiplications, ::testing::Values( //FAST Parameters(31*41, 2, 1, 2, 320, 64, 100, 25, {31, 41}, {1026, 249}, {30, -2}), Parameters(7*5*37, 17, 1, 3, 500, 64, 100, 30, {7, 5, 37}, {556, 1037}, {6, 4}) diff --git a/src/tests/Test_CKKS.cpp b/src/tests/TestCKKS.cpp similarity index 93% rename from src/tests/Test_CKKS.cpp rename to src/tests/TestCKKS.cpp index dc180fe01..8e4839301 100644 --- a/src/tests/Test_CKKS.cpp +++ b/src/tests/TestCKKS.cpp @@ -140,7 +140,7 @@ struct Parameters { p = tmp; } -class Test_CKKS : public ::testing::TestWithParam { +class TestCKKS : public ::testing::TestWithParam { protected: const long m; // Zm* const long r; // bit precision @@ -152,7 +152,7 @@ class Test_CKKS : public ::testing::TestWithParam { const helib::FHEPubKey publicKey; const helib::EncryptedArrayCx& ea; - Test_CKKS () : + TestCKKS () : m(GetParam().m), r(GetParam().r), L(GetParam().L), @@ -185,7 +185,7 @@ class Test_CKKS : public ::testing::TestWithParam { }; -TEST_P(Test_CKKS, negating_ciphertext_works) +TEST_P(TestCKKS, negatingCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2; @@ -210,7 +210,7 @@ TEST_P(Test_CKKS, negating_ciphertext_works) EXPECT_EQ(pm, c1.getPtxtMag()); } -TEST_P(Test_CKKS, adding_poly_constant_to_ciphertext_works) +TEST_P(TestCKKS, addingPolyConstantToCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2, vd3; @@ -234,7 +234,7 @@ TEST_P(Test_CKKS, adding_poly_constant_to_ciphertext_works) << ", maxDiff=" << calcMaxDiff(vd1,vd3) << std::endl << std::endl; } -TEST_P(Test_CKKS, adding_negated_poly_constant_to_ciphertext_works) +TEST_P(TestCKKS, addingNegatedPolyConstantToCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2, vd3; @@ -260,7 +260,7 @@ TEST_P(Test_CKKS, adding_negated_poly_constant_to_ciphertext_works) << ", maxRelDiff=" << calcMaxRelDiff(vd1,vd3) << std::endl << std::endl; } -TEST_P(Test_CKKS, multiplying_poly_constant_to_ciphertext_works) +TEST_P(TestCKKS, multiplyingPolyConstantToCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2, vd3; @@ -287,7 +287,7 @@ TEST_P(Test_CKKS, multiplying_poly_constant_to_ciphertext_works) EXPECT_EQ(pm, c1.getPtxtMag()); } -TEST_P(Test_CKKS, adding_double_to_ciphertext_works) +TEST_P(TestCKKS, addingDoubleToCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2; @@ -310,7 +310,7 @@ TEST_P(Test_CKKS, adding_double_to_ciphertext_works) << ", maxDiff=" << calcMaxDiff(vd1,vd2) << std::endl << std::endl; } -TEST_P(Test_CKKS, multiplying_double_to_ciphertext_works) +TEST_P(TestCKKS, multiplyingDoubleToCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2, vd0; @@ -340,7 +340,7 @@ TEST_P(Test_CKKS, multiplying_double_to_ciphertext_works) EXPECT_EQ(pm, c1.getPtxtMag()); } -TEST_P(Test_CKKS, getting_the_complex_conjugate_works) +TEST_P(TestCKKS, gettingTheComplexConjugateWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2; @@ -365,7 +365,7 @@ TEST_P(Test_CKKS, getting_the_complex_conjugate_works) EXPECT_EQ(pm, c1.getPtxtMag()); } -TEST_P(Test_CKKS, rotating_ciphertext_works) +TEST_P(TestCKKS, rotatingCiphertextWorks) { helib::Ctxt c1(publicKey); std::vector> vd1, vd2; @@ -389,7 +389,7 @@ TEST_P(Test_CKKS, rotating_ciphertext_works) EXPECT_EQ(pm, c1.getPtxtMag()); } -TEST_P(Test_CKKS, adding_ciphertexts_works) +TEST_P(TestCKKS, addingCiphertextsWorks) { helib::Ctxt c1(publicKey), c2(publicKey); std::vector> vd1, vd2, vd3; @@ -409,7 +409,7 @@ TEST_P(Test_CKKS, adding_ciphertexts_works) << ", maxDiff=" << calcMaxDiff(vd1,vd3) << std::endl << std::endl; } -TEST_P(Test_CKKS, subtracting_ciphertexts_works) +TEST_P(TestCKKS, subtractingCiphertextsWorks) { helib::Ctxt c1(publicKey), c2(publicKey); std::vector> vd1, vd2, vd3; @@ -429,7 +429,7 @@ TEST_P(Test_CKKS, subtracting_ciphertexts_works) << ", maxDiff=" << calcMaxDiff(vd1,vd3) << std::endl << std::endl; } -TEST_P(Test_CKKS, raw_multiplication_of_ciphertexts_works) +TEST_P(TestCKKS, rawMultiplicationOfCiphertextsWorks) { helib::Ctxt c1(publicKey), c2(publicKey); std::vector> vd1, vd2, vd3; @@ -451,7 +451,7 @@ TEST_P(Test_CKKS, raw_multiplication_of_ciphertexts_works) EXPECT_EQ(expectedPtxtMag, c1.getPtxtMag()); } -TEST_P(Test_CKKS, high_level_multiplication_of_ciphertexts_works) +TEST_P(TestCKKS, highLevelMultiplicationOfCiphertextsWorks) { helib::Ctxt c1(publicKey), c2(publicKey); std::vector> vd1, vd2, vd3; @@ -473,7 +473,7 @@ TEST_P(Test_CKKS, high_level_multiplication_of_ciphertexts_works) EXPECT_EQ(expectedPtxtMag, c1.getPtxtMag()); } -TEST_P(Test_CKKS, multiplying_ciphertext_by_negative_constant_and_then_adding_to_other_ciphertext_works) +TEST_P(TestCKKS, multiplyingCiphertextByNegativeConstantAndThenAddingToOtherCiphertextWorks) { helib::Ctxt c1(publicKey), c2(publicKey); std::vector> vd1, vd2, vd3, vd4; @@ -496,7 +496,7 @@ TEST_P(Test_CKKS, multiplying_ciphertext_by_negative_constant_and_then_adding_to << ", maxDiff=" << calcMaxDiff(vd1,vd4) << std::endl << std::endl; } -INSTANTIATE_TEST_SUITE_P(typical_parameters, Test_CKKS, ::testing::Values( +INSTANTIATE_TEST_SUITE_P(typicalParameters, TestCKKS, ::testing::Values( //SLOW Parameters(1024, 20, 150, 0.01) //FAST diff --git a/src/tests/Test_Context.cpp b/src/tests/TestContext.cpp similarity index 90% rename from src/tests/Test_Context.cpp rename to src/tests/TestContext.cpp index b5add9827..f36480cf1 100644 --- a/src/tests/Test_Context.cpp +++ b/src/tests/TestContext.cpp @@ -54,19 +54,19 @@ class TestContext : public ::testing::TestWithParam }; TEST_P(TestContext, - Context_throw_exception_when_calculating_security_before_modchain_built) + ContextThrowExceptionWhenCalculatingSecurityBeforeModchainBuilt) { EXPECT_THROW(context->securityLevel(), helib::LogicError); } -TEST_P(TestContext, Context_calculating_security_after_modchain_built) +TEST_P(TestContext, ContextCalculatingSecurityAfterModchainBuilt) { buildModChain(*context, /*bits=*/100, /*c=*/2); double result = context->securityLevel(); EXPECT_FALSE(std::isinf(result)); } -INSTANTIATE_TEST_SUITE_P(various_parameters, +INSTANTIATE_TEST_SUITE_P(variousParameters, TestContext, ::testing::Values(BGVParameters(17, 2, 1))); diff --git a/src/tests/Test_errorHandling.cpp b/src/tests/TestErrorHandling.cpp similarity index 64% rename from src/tests/Test_errorHandling.cpp rename to src/tests/TestErrorHandling.cpp index de01b43f4..54559aba0 100644 --- a/src/tests/Test_errorHandling.cpp +++ b/src/tests/TestErrorHandling.cpp @@ -18,12 +18,12 @@ namespace { // LOGIC_ERROR -TEST(Test_error_handling, helib_LogicError_can_be_caught_as_helib_exception) +TEST(TestErrorHandling, helibLogicErrorCanBeCaughtAsHelibException) { EXPECT_THROW(throw helib::LogicError("Some logic error message"), helib::Exception); } -TEST(Test_error_handling, helib_LogicError_returns_what_string_through_helib_exception) +TEST(TestErrorHandling, helibLogicErrorReturnsWhatStringThroughHelibException) { const std::string what("Some logic error message"); try { @@ -33,7 +33,7 @@ TEST(Test_error_handling, helib_LogicError_returns_what_string_through_helib_exc } } -TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_helib_exception) +TEST(TestErrorHandling, helibLogicErrorReturnsCStyleWhatStringThroughHelibException) { const char* what = "Some logic error message"; try { @@ -43,12 +43,12 @@ TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_h } } -TEST(Test_error_handling, helib_LogicError_can_be_caught_as_std_exception) +TEST(TestErrorHandling, helibLogicErrorCanBeCaughtAsStdException) { EXPECT_THROW(throw helib::LogicError("Some logic error message"), std::exception); } -TEST(Test_error_handling, helib_LogicError_returns_what_string_through_std_exception) +TEST(TestErrorHandling, helibLogicErrorReturnsWhatStringThroughStdException) { const std::string what("Some logic error message"); try { @@ -58,7 +58,7 @@ TEST(Test_error_handling, helib_LogicError_returns_what_string_through_std_excep } } -TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_std_exception) +TEST(TestErrorHandling, helibLogicErrorReturnsCStyleWhatStringThroughStdException) { const char* what = "Some logic error message"; try { @@ -68,12 +68,12 @@ TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_s } } -TEST(Test_error_handling, helib_LogicError_can_be_caught_as_std_logic_error) +TEST(TestErrorHandling, helibLogicErrorCanBeCaughtAsStdLogicError) { EXPECT_THROW(throw helib::LogicError("Some logic error message"), std::logic_error); } -TEST(Test_error_handling, helib_LogicError_returns_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibLogicErrorReturnsWhatStringThroughStdLogicError) { const std::string what("Some logic error message"); try { @@ -83,7 +83,7 @@ TEST(Test_error_handling, helib_LogicError_returns_what_string_through_std_logic } } -TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibLogicErrorReturnsCStyleWhatStringThroughStdLogicError) { const char* what = "Some logic error message"; try { @@ -95,12 +95,12 @@ TEST(Test_error_handling, helib_LogicError_returns_c_style_what_string_through_s //RUNTIME_ERROR -TEST(Test_error_handling, helib_RuntimeError_can_be_caught_as_helib_exception) +TEST(TestErrorHandling, helibRuntimeErrorCanBeCaughtAsHelibException) { EXPECT_THROW(throw helib::RuntimeError("Some runtime error message"), helib::Exception); } -TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_helib_exception) +TEST(TestErrorHandling, helibRuntimeErrorReturnsWhatStringThroughHelibException) { const std::string what("Some runtime error message"); try { @@ -110,7 +110,7 @@ TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_helib_e } } -TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through_helib_exception) +TEST(TestErrorHandling, helibRuntimeErrorReturnsCStyleWhatStringThroughHelibException) { const char* what = "Some runtime error message"; try { @@ -120,12 +120,12 @@ TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through } } -TEST(Test_error_handling, helib_RuntimeError_can_be_caught_as_std_exception) +TEST(TestErrorHandling, helibRuntimeErrorCanBeCaughtAsStdException) { EXPECT_THROW(throw helib::RuntimeError("Some runtime error message"), std::exception); } -TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_std_exception) +TEST(TestErrorHandling, helibRuntimeErrorReturnsWhatStringThroughStdException) { const std::string what("Some runtime error message"); try { @@ -135,7 +135,7 @@ TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_std_exc } } -TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through_std_exception) +TEST(TestErrorHandling, helibRuntimeErrorReturnsCStyleWhatStringThroughStdException) { const char* what = "Some runtime error message"; try { @@ -145,12 +145,12 @@ TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through } } -TEST(Test_error_handling, helib_RuntimeError_can_be_caught_as_std_runtime_error) +TEST(TestErrorHandling, helibRuntimeErrorCanBeCaughtAsStdRuntimeError) { EXPECT_THROW(throw helib::RuntimeError("Some runtime error message"), std::runtime_error); } -TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_std_runtime_error) +TEST(TestErrorHandling, helibRuntimeErrorReturnsWhatStringThroughStdRuntimeError) { const std::string what("Some runtime error message"); try { @@ -160,7 +160,7 @@ TEST(Test_error_handling, helib_RuntimeError_returns_what_string_through_std_run } } -TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through_std_runtime_error) +TEST(TestErrorHandling, helibRuntimeErrorReturnsCStyleWhatStringThroughStdRuntimeError) { const char* what = "Some runtime error message"; try { @@ -173,12 +173,12 @@ TEST(Test_error_handling, helib_RuntimeError_returns_c_style_what_string_through //OutOfRangeError tests -TEST(Test_error_handling, helib_OutOfRangeError_can_be_caught_as_helib_OutOfRangeError) +TEST(TestErrorHandling, helibOutOfRangeErrorCanBeCaughtAsHelibOutOfRangeError) { EXPECT_THROW(throw helib::OutOfRangeError("Some out of range error message"), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_helib_OutOfRangeError) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsWhatStringThroughHelibOutOfRangeError) { const std::string what("Some out of range error message"); try { @@ -188,7 +188,7 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_heli } } -TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_through_helib_OutOfRangeError) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsCStyleWhatStringThroughHelibOutOfRangeError) { const char* what = "Some out of range error message"; try { @@ -198,12 +198,12 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_OutOfRangeError_can_be_caught_as_helib_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorCanBeCaughtAsHelibException) { EXPECT_THROW(throw helib::OutOfRangeError("Some out of range error message"), helib::Exception); } -TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_helib_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsWhatStringThroughHelibException) { const std::string what("Some out of range error message"); try { @@ -213,7 +213,7 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_heli } } -TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_through_helib_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsCStyleWhatStringThroughHelibException) { const char* what = "Some out of range error message"; try { @@ -223,12 +223,12 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_OutOfRangeError_can_be_caught_as_std_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorCanBeCaughtAsStdException) { EXPECT_THROW(throw helib::OutOfRangeError("Some out of range error message"), std::exception); } -TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_std_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsWhatStringThroughStdException) { const std::string what("Some out of range error message"); try { @@ -238,7 +238,7 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_std_ } } -TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_through_std_exception) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsCStyleWhatStringThroughStdException) { const char* what = "Some out of range error message"; try { @@ -248,12 +248,12 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_OutOfRangeError_can_be_caught_as_std_logic_error) +TEST(TestErrorHandling, helibOutOfRangeErrorCanBeCaughtAsStdLogicError) { EXPECT_THROW(throw helib::OutOfRangeError("Some out of range error message"), std::logic_error); } -TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsWhatStringThroughStdLogicError) { const std::string what("Some out of range error message"); try { @@ -263,7 +263,7 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_std_ } } -TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibOutOfRangeErrorReturnsCStyleWhatStringThroughStdLogicError) { const char* what = "Some out of range error message"; try { @@ -273,12 +273,12 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro } } - TEST(Test_error_handling, helib_OutOfRangeError_can_be_caught_as_std_out_of_range) + TEST(TestErrorHandling, helibOutOfRangeErrorCanBeCaughtAsStdOutOfRange) { EXPECT_THROW(throw helib::OutOfRangeError("Some out of range error message"), std::out_of_range); } - TEST(Test_error_handling, helib_OutOfRangeError_returns_what_string_through_std_out_of_range) + TEST(TestErrorHandling, helibOutOfRangeErrorReturnsWhatStringThroughStdOutOfRange) { const std::string what("Some out of range error message"); try { @@ -288,7 +288,7 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro } } - TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_through_std_out_of_range) + TEST(TestErrorHandling, helibOutOfRangeErrorReturnsCStyleWhatStringThroughStdOutOfRange) { const char* what = "Some out of range error message"; try { @@ -300,12 +300,12 @@ TEST(Test_error_handling, helib_OutOfRangeError_returns_c_style_what_string_thro //InvalidArgument tests -TEST(Test_error_handling, helib_InvalidArgument_can_be_caught_as_helib_InvalidArgument) +TEST(TestErrorHandling, helibInvalidArgumentCanBeCaughtAsHelibInvalidArgument) { EXPECT_THROW(throw helib::InvalidArgument("Some invalid argument error message"), helib::InvalidArgument); } -TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_helib_InvalidArgument) +TEST(TestErrorHandling, helibInvalidArgumentReturnsWhatStringThroughHelibInvalidArgument) { const std::string what("Some invalid argument error message"); try { @@ -315,7 +315,7 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_heli } } -TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_through_helib_InvalidArgument) +TEST(TestErrorHandling, helibInvalidArgumentReturnsCStyleWhatStringThroughHelibInvalidArgument) { const char* what = "Some invalid argument error message"; try { @@ -325,12 +325,12 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_InvalidArgument_can_be_caught_as_helib_exception) +TEST(TestErrorHandling, helibInvalidArgumentCanBeCaughtAsHelibException) { EXPECT_THROW(throw helib::InvalidArgument("Some invalid argument error message"), helib::Exception); } -TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_helib_exception) +TEST(TestErrorHandling, helibInvalidArgumentReturnsWhatStringThroughHelibException) { const std::string what("Some invalid argument error message"); try { @@ -340,7 +340,7 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_heli } } -TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_through_helib_exception) +TEST(TestErrorHandling, helibInvalidArgumentReturnsCStyleWhatStringThroughHelibException) { const char* what = "Some invalid argument error message"; try { @@ -350,12 +350,12 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_InvalidArgument_can_be_caught_as_std_exception) +TEST(TestErrorHandling, helibInvalidArgumentCanBeCaughtAsStdException) { EXPECT_THROW(throw helib::InvalidArgument("Some invalid argument error message"), std::exception); } -TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_exception) +TEST(TestErrorHandling, helibInvalidArgumentReturnsWhatStringThroughStdException) { const std::string what("Some invalid argument error message"); try { @@ -365,7 +365,7 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_ } } -TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_through_std_exception) +TEST(TestErrorHandling, helibInvalidArgumentReturnsCStyleWhatStringThroughStdException) { const char* what = "Some invalid argument error message"; try { @@ -375,12 +375,12 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_InvalidArgument_can_be_caught_as_std_logic_error) +TEST(TestErrorHandling, helibInvalidArgumentCanBeCaughtAsStdLogicError) { EXPECT_THROW(throw helib::InvalidArgument("Some invalid argument message"), std::logic_error); } -TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibInvalidArgumentReturnsWhatStringThroughStdLogicError) { const std::string what("Some invalid argument message"); try { @@ -390,7 +390,7 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_ } } -TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_through_std_logic_error) +TEST(TestErrorHandling, helibInvalidArgumentReturnsCStyleWhatStringThroughStdLogicError) { const char* what = "Some invalid argument message"; try { @@ -400,12 +400,12 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_thro } } -TEST(Test_error_handling, helib_InvalidArgument_can_be_caught_as_std_invalid_argument) +TEST(TestErrorHandling, helibInvalidArgumentCanBeCaughtAsStdInvalidArgument) { EXPECT_THROW(throw helib::InvalidArgument("Some invalid argument message"), std::invalid_argument); } -TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_invalid_argument) +TEST(TestErrorHandling, helibInvalidArgumentReturnsWhatStringThroughStdInvalidArgument) { const std::string what("Some invalid argument message"); try { @@ -415,7 +415,7 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_what_string_through_std_ } } -TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_through_std_invalid_argument) +TEST(TestErrorHandling, helibInvalidArgumentReturnsCStyleWhatStringThroughStdInvalidArgument) { const char* what = "Some invalid argument message"; try { @@ -426,35 +426,35 @@ TEST(Test_error_handling, helib_InvalidArgument_returns_c_style_what_string_thro } //Cross exception catch disabled -TEST(Test_error_handling, helib_LogicError_cannot_be_caught_as_RuntimeError) +TEST(TestErrorHandling, helibLogicErrorCannotBeCaughtAsRuntimeError) { EXPECT_THROW(try { throw helib::LogicError("Some logic error message"); } catch (const helib::RuntimeError& err) { }, helib::LogicError); } -TEST(Test_error_handling, helib_LogicError_cannot_be_caught_as_std_runtime_error) +TEST(TestErrorHandling, helibLogicErrorCannotBeCaughtAsStdRuntimeError) { EXPECT_THROW(try { throw helib::LogicError("Some logic error message"); } catch (const std::runtime_error& err) { }, helib::LogicError); } -TEST(Test_error_handling, helib_RuntimeError_cannot_be_caught_as_LogicError) +TEST(TestErrorHandling, helibRuntimeErrorCannotBeCaughtAsLogicError) { EXPECT_THROW(try { throw helib::RuntimeError("Some runtime error message"); } catch (const helib::LogicError& err) { }, helib::RuntimeError); } -TEST(Test_error_handling, helib_RuntimeError_cannot_be_caught_as_std_logic_error) +TEST(TestErrorHandling, helibRuntimeErrorCannotBeCaughtAsStdLogicError) { EXPECT_THROW(try { throw helib::RuntimeError("Some runtime error message"); } catch (const std::logic_error& err) { }, helib::RuntimeError); } -TEST(Test_error_handling, helib_InvalidArgument_cannot_be_caught_as_std_runtime_error) +TEST(TestErrorHandling, helibInvalidArgumentCannotBeCaughtAsStdRuntimeError) { EXPECT_THROW(try { throw helib::InvalidArgument("Some invalid argument message"); } catch (const std::runtime_error& err) {}, @@ -463,127 +463,127 @@ TEST(Test_error_handling, helib_InvalidArgument_cannot_be_caught_as_std_runtime_ //Testing assertions //Testing assertTrue -TEST(Test_error_handling, helib_assert_true_no_throws_on_true) +TEST(TestErrorHandling, helibAssertTrueNoThrowsOnTrue) { EXPECT_NO_THROW(helib::assertTrue(true, "Value is false")); } -TEST(Test_error_handling, helib_assert_true_throws_LogicError_on_false) +TEST(TestErrorHandling, helibAssertTrueThrowsLogicErrorOnFalse) { EXPECT_THROW(helib::assertTrue(false, "Value is false"), helib::LogicError); } -TEST(Test_error_handling, helib_assert_true_throws_non_default_exceptions) { +TEST(TestErrorHandling, helibAssertTrueThrowsNonDefaultExceptions) { EXPECT_THROW(helib::assertTrue(false, "Value is false"), helib::RuntimeError); } // assertFalse -TEST(Test_error_handling, helib_assertFalse_throws_LogicError_on_true) +TEST(TestErrorHandling, helibAssertFalseThrowsLogicErrorOnTrue) { EXPECT_THROW(helib::assertFalse(true, "Value is false"), helib::LogicError); } -TEST(Test_error_handling, helib_assertFalse_no_throws_on_false) +TEST(TestErrorHandling, helibAssertFalseNoThrowsOnFalse) { EXPECT_NO_THROW(helib::assertFalse(false, "Value is false")); } -TEST(Test_error_handling, helib_assertFalse_throws_non_default_exceptions) { +TEST(TestErrorHandling, helibAssertFalseThrowsNonDefaultExceptions) { EXPECT_THROW(helib::assertFalse(true, "Value is false"), helib::RuntimeError); } //Testing assertEq -TEST(Test_error_handling, helib_assertEq_no_throws_if_args_are_equals) +TEST(TestErrorHandling, helibAssertEqNoThrowsIfArgsAreEquals) { int a(10), b(10); EXPECT_NO_THROW(helib::assertEq(a, b, "Expected a == b")); } -TEST(Test_error_handling, helib_assertEq_throws_default_LogicError) +TEST(TestErrorHandling, helibAssertEqThrowsDefaultLogicError) { int a(10), b(40); EXPECT_THROW(helib::assertEq(a, b, "Expected a == b"), helib::LogicError); } -TEST(Test_error_handling, helib_assertEq_no_throws_with_custom_eq_elems_identical) { +TEST(TestErrorHandling, helibAssertEqNoThrowsWithCustomEqElemsIdentical) { std::vector a{1, 2}; std::vector b{1, 2}; EXPECT_NO_THROW(helib::assertEq(a, b, "Expected a == b")); } -TEST(Test_error_handling, helib_assertEq_throws_with_custom_eq_elems_differ) { +TEST(TestErrorHandling, helibAssertEqThrowsWithCustomEqElemsDiffer) { std::vector a{1, 2}; std::vector b{5, 6}; EXPECT_THROW(helib::assertEq(a, b, "Expected a == b"), helib::LogicError); } -TEST(Test_error_handling, helib_assertEq_throws_templated_exception) +TEST(TestErrorHandling, helibAssertEqThrowsTemplatedException) { int a(10), b(40); EXPECT_THROW(helib::assertEq(a, b, "Expected a == b"), helib::RuntimeError); } //Testing assertNEq -TEST(Test_error_handling, helib_assertNeq_throws_default_LogicError_if_args_are_equals) +TEST(TestErrorHandling, helibAssertNeqThrowsDefaultLogicErrorIfArgsAreEquals) { int a(10), b(10); EXPECT_THROW(helib::assertNeq(a, b, "Expected a != b"), helib::LogicError); } -TEST(Test_error_handling, helib_assertNeq_no_throws_default_LogicError_if_args_differ) +TEST(TestErrorHandling, helibAssertNeqNoThrowsDefaultLogicErrorIfArgsDiffer) { int a(10), b(40); EXPECT_NO_THROW(helib::assertNeq(a, b, "Expected a != b")); } -TEST(Test_error_handling, helib_assertNeq_throws_with_custom_eq_elems_identical) { +TEST(TestErrorHandling, helibAssertNeqThrowsWithCustomEqElemsIdentical) { std::vector a{1, 2}; std::vector b{1, 2}; EXPECT_THROW(helib::assertNeq(a, b, "Expected a != b"), helib::LogicError); } -TEST(Test_error_handling, helib_assertNeq_no_throws_with_custom_eq_elems_differ) { +TEST(TestErrorHandling, helibAssertNeqNoThrowsWithCustomEqElemsDiffer) { std::vector a{1, 2}; std::vector b{5, 6}; EXPECT_NO_THROW(helib::assertNeq(a, b, "Expected a != b")); } //assertNotNull -TEST(Test_error_handling, helib_assertNotNull_throws_default_LogicError_if_arg_is_null) +TEST(TestErrorHandling, helibAssertNotNullThrowsDefaultLogicErrorIfArgIsNull) { void *p = nullptr; EXPECT_THROW(helib::assertNotNull(p, "Expected not null p"), helib::LogicError); } -TEST(Test_error_handling, helib_assertNotNull_no_throws_default_LogicError_if_args_differ) +TEST(TestErrorHandling, helibAssertNotNullNoThrowsDefaultLogicErrorIfArgsDiffer) { int x; int *p = &x; EXPECT_NO_THROW(helib::assertNotNull(p, "Expected not null p")); } -TEST(Test_error_handling, helib_assertNotNull_throws_with_default_constructed_shared_ptr) { +TEST(TestErrorHandling, helibAssertNotNullThrowsWithDefaultConstructedSharedPtr) { std::shared_ptr p; EXPECT_THROW(helib::assertNotNull(p, "Expected not null p"), helib::LogicError); } -TEST(Test_error_handling, helib_assertNotNull_no_throws_with_valid_shared_ptr) { +TEST(TestErrorHandling, helibAssertNotNullNoThrowsWithValidSharedPtr) { std::shared_ptr p = std::make_shared(10); EXPECT_NO_THROW(helib::assertNotNull(p, "Expected not null p")); } -TEST(Test_error_handling, helib_assertNotNull_throws_with_c_NULL) { +TEST(TestErrorHandling, helibAssertNotNullThrowsWithCNULL) { void* p = NULL; EXPECT_THROW(helib::assertNotNull(p, "Expected not null p"), helib::LogicError); } -TEST(Test_error_handling, helib_assertNotNull_throws_non_standard_helib_exception) { +TEST(TestErrorHandling, helibAssertNotNullThrowsNonStandardHelibException) { int *p = nullptr; EXPECT_THROW(helib::assertNotNull(p, "Expected not null p"), helib::RuntimeError); } // assertInRange -TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_range_int) +TEST(TestErrorHandling, helibAssertInRangeNoThrowsOutOfBoundErrorWhenInRangeInt) { int element = 15; int min = 10; @@ -591,7 +591,7 @@ TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_ EXPECT_NO_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)")); } -TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_left_range) +TEST(TestErrorHandling, helibAssertInRangeNoThrowsOutOfBoundErrorWhenInLeftRange) { int element = 10; int min = 10; @@ -599,7 +599,7 @@ TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_ EXPECT_NO_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)")); } -TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_less_than_min) +TEST(TestErrorHandling, helibAssertInRangeThrowsOutOfBoundErrorWhenLessThanMin) { int element = 5; int min = 10; @@ -607,7 +607,7 @@ TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_less_t EXPECT_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)"), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_greater_than_max) +TEST(TestErrorHandling, helibAssertInRangeThrowsOutOfBoundErrorWhenGreaterThanMax) { int element = 100; int min = 10; @@ -615,7 +615,7 @@ TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_greate EXPECT_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)"), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_equals_max) +TEST(TestErrorHandling, helibAssertInRangeThrowsOutOfBoundErrorWhenEqualsMax) { int element = 50; int min = 10; @@ -623,7 +623,7 @@ TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_equals EXPECT_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)"), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_range_int_and_right_inclusive) +TEST(TestErrorHandling, helibAssertInRangeNoThrowsOutOfBoundErrorWhenInRangeIntAndRightInclusive) { int element = 15; int min = 10; @@ -631,7 +631,7 @@ TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_ EXPECT_NO_THROW(helib::assertInRange(element, min, max, "elem not in [min, max)", true)); } -TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_left_range_and_right_inclusive) +TEST(TestErrorHandling, helibAssertInRangeNoThrowsOutOfBoundErrorWhenInLeftRangeAndRightInclusive) { int element = 10; int min = 10; @@ -639,7 +639,7 @@ TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_in_ EXPECT_NO_THROW(helib::assertInRange(element, min, max, "elem not in [min, max]", true)); } -TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_less_than_min_and_right_inclusive) +TEST(TestErrorHandling, helibAssertInRangeThrowsOutOfBoundErrorWhenLessThanMinAndRightInclusive) { int element = 5; int min = 10; @@ -647,7 +647,7 @@ TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_less_t EXPECT_THROW(helib::assertInRange(element, min, max, "elem not in [min, max]", true), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_greater_than_max_and_right_inclusive) +TEST(TestErrorHandling, helibAssertInRangeThrowsOutOfBoundErrorWhenGreaterThanMaxAndRightInclusive) { int element = 100; int min = 10; @@ -655,7 +655,7 @@ TEST(Test_error_handling, helib_assertInRange_throws_OutOfBoundError_when_greate EXPECT_THROW(helib::assertInRange(element, min, max, "elem not in [min, max]", true), helib::OutOfRangeError); } -TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_equals_max_and_right_inclusive) +TEST(TestErrorHandling, helibAssertInRangeNoThrowsOutOfBoundErrorWhenEqualsMaxAndRightInclusive) { int element = 50; int min = 10; @@ -663,7 +663,7 @@ TEST(Test_error_handling, helib_assertInRange_no_throws_OutOfBoundError_when_equ EXPECT_NO_THROW(helib::assertInRange(element, min, max, "elem not in [min, max]", true)); } -TEST(Test_error_handling, helib_assertInRange_throws_non_default_helib_RuntimeError) +TEST(TestErrorHandling, helibAssertInRangeThrowsNonDefaultHelibRuntimeError) { int element = 100; int min = 10; From 4a99e9a94423126c3a732fbe12c62f3158360811 Mon Sep 17 00:00:00 2001 From: Flavio A Bergamaschi Date: Mon, 2 Dec 2019 08:57:15 -0500 Subject: [PATCH 02/15] Dec2019 release (#254) --- .gitignore | 2 + Doxyfile | 2230 ++++---------------------------------------------- README.md | 95 +-- changes.md | 67 +- mainpage.dox | 176 +--- 5 files changed, 258 insertions(+), 2312 deletions(-) diff --git a/.gitignore b/.gitignore index f059e4786..7d5788242 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,5 @@ src/misc/*.txt !src/misc/iotest_asciiLE.txt !src/misc/iotest_binBE.bin !src/misc/iotest_binLE.bin +/html/ +/latex/ diff --git a/Doxyfile b/Doxyfile index 5d32f777c..5b6162d70 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,2323 +1,375 @@ -# Doxyfile 1.8.6 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - +# Doxyfile 1.8.11 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "HElib" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = 1.3 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "Implementing Homomorphic Encryption" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - +PROJECT_NAME = HElib +PROJECT_NUMBER = "Implementing Homomorphic Encryption" +PROJECT_LOGO = +OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - +ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - +ALIASES = +TCL_SUBST = OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - +EXTENSION_MAPPING = MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - +GROUP_NESTED_COMPOUNDS = NO SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - LOOKUP_CACHE_SIZE = 0 - #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: NO. - +EXTRACT_ALL = YES EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - +HIDE_COMPOUND_REFERENCE= NO SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. - -CITE_BIB_FILES = - +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - +WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - +WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - INPUT = mainpage.dox \ - src - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. + include/helib \ + src \ + examples/BGV_general_example \ + examples/binaryArith_example INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - +EXCLUDE = EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = Test* - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = *_impl - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. -# The default value is: NO. - CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - +CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - +IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = gh-pages - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - +HTML_OUTPUT = html HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - +HTML_TIMESTAMP = NO HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - +DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - +CHM_FILE = +HHC_LOCATION = GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - +CHM_INDEX_ENCODING = BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - +QCH_FILE = QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - +GENERATE_TREEVIEW = YES ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /