update

Author: fffaraz

DoubleBuffer.hpp

@@ -26,43 +26,43 @@ class DoubleBuffer {
     using read_lock = std::shared_lock<std::shared_mutex>;
     using write_lock = std::unique_lock<WriteMutex>;
 
-    // Returns a const reference to the current read buffer along with a shared read lock.
+    // Return a const reference to the current read buffer along with a shared read lock.
     std::pair<const T&, read_lock> readBuffer() const
     {
         read_lock lock(readMutex_);
         return { buffer_[index_], std::move(lock) };
     }
 
-    // Returns a reference to the current write buffer along with an exclusive write lock.
+    // Return a reference to the current write buffer along with an exclusive write lock.
     std::pair<T&, write_lock> writeBuffer()
     {
         write_lock lock(writeMutex_);
         return { buffer_[1 - index_], std::move(lock) };
     }
 
-    // Clones the current read buffer.
+    // Clone the current read buffer.
     T clone() const
     {
         read_lock lock(readMutex_);
         return buffer_[index_];
     }
 
-    // Sets new data in the write buffer and swaps the buffers.
+    // Set new data in the write buffer and swap the buffers.
     void setAndSwap(T newData)
     {
         write_lock writeLock(writeMutex_);
         buffer_[1 - index_] = std::move(newData);
         swap(std::move(writeLock));
     }
 
-    // Swaps the read and write buffers.
+    // Swap the read and write buffers.
     void swap()
     {
         write_lock writeLock(writeMutex_);
         swap(std::move(writeLock));
     }
 
-    // Swaps the read and write buffers using an existing write lock.
+    // Swap the read and write buffers using an existing write lock.
     void swap(write_lock&& writeLock)
     {
         std::unique_lock<std::shared_mutex> readLock(readMutex_); // Exclusive read lock to prevent reads during the swap.

Grid.hpp

@@ -6,7 +6,7 @@
 #include <array>
 #include <random>
 
-#if 1 // Enable multi-threaded calculation for the grid updates
+#if 1 // Enable multithreaded calculation of grid updates
 #include <numeric>
 #include <poolstl/poolstl.hpp>
 #define PARALLEL_GRID 1
@@ -40,7 +40,7 @@ class alignas(128) Grid {
 #endif
 };
 
-// Function to count the number of live neighbors for a cell at (x, y)
+// Count the number of live neighbors for the cell at (x, y)
 template <int SIZE>
 int Grid<SIZE>::countLiveNeighbors(const Point& p) const
 {
@@ -72,7 +72,7 @@ int Grid<SIZE>::countLiveNeighbors(const Point& p) const
     return liveNeighbors;
 }
 
-// Function to toggle a 3x3 block of cells at the given position
+// Toggle a 3x3 block of cells at the given position
 template <int SIZE>
 void Grid<SIZE>::toggleBlock(const Point& p)
 {
@@ -87,7 +87,7 @@ void Grid<SIZE>::toggleBlock(const Point& p)
     }
 }
 
-// Function to apply the rules of Conway's Game of Life
+// Apply the rules of Conway's Game of Life
 static inline bool gameOfLife(const bool cell, const int liveNeighbors)
 {
     // A cell is alive in the next generation if it has 3 neighbors,
@@ -105,7 +105,7 @@ void Grid<SIZE>::updateP(const Grid<SIZE>& current, const Point& p)
 
 #ifndef PARALLEL_GRID
 
-// Function to update the grid based on the rules of Conway's Game of Life
+// Update the grid based on the rules of Conway's Game of Life
 template <int SIZE>
 void Grid<SIZE>::updateGrid(const Grid<SIZE>& current)
 {
@@ -138,7 +138,7 @@ void Grid<SIZE>::updateGrid(const Grid<SIZE>& current)
 static std::mt19937 generator(0);
 static std::uniform_int_distribution<int> distribution(0, 2'000'000'000);
 
-// Function to add random noise to the grid
+// Add random noise to the grid
 template <int SIZE>
 void Grid<SIZE>::addNoise(int n)
 {
@@ -149,7 +149,7 @@ void Grid<SIZE>::addNoise(int n)
     }
 }
 
-// Function to clear the grid
+// Clear the grid
 template <int SIZE>
 void Grid<SIZE>::clear()
 {

main-sfml.cpp

@@ -12,10 +12,10 @@
 std::atomic_bool mouseRightPressed = false;
 std::atomic_bool mouseLeftPressed = false;
 
-// Update the next grid
+// Update the next grid state
 static void updateGrid(const sf::RenderWindow& window)
 {
-    // Get the next grid to write to
+    // Get the writable next grid
     auto [nextGrid, writeLock] = grid.writeBuffer();
 
     // Handle right mouse button click
@@ -31,7 +31,7 @@ static void updateGrid(const sf::RenderWindow& window)
         nextGrid.updateGrid(currGrid);
     }
 
-    // Add some noise to the grid
+    // Add random noise to the grid
     nextGrid.addNoise();
 
     // Handle mouse movement while the left button is pressed
@@ -40,15 +40,15 @@ static void updateGrid(const sf::RenderWindow& window)
         const int x = mousePos.x / CELL_SIZE;
         const int y = mousePos.y / CELL_SIZE;
         if (x >= 0 && x < GRID_SIZE && y >= 0 && y < GRID_SIZE) {
-            nextGrid.toggleBlock({ x, y }); // Turn on a 3x3 block
+            nextGrid.toggleBlock({ x, y }); // Toggle a 3x3 block
         }
     }
 
     // Swap the buffers
     grid.swap(std::move(writeLock));
 }
 
-// Color map for cells based on number of live neighbors
+// Color map for cells based on the number of live neighbors
 static const std::array<sf::Color, 9> colorMap {
     sf::Color::Red, // 0 live neighbors
     sf::Color::Green, // 1 live neighbor
@@ -64,7 +64,7 @@ static const std::array<sf::Color, 9> colorMap {
 // Function to update the vertex array
 int updateVertices(sf::RenderWindow& window, sf::VertexArray& vertices)
 {
-    int numAlive = 0; // Count the number of alive cells
+    int numAlive = 0; // Count of alive cells
     auto [currGrid, lock] = grid.readBuffer();
     for (int i = 0; i < GRID_SIZE; ++i) {
         for (int j = 0; j < GRID_SIZE; ++j) {
@@ -134,7 +134,7 @@ int main()
         }
     }
 
-    // Text to display the number of alive cells
+    // Load font for displaying text
     sf::Font font;
     const std::vector<std::string> fontPaths {
 #ifdef _WIN32