Skip to content

Add utility to kill stagnant agents #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 18, 2025
+61 −51
Merged

Add utility to kill stagnant agents #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57f16ff
Implement `killStagnantAgents`
Grufoony Oct 6, 2025
13497b6
Agent control in add function
Grufoony Oct 6, 2025
10fd7c9
Merge branch 'main' into killAgents
Grufoony Nov 18, 2025
0576558
Bump version
Grufoony Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/dsf/bindings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,11 @@ PYBIND11_MODULE(dsf_cpp, m) {
&dsf::mobility::FirstOrderDynamics::setWeightFunction,
pybind11::arg("weightFunction"),
pybind11::arg("weightThreshold") = std::nullopt)
.def(
"killStagnantAgents",
&dsf::mobility::FirstOrderDynamics::killStagnantAgents,
pybind11::arg("timeToleranceFactor") = 3.,
dsf::g_docstrings.at("dsf::mobility::RoadDynamics::killStagnantAgents").c_str())
.def(
"setDestinationNodes",
[](dsf::mobility::FirstOrderDynamics& self,
Expand Down
2 changes: 1 addition & 1 deletion src/dsf/dsf.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

static constexpr uint8_t DSF_VERSION_MAJOR = 4;
static constexpr uint8_t DSF_VERSION_MINOR = 4;
static constexpr uint8_t DSF_VERSION_PATCH = 1;
static constexpr uint8_t DSF_VERSION_PATCH = 2;

static auto const DSF_VERSION =
std::format("{}.{}.{}", DSF_VERSION_MAJOR, DSF_VERSION_MINOR, DSF_VERSION_PATCH);
Expand Down
105 changes: 55 additions & 50 deletions src/dsf/mobility/RoadDynamics.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
double m_maxTravelDistance;
std::time_t m_maxTravelTime;
double m_weightTreshold;
std::optional<double> m_timeToleranceFactor;
std::optional<delay_t> m_dataUpdatePeriod;
bool m_bCacheEnabled;
bool m_forcePriorities;
Expand Down Expand Up @@ -125,9 +126,16 @@
/// @details The passage probability is the probability of passing through a node
/// It is useful in the case of random agents
void setPassageProbability(double passageProbability);

/// @brief Set the time tolerance factor for killing stagnant agents.
/// An agent will be considered stagnant if it has not moved for timeToleranceFactor * std::ceil(street_length / street_maxSpeed) time units.
/// @param timeToleranceFactor The time tolerance factor
Comment on lines +129 to +131
Copy link

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for this function is incorrect. It says "Set the time tolerance factor" but the function name is killStagnantAgents. The documentation should clarify that this function enables automatic killing of stagnant agents during evolution by setting a time tolerance factor, rather than just "setting" a parameter.

Suggested change
/// @brief Set the time tolerance factor for killing stagnant agents.
/// An agent will be considered stagnant if it has not moved for timeToleranceFactor * std::ceil(street_length / street_maxSpeed) time units.
/// @param timeToleranceFactor The time tolerance factor
/// @brief Enable automatic killing of stagnant agents during evolution by setting a time tolerance factor.
/// After calling this function, agents that have not moved for timeToleranceFactor * std::ceil(street_length / street_maxSpeed) time units
/// will be considered stagnant and will be automatically removed ("killed") from the simulation.
/// @param timeToleranceFactor The time tolerance factor used to determine agent stagnation

Copilot uses AI. Check for mistakes.
/// @throw std::invalid_argument If the time tolerance factor is not positive
void killStagnantAgents(double timeToleranceFactor = 3.);

Check notice

Code scanning / Cppcheck (reported by Codacy)

MISRA 13.4 rule Note

MISRA 13.4 rule

Check notice

Code scanning / Cppcheck (reported by Codacy)

MISRA 17.8 rule Note

MISRA 17.8 rule
/// @brief Set the weight function
/// @param pathWeight The dsf::PathWeight function to use for the pathfinding
/// @param weightThreshold The weight threshold for updating the paths (default is std::nullopt)
void setWeightFunction(PathWeight const pathWeight,
std::optional<double> weigthThreshold = std::nullopt);
std::optional<double> weightThreshold = std::nullopt);
/// @brief Set the force priorities flag
/// @param forcePriorities The flag
/// @details If true, if an agent cannot move to the next street, the whole node is skipped
Expand Down Expand Up @@ -376,6 +384,7 @@
m_passageProbability{std::nullopt},
m_maxTravelDistance{std::numeric_limits<double>::max()},
m_maxTravelTime{std::numeric_limits<std::time_t>::max()},
m_timeToleranceFactor{std::nullopt},
m_bCacheEnabled{useCache},
m_forcePriorities{false} {
this->setWeightFunction(weightFunction, weightTreshold);
Expand Down Expand Up @@ -652,37 +661,31 @@
pAgentTemp->freeTime());
continue;
}
bool overtimed{false};
{

if (m_timeToleranceFactor.has_value()) {

Check notice

Code scanning / Cppcheck (reported by Codacy)

MISRA 14.4 rule Note

MISRA 14.4 rule
auto const timeDiff{this->time_step() - pAgentTemp->freeTime()};
// A minute of delay has never hurt anyone, right?
auto const timeTolerance{
std::max(static_cast<std::time_t>(60),
static_cast<std::time_t>(
3 * std::ceil(pStreet->length() / pStreet->maxSpeed())))};
auto const timeTolerance{m_timeToleranceFactor.value() *
std::ceil(pStreet->length() / pStreet->maxSpeed())};
if (timeDiff > timeTolerance) {
overtimed = true;
spdlog::warn(
"Time {} - {} currently on {} ({} turn - Traffic Light? {}), "
"has been still for more than {} seconds ({} seconds)",
"Time-step {} - {} currently on {} ({} turn - Traffic Light? {}), "
"has been still for more than {} seconds ({} seconds). Killing it.",
this->time_step(),
*pAgentTemp,
*pStreet,
directionToString.at(pStreet->laneMapping().at(queueIndex)),
this->graph().node(pStreet->target())->isTrafficLight(),
timeTolerance,
timeDiff);
// Kill the agent
auto pAgent{pStreet->dequeue(queueIndex)};
continue;
}
}
pAgentTemp->setSpeed(0.);
const auto& destinationNode{this->graph().node(pStreet->target())};
if (destinationNode->isFull()) {
if (overtimed) {
spdlog::warn("Skipping due to full destination node {}", *destinationNode);
} else {
spdlog::debug("Skipping due to space at destination node {}",
*destinationNode);
}
spdlog::debug("Skipping due to full destination node {}", *destinationNode);
continue;
}
if (destinationNode->isTrafficLight()) {
Expand Down Expand Up @@ -792,17 +795,9 @@
}
if (!bCanPass) {
spdlog::debug(
"Skipping agent emission from street {} -> {} due to right of way.",
"Skipping agent emission from street {} -> {} due to right of way",
pStreet->source(),
pStreet->target());
if (overtimed) {
spdlog::warn(
"Skipping agent emission from street {} -> {} due to right of way "
"and overtimed agent {}",
pStreet->source(),
pStreet->target(),
pAgentTemp->id());
}
continue;
}
}
Expand All @@ -817,14 +812,6 @@
"probability",
pStreet->source(),
pStreet->target());
if (overtimed) {
spdlog::warn(
"Skipping agent emission from street {} -> {} due to passage "
"probability and overtimed agent {}",
pStreet->source(),
pStreet->target(),
pAgentTemp->id());
}
continue;
}
}
Expand Down Expand Up @@ -865,21 +852,12 @@
}
auto const& nextStreet{this->graph().edge(pAgentTemp->nextStreetId().value())};
if (nextStreet->isFull()) {
if (overtimed) {
spdlog::warn(
"Skipping agent emission from street {} -> {} due to full "
"next street: {}",
pStreet->source(),
pStreet->target(),
*nextStreet);
} else {
spdlog::debug(
"Skipping agent emission from street {} -> {} due to full "
"next street: {}",
pStreet->source(),
pStreet->target(),
*nextStreet);
}
spdlog::debug(
"Skipping agent emission from street {} -> {} due to full "
"next street: {}",
pStreet->source(),
pStreet->target(),
*nextStreet);
continue;
}
auto pAgent{pStreet->dequeue(queueIndex)};
Expand Down Expand Up @@ -1042,6 +1020,15 @@
}
m_passageProbability = passageProbability;
}
template <typename delay_t>
requires(is_numeric_v<delay_t>)
void RoadDynamics<delay_t>::killStagnantAgents(double timeToleranceFactor) {
if (timeToleranceFactor <= 0.) {
throw std::invalid_argument(std::format(
"The time tolerance factor ({}) must be positive", timeToleranceFactor));
}
m_timeToleranceFactor = timeToleranceFactor;
}
template <typename delay_t>
requires(is_numeric_v<delay_t>)
void RoadDynamics<delay_t>::setWeightFunction(PathWeight const pathWeight,
Expand Down Expand Up @@ -1200,6 +1187,15 @@
requires(is_numeric_v<delay_t>)
void RoadDynamics<delay_t>::addAgentsUniformly(Size nAgents,
std::optional<Id> optItineraryId) {
if (m_timeToleranceFactor.has_value() && !m_agents.empty()) {
auto const nStagnantAgents{m_agents.size()};
spdlog::warn(
"Removing {} stagnant agents that were not inserted since the previous call to "
"addAgentsUniformly().",
nStagnantAgents);
m_agents.clear();
m_nAgents -= nStagnantAgents;
}
if (optItineraryId.has_value() && !this->itineraries().contains(*optItineraryId)) {
throw std::invalid_argument(
std::format("No itineraries available. Cannot add agents with itinerary id {}",
Expand Down Expand Up @@ -1256,6 +1252,15 @@
void RoadDynamics<delay_t>::addAgentsRandomly(Size nAgents,
const TContainer& src_weights,
const TContainer& dst_weights) {
if (m_timeToleranceFactor.has_value() && !m_agents.empty()) {
auto const nStagnantAgents{m_agents.size()};
spdlog::warn(
"Removing {} stagnant agents that were not inserted since the previous call to "
"addAgentsRandomly().",
nStagnantAgents);
m_agents.clear();
m_nAgents -= nStagnantAgents;
}
auto const& nSources{src_weights.size()};
auto const& nDestinations{dst_weights.size()};
spdlog::debug("Init addAgentsRandomly for {} agents from {} nodes to {} nodes.",
Expand Down
Loading