Add stationary probability for random vehicles movement #376

Grufoony · 2025-12-03T11:15:22Z

No description provided.

src/dsf/mobility/RoadNetwork.cpp

codecov · 2025-12-04T10:02:30Z

Codecov Report

❌ Patch coverage is 80.35714% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.24%. Comparing base (292021f) to head (3055ccd).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/dsf/mobility/RoadNetwork.cpp	0.00%	10 Missing ⚠️
src/dsf/mobility/Street.hpp	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #376      +/-   ##
==========================================
- Coverage   83.27%   83.24%   -0.04%     
==========================================
  Files          53       53              
  Lines        5275     5330      +55     
  Branches      606      608       +2     
==========================================
+ Hits         4393     4437      +44     
- Misses        871      882      +11     
  Partials       11       11

Flag	Coverage Δ
unittests	`83.24% <80.35%> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/dsf/mobility/RoadNetwork.cpp

src/dsf/mobility/RoadNetwork.hpp

test/mobility/Test_dynamics.cpp

+  // Street 0: 0 -> 1
+  // High length to hold all agents, high transport capacity to move them all at once
+  network.addStreet(Street(0,
+                           {0, 1},


test/mobility/Test_dynamics.cpp

+                           static_cast<double>(highCapacity)));
+  // Street 1: 1 -> 2
+  network.addStreet(Street(1,
+                           {1, 2},


test/mobility/Test_dynamics.cpp

+                           static_cast<double>(highCapacity)));
+  // Street 2: 1 -> 3
+  network.addStreet(Street(2,
+                           {1, 3},


test/mobility/Test_dynamics.cpp

+  // Ratio 1:2 -> P(1) = 1/3, P(2) = 2/3
+
+  double ratio =
+      (countStreet1 > 0) ? static_cast<double>(countStreet2) / countStreet1 : 0.0;


Copilot

Pull request overview

This pull request implements stationary weight functionality for streets in the traffic simulation framework, allowing users to bias random agent navigation toward certain streets by assigning different stationary probability weights.

Key Changes

Added m_stationaryWeight member (default 1.0) to the Street class with getter/setter methods
Modified the transition probability calculation in RoadDynamics to incorporate the square root of the weight ratio between current and next streets
Added setStreetStationaryWeights() method to RoadNetwork for bulk setting of street weights
Added Python bindings for the new functionality and exposed the graph() method on FirstOrderDynamics
Included a comprehensive test case demonstrating that agents distribute according to the expected 2:1 ratio when streets have weights of 4.0 and 1.0
Removed commented-out transition probability code that was replaced by this implementation
Declared copy constructor/assignment as deleted and move constructor/assignment as defaulted for RoadNetwork

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
src/dsf/mobility/Street.hpp	Added `m_stationaryWeight` member variable with setter/getter methods; removed old commented transition probability code
src/dsf/mobility/RoadNetwork.hpp	Added `setStreetStationaryWeights()` method declaration; added copy/move semantics declarations
src/dsf/mobility/RoadNetwork.cpp	Implemented `setStreetStationaryWeights()` using parallel execution; removed old commented JSON parsing code for transition probabilities
src/dsf/mobility/RoadDynamics.hpp	Modified probability calculation to include `sqrt(weightRatio)` factor; added `stationaryWeightCurrent` and `stationaryWeightNext` variables
src/dsf/bindings.cpp	Added Python bindings for `setStreetStationaryWeights()` and `graph()` methods
test/mobility/Test_dynamics.cpp	Added new test case validating stationary weight impact on agent distribution with 3000 agents
src/dsf/dsf.hpp	Incremented patch version from 9 to 10

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/dsf/mobility/RoadNetwork.hpp

Copilot · 2025-12-04T10:18:44Z

src/dsf/mobility/Street.hpp

-    // };
+    /// @brief Set the street's stationary weight
+    /// @param weight The street's stationary weight
+    inline void setStationaryWeight(double const weight) { m_stationaryWeight = weight; }


Missing input validation for the weight parameter. Negative or zero weights could lead to incorrect probability calculations or mathematical errors (e.g., when taking square roots in RoadDynamics.hpp line 558). Consider adding validation to ensure weights are positive, or document if non-positive values are intentionally allowed.

Suggested change

inline void setStationaryWeight(double const weight) { m_stationaryWeight = weight; }

inline void setStationaryWeight(double const weight) {

if (weight <= 0.0) {

throw std::invalid_argument("Stationary weight must be positive.");

}

m_stationaryWeight = weight;

}

Copilot · 2025-12-04T10:18:44Z

test/mobility/Test_dynamics.cpp

+  // P(1) ~ speed * speed * sqrt(1/1) = 100
+  // P(2) ~ speed * speed * sqrt(4/1) = 200


The test comment contains an error in the probability calculation. The comment states:

// P(1) ~ speed * speed * sqrt(1/1) = 100 // P(2) ~ speed * speed * sqrt(4/1) = 200

However, based on the actual formula in RoadDynamics.hpp line 558 (probability = speedCurrent * speedNext * std::sqrt(weightRatio)), the calculation should be:

P(1) = speedCurrent (10.0) × speedNext (10.0) × sqrt(1.0/1.0) = 100

P(2) = speedCurrent (10.0) × speedNext (10.0) × sqrt(4.0/1.0) = 200

The formulas are actually correct, but stating "speed * speed" is misleading since it's actually speedCurrent × speedNext (which happen to be the same value in this test). Consider clarifying this as "speedCurrent * speedNext" for accuracy.

Suggested change

// P(1) ~ speed * speed * sqrt(1/1) = 100

// P(2) ~ speed * speed * sqrt(4/1) = 200

// P(1) ~ speedCurrent * speedNext * sqrt(1/1) = 10.0 * 10.0 * 1 = 100

// P(2) ~ speedCurrent * speedNext * sqrt(4/1) = 10.0 * 10.0 * 2 = 200

src/dsf/mobility/RoadNetwork.cpp

Copilot · 2025-12-04T10:18:45Z

test/mobility/Test_dynamics.cpp

+  std::cout << "Agents on Street 1: " << countStreet1 << std::endl;
+  std::cout << "Agents on Street 2: " << countStreet2 << std::endl;
+  std::cout << "Ratio (Street 2 / Street 1): " << ratio << std::endl;
+


Debug output statements (std::cout) should be removed from test code or replaced with proper logging. These print statements were likely used during development and should not remain in production test code as they clutter test output.

Suggested change

std::cout << "Agents on Street 1: " << countStreet1 << std::endl;

std::cout << "Agents on Street 2: " << countStreet2 << std::endl;

std::cout << "Ratio (Street 2 / Street 1): " << ratio << std::endl;

Copilot · 2025-12-04T10:18:45Z

src/dsf/bindings.cpp

+      .def("graph",
+           &dsf::mobility::FirstOrderDynamics::graph,
+           pybind11::return_value_policy::reference_internal,
+           dsf::g_docstrings.at("dsf::Dynamics::graph").c_str())


The Python bindings reference dsf::Dynamics::graph in the docstrings map (line 542), but there's no documentation for a non-const graph() method in the Dynamics class. The base Dynamics class only has a const version (inline const auto& graph() const). This will cause a runtime error when the docstrings are loaded, as the key won't exist in the generated docstrings map. Either:

Add documentation for the non-const graph() method if it exists

Use the correct docstring key if this method has different documentation

Remove the docstring lookup if this is meant to reuse the const version's documentation

Suggested change

dsf::g_docstrings.at("dsf::Dynamics::graph").c_str())

dsf::g_docstrings.at("dsf::Dynamics::graph() const").c_str())

Copilot · 2025-12-04T10:18:45Z

src/dsf/bindings.cpp

+      .def("setStreetStationaryWeights",
+           &dsf::mobility::RoadNetwork::setStreetStationaryWeights,
+           pybind11::arg("weights"),
+           dsf::g_docstrings.at("dsf::mobility::RoadNetwork::setStreetStationaryWeights")
+               .c_str())


The Python bindings reference dsf::mobility::RoadNetwork::setStreetStationaryWeights in the docstrings map (line 178), but this method has no documentation in RoadNetwork.hpp (line 194). This will cause a runtime error when loading the Python module, as the docstrings are generated from Doxygen comments and this key won't exist in the g_docstrings map. Add proper Doxygen documentation for this public API method.

Copilot · 2025-12-04T10:18:46Z

src/dsf/mobility/RoadDynamics.hpp

-      double probability = speedCurrent * speedNext;
+      double const stationaryWeightNext = pStreetOut->stationaryWeight();
+      auto const weightRatio{stationaryWeightNext /
+                             stationaryWeightCurrent};  // SQRT (p_i / p_j)


The comment incorrectly states "SQRT (p_i / p_j)" but the actual calculation uses sqrt(weightRatio) where weightRatio = stationaryWeightNext / stationaryWeightCurrent. This suggests the comment should either say "sqrt(p_next / p_current)" or clarify what p_i and p_j represent in this context. The indices i and j are ambiguous here.

Suggested change

stationaryWeightCurrent}; // SQRT (p_i / p_j)

stationaryWeightCurrent}; // sqrt(p_next / p_current)

src/dsf/mobility/Street.hpp

+    /// @brief Set the street's stationary weight
+    /// @param weight The street's stationary weight
+    inline void setStationaryWeight(double const weight) {
+      weight > 0. ? m_stationaryWeight = weight


Grufoony and others added 2 commits November 28, 2025 11:20

Init

0f74c33

Merge branch 'main' into statprob

838dbdf

github-advanced-security bot found potential problems Dec 3, 2025

View reviewed changes

src/dsf/mobility/RoadNetwork.cpp Fixed Show fixed Hide fixed

Finish implementation

7206ef0

github-advanced-security bot found potential problems Dec 4, 2025

View reviewed changes

src/dsf/mobility/RoadNetwork.cpp Fixed Show fixed Hide fixed

src/dsf/mobility/RoadNetwork.cpp Fixed Show fixed Hide fixed

src/dsf/mobility/RoadNetwork.hpp Fixed Show fixed Hide fixed

src/dsf/mobility/RoadNetwork.hpp Fixed Show fixed Hide fixed

Grufoony added 2 commits December 4, 2025 11:11

Add test

cb3e367

Bump version

0414257

Grufoony requested a review from Copilot December 4, 2025 10:11

Copilot started reviewing on behalf of Grufoony December 4, 2025 10:12 View session

github-advanced-security bot found potential problems Dec 4, 2025

View reviewed changes

Copilot finished reviewing on behalf of Grufoony December 4, 2025 10:17

Copilot AI reviewed Dec 4, 2025

View reviewed changes

Docs

3055ccd

Grufoony force-pushed the statprob branch from 10d8d0b to 3055ccd Compare December 4, 2025 10:23

Grufoony changed the title ~~Statprob~~ Add stationary probability for random vehicles movement Dec 4, 2025

Grufoony marked this pull request as ready for review December 4, 2025 10:24

Grufoony merged commit a102090 into main Dec 4, 2025
26 checks passed

Grufoony deleted the statprob branch December 4, 2025 10:26

github-advanced-security bot found potential problems Dec 4, 2025

View reviewed changes

		// P(1) ~ speed * speed * sqrt(1/1) = 100
		// P(2) ~ speed * speed * sqrt(4/1) = 200

	std::cout << "Agents on Street 1: " << countStreet1 << std::endl;
	std::cout << "Agents on Street 2: " << countStreet2 << std::endl;
	std::cout << "Ratio (Street 2 / Street 1): " << ratio << std::endl;

	dsf::g_docstrings.at("dsf::Dynamics::graph").c_str())
	dsf::g_docstrings.at("dsf::Dynamics::graph() const").c_str())

	stationaryWeightCurrent}; // SQRT (p_i / p_j)
	stationaryWeightCurrent}; // sqrt(p_next / p_current)

Add stationary probability for random vehicles movement #376

Add stationary probability for random vehicles movement #376

Uh oh!

Conversation

Grufoony commented Dec 3, 2025

Uh oh!

Uh oh!

codecov bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Check warning

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Dec 4, 2025 •

edited

Loading