added a comment to tests

themachinethatgoesping · Oct 16, 2024 · 64d623c · 64d623c
1 parent ab71288
commit 64d623c
Show file tree

Hide file tree

Showing 16 changed files with 16 additions and 16 deletions.
diff --git a/src/tests/geoprocessing/backtracers/backtracedwci.test.cpp b/src/tests/geoprocessing/backtracers/backtracedwci.test.cpp
@@ -58,7 +58,7 @@ TEST_CASE("BacktracedWCI should support common functions", TESTTAG)
     CHECK(S[1].binary_hash() == 10310803827488579691ULL); 
 
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(BWCI.binary_hash() == 10221334945506934621ULL); 
     REQUIRE(BWCI.binary_hash() == BacktracedWCI(BWCI).binary_hash());
     REQUIRE(BWCI.binary_hash() == BacktracedWCI(BWCI.from_binary(BWCI.to_binary())).binary_hash());

diff --git a/src/tests/geoprocessing/backtracers/btconstantsvp.test.cpp b/src/tests/geoprocessing/backtracers/btconstantsvp.test.cpp
@@ -72,7 +72,7 @@ TEST_CASE("BTConstantSVP should support common functions", TESTTAG)
     REQUIRE_THAT(ypr[1], Catch::Matchers::WithinAbs(location.pitch, 0.0001));
     REQUIRE_THAT(ypr[2], Catch::Matchers::WithinAbs(location.roll, 0.0001));
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(backtracer.binary_hash() == 3830516406371434649);
     REQUIRE(backtracer.binary_hash() == BTConstantSVP(backtracer).binary_hash());
     REQUIRE(backtracer.binary_hash() ==

diff --git a/src/tests/geoprocessing/backtracers/i_backtracer.test.cpp b/src/tests/geoprocessing/backtracers/i_backtracer.test.cpp
@@ -57,7 +57,7 @@ TEST_CASE("I_Backtracer should support common functions", TESTTAG)
     REQUIRE_THAT(ypr[1], Catch::Matchers::WithinAbs(location.pitch, 0.0001));
     REQUIRE_THAT(ypr[2], Catch::Matchers::WithinAbs(location.roll, 0.0001));
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(backtracer.binary_hash() == 11759859546874707158ull);
     REQUIRE(backtracer.binary_hash() == I_Backtracer(backtracer).binary_hash());
     REQUIRE(backtracer.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/beamsampleparameters.test.cpp b/src/tests/geoprocessing/datastructures/beamsampleparameters.test.cpp
@@ -41,7 +41,7 @@ TEST_CASE("BeamSampleParameters should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(param.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(param.binary_hash() == 4652324683533098954);
     REQUIRE(param.binary_hash() == BeamSampleParameters(param).binary_hash());
     REQUIRE(param.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/raytraceresult.test.cpp b/src/tests/geoprocessing/datastructures/raytraceresult.test.cpp
@@ -37,7 +37,7 @@ TEST_CASE("RaytraceResult should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 5760038646027523138);
     REQUIRE(location.binary_hash() == RaytraceResult(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/raytraceresults.test.cpp b/src/tests/geoprocessing/datastructures/raytraceresults.test.cpp
@@ -40,7 +40,7 @@ TEST_CASE("RaytraceResults should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 4496877549998357265);
     REQUIRE(location.binary_hash() == RaytraceResults(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/sampledirections.test.cpp b/src/tests/geoprocessing/datastructures/sampledirections.test.cpp
@@ -38,7 +38,7 @@ TEST_CASE("SampleDirections should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 7946198183670543780);
     REQUIRE(location.binary_hash() == SampleDirections(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/sampledirectionsrange.test.cpp b/src/tests/geoprocessing/datastructures/sampledirectionsrange.test.cpp
@@ -39,7 +39,7 @@ TEST_CASE("SampleDirectionsRange should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 15106317722440586394ULL);
     REQUIRE(location.binary_hash() == SampleDirectionsRange(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/sampledirectionstime.test.cpp b/src/tests/geoprocessing/datastructures/sampledirectionstime.test.cpp
@@ -39,7 +39,7 @@ TEST_CASE("SampleDirectionsTime should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 15106317722440586394ULL);
     REQUIRE(location.binary_hash() == SampleDirectionsTime(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/sampleindices.test.cpp b/src/tests/geoprocessing/datastructures/sampleindices.test.cpp
@@ -38,7 +38,7 @@ TEST_CASE("SampleIndices should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 545582192469170180);
     REQUIRE(location.binary_hash() == SampleIndices(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/datastructures/xyz.test.cpp b/src/tests/geoprocessing/datastructures/xyz.test.cpp
@@ -39,7 +39,7 @@ TEST_CASE("XYZ should support common functions", TESTTAG)
     // test print does not crash
     REQUIRE(location.info_string().size() != 0);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(location.binary_hash() == 1848392524124629315);
     REQUIRE(location.binary_hash() == XYZ(location).binary_hash());
     REQUIRE(location.binary_hash() ==

diff --git a/src/tests/geoprocessing/raytracers/i_raytracer.test.cpp b/src/tests/geoprocessing/raytracers/i_raytracer.test.cpp
@@ -54,7 +54,7 @@ TEST_CASE("I_Raytracer should support common functions", TESTTAG)
     REQUIRE_THAT(ypr[1], Catch::Matchers::WithinAbs(location.pitch, 0.0001));
     REQUIRE_THAT(ypr[2], Catch::Matchers::WithinAbs(location.roll, 0.0001));
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(raytracer.binary_hash() == 17645473512760939812llu);
     REQUIRE(raytracer.binary_hash() == I_Raytracer(raytracer).binary_hash());
     REQUIRE(raytracer.binary_hash() ==

diff --git a/src/tests/geoprocessing/raytracers/rtconstantsvp.test.cpp b/src/tests/geoprocessing/raytracers/rtconstantsvp.test.cpp
@@ -73,7 +73,7 @@ TEST_CASE("RTConstantSVP should support common functions", TESTTAG)
 
     REQUIRE_THAT(raytracer.get_sound_velocity(), Catch::Matchers::WithinAbs(c, 0.0001));
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(raytracer.binary_hash() == 16667922773826043259llu);
     REQUIRE(raytracer.binary_hash() == RTConstantSVP(raytracer).binary_hash());
     REQUIRE(raytracer.binary_hash() ==

diff --git a/src/tests/signalprocessing/datastructures/cwsignalparameters.test.cpp b/src/tests/signalprocessing/datastructures/cwsignalparameters.test.cpp
@@ -47,7 +47,7 @@ TEST_CASE("CWSignalParameters should support common functions", TESTTAG)
     REQUIRE(txs.get_effective_pulse_duration() == Approx(0.00234f));
     REQUIRE(txs.get_tx_signal_type() == t_TxSignalType::CW);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(txs.binary_hash() == 6748335302485371792);
     REQUIRE(txs.binary_hash() == CWSignalParameters(txs).binary_hash());
     REQUIRE(txs.binary_hash() ==

diff --git a/src/tests/signalprocessing/datastructures/fmsignalparameters.test.cpp b/src/tests/signalprocessing/datastructures/fmsignalparameters.test.cpp
@@ -49,7 +49,7 @@ TEST_CASE("FMSignalParameters should support common functions", TESTTAG)
     REQUIRE(txs.get_effective_pulse_duration() == Approx(0.00234));
     REQUIRE(txs.get_tx_signal_type() == t_TxSignalType::FM_UP_SWEEP);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(txs.binary_hash() == 6578226545546968191);
     REQUIRE(txs.binary_hash() == FMSignalParameters(txs).binary_hash());
     REQUIRE(txs.binary_hash() ==

diff --git a/src/tests/signalprocessing/datastructures/genericsignalparameters.test.cpp b/src/tests/signalprocessing/datastructures/genericsignalparameters.test.cpp
@@ -49,7 +49,7 @@ TEST_CASE("GenericSignalParameters should support common functions", TESTTAG)
     REQUIRE(txs.get_effective_pulse_duration() == Approx(0.0023f));
     REQUIRE(txs.get_tx_signal_type() == t_TxSignalType::UNKNOWN);
 
-    // test hash
+    // test hash (should be stable if class is not changed)
     REQUIRE(txs.binary_hash() == 10730480407014384156ULL);
     REQUIRE(txs.binary_hash() == GenericSignalParameters(txs).binary_hash());
     REQUIRE(txs.binary_hash() ==