Minor updates to comments, tests, and naming (#249)

* Minor updates to comments, tests, and naming

- Fix documentation in core.h (rgl_node_t)
- Ensure non-zero field values in testPointCloud == operator
- Rename test from '...should_warn...' to '...should_work...' for accuracy

* Review fixes

Co-authored-by: Piotr Rybicki <[email protected]>

---------

Co-authored-by: Piotr Rybicki <[email protected]>

Author: nebraszka

include/rgl/api/core.h

@@ -109,7 +109,9 @@ typedef struct Entity* rgl_entity_t;
 typedef struct Texture* rgl_texture_t;
 
 /**
- * TODO(prybicki)
+ * Opaque handle for a computational graph node in RGL.
+ * Represents a single computational step, e.g. introducing gaussian noise, raytracing or downsampling.
+ * Nodes form a directed acyclic graph, dictating execution order.
  */
 typedef struct Node* rgl_node_t;
 

test/include/helpers/testPointCloud.hpp

@@ -8,6 +8,7 @@
 
 #include <RGLFields.hpp>
 #include <math/Mat3x4f.hpp>
+#include <Logger.hpp>
 
 inline std::vector<rgl_field_t>& getAllRealFieldsVector()
 {
@@ -188,7 +189,32 @@ class TestPointCloud
 
 	bool operator==(const TestPointCloud& other) const
 	{
-		return getPointCount() == other.getPointCount() && fields == other.fields && data == other.data;
+		if (getPointCount() != other.getPointCount() || fields != other.fields || data != other.data) {
+			return false;
+		}
+
+		// If all values for a field (which is not a padding) are equal to zero then warn about this
+		for (size_t fieldIndex = 0; fieldIndex < fields.size(); ++fieldIndex) {
+			const auto& field = fields[fieldIndex];
+
+			if (isDummy(field)) {
+				continue;
+			}
+
+			int fieldOffset = offsets.at(fieldIndex);
+			bool allZeros = true;
+			for (int i = 0; i < getPointCount(); ++i) {
+				if (std::memcmp(data.data() + i * getPointByteSize() + fieldOffset, std::vector<char>(getFieldSize(field), 0).data(),
+				                getFieldSize(field)) != 0) {
+					allZeros = false;
+					break;
+				}
+			}
+			if (allZeros) {
+				RGL_WARN(fmt::format("TestPointCloud::operator==: all field values are 0.0 for field {}", toString(field)));
+			}
+		}
+		return true;
 	}
 
 	template<rgl_field_t T>

test/src/graph/nodes/CompactByFieldPointsNodeTest.cpp

@@ -41,7 +41,8 @@ class CompactByFieldPointsNodeTest : public RGLTestWithParam<int>
 	}
 };
 
-INSTANTIATE_TEST_SUITE_P(CompactByFieldPointsNodeTest, CompactByFieldPointsNodeTest, testing::Values(1, 100, maxGPUCoresTestCount),
+INSTANTIATE_TEST_SUITE_P(CompactByFieldPointsNodeTest, CompactByFieldPointsNodeTest,
+                         testing::Values(1, 100, maxGPUCoresTestCount),
                          [](const auto& info) { return "pointsCount_" + std::to_string(info.param); });
 
 TEST_F(CompactByFieldPointsNodeTest, invalid_argument_node)
@@ -90,15 +91,16 @@ TEST_P(CompactByFieldPointsNodeTest, points_all_non_hit)
 
 	runGraphWithAssertions(inNode);
 
-	auto&& outPointCloud = std::make_unique<TestPointCloud>(TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
+	auto&& outPointCloud = std::make_unique<TestPointCloud>(
+	    TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
 	EXPECT_EQ(outPointCloud->getPointCount(), 0);
 
 	// Check if the contents of outData have changed (they should not have)
 	std::vector<::Field<XYZ_VEC3_F32>::type> outData{
 	    { 2.0f,  3.0f,  5.0f},
-	    { 7.0f, 11.0f, 13.0f},
-	    {17.0f, 19.0f, 23.0f}
-	};
+        { 7.0f, 11.0f, 13.0f},
+        {17.0f, 19.0f, 23.0f}
+    };
 	auto outDataCopy = outData;
 
 	int32_t outCount, outSize;
@@ -124,7 +126,8 @@ TEST_P(CompactByFieldPointsNodeTest, points_all_hit)
 
 	runGraphWithAssertions(inNode);
 
-	auto&& outPointCloud = std::make_unique<TestPointCloud>(TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
+	auto&& outPointCloud = std::make_unique<TestPointCloud>(
+	    TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
 
 	EXPECT_EQ(*outPointCloud, *inPointCloud);
 }
@@ -140,7 +143,8 @@ TEST_P(CompactByFieldPointsNodeTest, points_random_hit)
 	auto&& inPointCloudWithoutNonHits = inPointCloud;
 	inPointCloudWithoutNonHits->removeNonHitPoints();
 
-	auto&& outPointCloud = std::make_unique<TestPointCloud>(TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
+	auto&& outPointCloud = std::make_unique<TestPointCloud>(
+	    TestPointCloud::createFromNode(compactByFieldPointsNode, pointFields));
 
 	EXPECT_EQ(*outPointCloud, *inPointCloudWithoutNonHits);
 }
@@ -172,7 +176,7 @@ TEST_P(CompactByFieldPointsNodeTest, multiple_compactions_applied_to_same_data)
 	EXPECT_EQ(*outPointCloud, *inPointCloudWithoutNonHits);
 }
 
-TEST_F(CompactByFieldPointsNodeTest, should_warn_when_empty_point_cloud)
+TEST_F(CompactByFieldPointsNodeTest, should_work_when_empty_point_cloud)
 {
 	rgl_node_t emptyPointCloudOutputNode = nullptr;
 	createOrUpdateNode<EmptyNode>(&emptyPointCloudOutputNode);