The RoadNetwork class represents a graph in the network. More...

#include <RoadNetwork.hpp>

Inheritance diagram for dsf::RoadNetwork:

Public Member Functions
	RoadNetwork (AdjacencyMatrix const &adj)
	Construct a new RoadNetwork object.

	RoadNetwork (const std::unordered_map< Id, std::unique_ptr< Street > > &streetSet)
	Construct a new RoadNetwork object.

void	buildAdj ()
	Build the graph's adjacency matrix and computes max capacity.

void	adjustNodeCapacities ()
	Adjust the nodes' transport capacity.

void	initTrafficLights (Delay const minGreenTime=30)
	Initialize the traffic lights with random parameters.

void	autoMapStreetLanes ()
	Automatically re-maps street lanes basing on network's topology.

void	importMatrix (const std::string &fileName, bool isAdj=true, double defaultSpeed=13.8888888889)
	Import the graph's adjacency matrix from a file. If the file is not of a supported format, it will read the file as a matrix with the first two elements being the number of rows and columns and the following elements being the matrix elements.

void	importCoordinates (const std::string &fileName)
	Import the graph's nodes from a file.

void	importOSMNodes (const std::string &fileName)
	Import the graph's nodes from a file.

void	importOSMEdges (const std::string &fileName)
	Import the graph's streets from a file.

void	importTrafficLights (const std::string &fileName)
	Import the graph's traffic lights from a file.

void	exportNodes (const std::string &fileName, bool const useExternalIds=false)
	Export the graph's nodes to a csv-like file separated with ';'.

void	exportEdges (const std::string &fileName, bool const useExternalIds=false)
	Export the graph's edges to a csv-like file separated with ';'.

void	exportMatrix (std::string path="./matrix.dsm", bool isAdj=true)
	Export the graph's adjacency matrix to a file.

template<typename T1, typename... Tn> requires is_node_v<std::remove_reference_t<T1>> && (is_node_v<std::remove_reference_t<Tn>> && ...)
void	addNodes (T1 &&node, Tn &&... nodes)

TrafficLight &	makeTrafficLight (Id const nodeId, Delay const cycleTime, Delay const counter=0)
	Convert an existing node to a traffic light.

Roundabout &	makeRoundabout (Id nodeId)
	Convert an existing node into a roundabout.

void	makeStochasticStreet (Id streetId, double const flowRate)

void	makeSpireStreet (Id streetId)
	Convert an existing street into a spire street.

Station &	makeStation (Id nodeId, const unsigned int managementTime)
	Convert an existing node into a station.

void	addStreet (Street &&street)
	Add a street to the graph.

template<typename T1> requires is_street_v<std::remove_reference_t<T1>>
void	addStreets (T1 &&street)

template<typename T1, typename... Tn> requires is_street_v<std::remove_reference_t<T1>> && (is_street_v<std::remove_reference_t<Tn>> && ...)
void	addStreets (T1 &&street, Tn &&... streets)

const std::unique_ptr< Street > *	street (Id source, Id destination) const
	Get a street from the graph.

const std::unique_ptr< Street > *	oppositeStreet (Id streetId) const
	Get the opposite street of a street in the graph.

unsigned long long	maxCapacity () const noexcept
	Get the maximum agent capacity.

std::unordered_map< std::string, Id > const &	nodeMapping () const noexcept
	Get the node mapping.

std::vector< Id > const &	originNodes () const noexcept
	Get the origin nodes of the graph.

std::vector< Id > &	originNodes () noexcept
	Get the origin nodes of the graph.

std::vector< Id > const &	destinationNodes () const noexcept
	Get the destination nodes of the graph.

std::vector< Id > &	destinationNodes () noexcept
	Get the destination nodes of the graph.

template<typename Func = std::function<double(const RoadNetwork, Id, Id)>> requires ( std::is_same_v<std::invoke_result_t<Func, const RoadNetwork, Id, Id>, double>)
std::optional< DijkstraResult >	shortestPath (const Node &source, const Node &destination, Func f=weight_functions::streetLength) const
	Get the shortest path between two nodes using dijkstra algorithm.

template<typename Func = std::function<double(const RoadNetwork, Id, Id)>> requires ( std::is_same_v<std::invoke_result_t<Func, const RoadNetwork, Id, Id>, double>)
std::optional< DijkstraResult >	shortestPath (Id source, Id destination, Func f=weight_functions::streetLength) const
	Get the shortest path between two nodes using dijkstra algorithm.

Public Member Functions inherited from dsf::Network< RoadJunction, Street >
	Network (AdjacencyMatrix const &adj)
	Construct a new Network object.

AdjacencyMatrix const &	adjacencyMatrix () const
	Get the adjacency matrix.

std::unordered_map< Id, std::unique_ptr< RoadJunction > > const &	nodes () const
	Get the nodes as an unordered map.

std::unordered_map< Id, std::unique_ptr< Street > > const &	edges () const
	Get the edges as an unordered map.

size_t	nNodes () const
	Get the number of nodes.

size_t	nEdges () const
	Get the number of edges.

void	addNode (Id nodeId, TArgs &&... args)
	Add a node to the network.

void	addEdge (TEdge &&edge)

void	addEdge (Id edgeId, TArgs &&... args)
	Add an edge to the network.

std::unique_ptr< RoadJunction > const &	node (Id nodeId) const
	Get a node by id.

TNode &	node (Id nodeId)
	Get a node by id.

std::unique_ptr< Street > const &	edge (Id edgeId) const
	Get an edge by id.

TEdge &	edge (Id edgeId)
	Get an edge by id.

Additional Inherited Members
Protected Attributes inherited from dsf::Network< RoadJunction, Street >
AdjacencyMatrix	m_adjacencyMatrix

std::unordered_map< Id, std::unique_ptr< RoadJunction > >	m_nodes

std::unordered_map< Id, std::unique_ptr< Street > >	m_edges

Detailed Description

The RoadNetwork class represents a graph in the network.

Template Parameters

Id,The	type of the graph's id. It must be an unsigned integral type.
Size,The	type of the graph's capacity. It must be an unsigned integral type.

Constructor & Destructor Documentation

◆ RoadNetwork() [1/2]

dsf::RoadNetwork::RoadNetwork ( AdjacencyMatrix const & adj )

Construct a new RoadNetwork object.

Parameters

adj	An adjacency matrix made by a SparseMatrix representing the graph's adjacency matrix

◆ RoadNetwork() [2/2]

dsf::RoadNetwork::RoadNetwork ( const std::unordered_map< Id, std::unique_ptr< Street > > & streetSet )

Construct a new RoadNetwork object.

Parameters

streetSet A map of streets representing the graph's streets

Member Function Documentation

◆ addStreet()

void dsf::RoadNetwork::addStreet ( Street && street )

Add a street to the graph.

Parameters

street A reference to the street to add

◆ adjustNodeCapacities()

void dsf::RoadNetwork::adjustNodeCapacities ( )

Adjust the nodes' transport capacity.

The nodes' capacity is adjusted using the graph's streets transport capacity, which may vary basing on the number of lanes. The node capacity will be set to the sum of the incoming streets' transport capacity.

◆ autoMapStreetLanes()

void dsf::RoadNetwork::autoMapStreetLanes ( )

Automatically re-maps street lanes basing on network's topology.

For example, if one street has the right turn forbidden, then the right lane becomes a straight one

◆ buildAdj()

void dsf::RoadNetwork::buildAdj ( )

Build the graph's adjacency matrix and computes max capacity.

The adjacency matrix is built using the graph's streets and nodes. N.B.: The street ids are reassigned using the max node id, i.e. newStreetId = srcId * n + dstId, where n is the max node id. Moreover, street angles and geometries are set using the nodes' coordinates.

◆ destinationNodes() [1/2]

std::vector< Id > const & dsf::RoadNetwork::destinationNodes ( ) const

inlinenoexcept

Get the destination nodes of the graph.

Returns: std::vector<Id> const& The destination nodes of the graph

◆ destinationNodes() [2/2]

std::vector< Id > & dsf::RoadNetwork::destinationNodes ( )

inlinenoexcept

Get the destination nodes of the graph.

Returns: std::vector<Id>& The destination nodes of the graph

◆ exportEdges()

void dsf::RoadNetwork::exportEdges	(	const std::string &	fileName,
		bool const	useExternalIds = false )

Export the graph's edges to a csv-like file separated with ';'.

Parameters

path	The path to the file to export the edges to

The file format is csv-like, with the first line being the column names: id;source_id;target_id;name;geometry

◆ exportMatrix()

void dsf::RoadNetwork::exportMatrix	(	std::string	path = "./matrix.dsm",
		bool	isAdj = true )

Export the graph's adjacency matrix to a file.

Parameters

path	The path to the file to export the adjacency matrix to (default: ./matrix.dsm)
isAdj	A boolean value indicating if the file contains the adjacency matrix or the distance matrix.

Exceptions

std::invalid_argument if the file is not found or invalid

◆ exportNodes()

void dsf::RoadNetwork::exportNodes	(	const std::string &	fileName,
		bool const	useExternalIds = false )

Export the graph's nodes to a csv-like file separated with ';'.

Parameters

path	The path to the file to export the nodes to

The file format is csv-like, with the first line being the column names: id;lon;lat

◆ importCoordinates()

void dsf::RoadNetwork::importCoordinates ( const std::string & fileName )

Import the graph's nodes from a file.

Parameters

fileName The name of the file to import the nodes from.

Exceptions

std::invalid_argument if the file is not found, invalid or the format is not supported

The file format is deduced from the file extension. Currently only .dsm files are supported. The first input number is the number of nodes, followed by the coordinates of each node. In the i-th row of the file, the (i - 1)-th node's coordinates are expected.

◆ importMatrix()

void dsf::RoadNetwork::importMatrix	(	const std::string &	fileName,
		bool	isAdj = true,
		double	defaultSpeed = 13.8888888889 )

Import the graph's adjacency matrix from a file. If the file is not of a supported format, it will read the file as a matrix with the first two elements being the number of rows and columns and the following elements being the matrix elements.

Parameters

fileName	The name of the file to import the adjacency matrix from.
isAdj	A boolean value indicating if the file contains the adjacency matrix or the distance matrix.
defaultSpeed	The default speed limit for the streets

Exceptions

std::invalid_argument if the file is not found or invalid The matrix format is deduced from the file extension. Currently only .dsm files are supported.

◆ importOSMEdges()

void dsf::RoadNetwork::importOSMEdges ( const std::string & fileName )

Import the graph's streets from a file.

Parameters

fileName The name of the file to import the streets from.

The file format is csv-like with the ';' separator. Supported columns (in order):

id: The id of the street
sourceId: The id of the source node
targetId: The id of the target node
length: The length of the street, in meters
highway: The type of the street (e.g. residential, primary, secondary, etc.)
lanes: The number of lanes of the street
maxspeed: The street's speed limit, in km/h
name: The name of the street
geometry: The geometry of the street, as a LINESTRING

Next columns are optional (meaning that their absence will not -hopefully- cause any pain):
forbiddenTurns: The forbidden turns of the street, encoding information about street into which the street cannot output agents. The format is a string "sourceId1-targetid1, sourceId2-targetid2,..."
coilcode: An integer code to identify the coil located on the street
customWeight: will be stored in the weight parameter of the Edge class. You can use it for the shortest path via dsf::weight_functions::customWeight.

◆ importOSMNodes()

void dsf::RoadNetwork::importOSMNodes ( const std::string & fileName )

Import the graph's nodes from a file.

Parameters

fileName The name of the file to import the nodes from.

Exceptions

std::invalid_argument if the file is not found, invalid or the format is not supported

The file format is csv-like with the ';' separator. Supported columns (in order):

id: The id of the node
lon: The x coordinate of the node
lat: The y coordinate of the node
type: The type of the node The node type can be one of the following:
traffic_signals: intersection + traffic light
roundabout
origin/destination: intesection counted as origin, destination or both. To have both, the string must contain both the strings "origin" and "destination".

◆ importTrafficLights()

void dsf::RoadNetwork::importTrafficLights ( const std::string & fileName )

Import the graph's traffic lights from a file.

Parameters

fileName The name of the file to import the traffic lights from.

The file format is csv-like with the ';' separator. Supported columns (in order):

id: The id of the TrafficLight node
sourceId: The id of the source node of the incoming street
cycleTime: The traffic light's cycle time, in seconds
greenTime: The green time of the considered phase, in time-steps
Exceptions

std::invalid_argument if the file is not found, invalid or the format is not supported

The traffic lights are imported from the specified file. If the file does not provide sufficient parameters, the behavior of the traffic light initialization is undefined. Ensure the file contains valid and complete data for accurate traffic light configuration. Street priorities may be assigned based on additional parameters such as the number of lanes and the speed limit, if such data is available in the file.

◆ initTrafficLights()

void dsf::RoadNetwork::initTrafficLights ( Delay const minGreenTime = 30 )

Initialize the traffic lights with random parameters.

Parameters

minGreenTime The minimum green time for the traffic lights cycles (default is 30)

Traffic Lights with no parameters set are initialized with random parameters. Street priorities are assigned considering the number of lanes and the speed limit. Traffic Lights with an input degree lower than 3 are converted to standard intersections.

◆ makeRoundabout()

Roundabout & dsf::RoadNetwork::makeRoundabout ( Id nodeId )

Convert an existing node into a roundabout.

Parameters

nodeId The id of the node to convert to a roundabout

Returns: A reference to the roundabout

Exceptions

std::invalid_argument if the node does not exist

◆ makeSpireStreet()

void dsf::RoadNetwork::makeSpireStreet ( Id streetId )

Convert an existing street into a spire street.

Parameters

streetId The id of the street to convert to a spire street

Exceptions

std::invalid_argument if the street does not exist

◆ makeStation()

Station & dsf::RoadNetwork::makeStation	(	Id	nodeId,
		const unsigned int	managementTime )

Convert an existing node into a station.

Parameters

nodeId	The id of the node to convert to a station
managementTime	The station's management time

Returns: A reference to the station

Exceptions

std::invalid_argument if the node does not exist

◆ makeTrafficLight()

TrafficLight & dsf::RoadNetwork::makeTrafficLight	(	Id const	nodeId,
		Delay const	cycleTime,
		Delay const	counter = 0 )

Convert an existing node to a traffic light.

Parameters

nodeId	The id of the node to convert to a traffic light
cycleTime	The traffic light's cycle time
counter	The traffic light's counter initial value. Default is 0

Returns: A reference to the traffic light

Exceptions

std::invalid_argument if the node does not exist

◆ maxCapacity()

unsigned long long dsf::RoadNetwork::maxCapacity ( ) const

inlinenoexcept

Get the maximum agent capacity.

Returns: unsigned long long The maximum agent capacity of the graph

◆ nodeMapping()

std::unordered_map< std::string, Id > const & dsf::RoadNetwork::nodeMapping ( ) const

inlinenoexcept

Get the node mapping.

Returns: std::unordered_map<std::string, Id> const& The node mapping

◆ oppositeStreet()

const std::unique_ptr< Street > * dsf::RoadNetwork::oppositeStreet ( Id streetId ) const

Get the opposite street of a street in the graph.

Parameters

streetId The id of the street

Exceptions

std::invalid_argument if the street does not exist

Returns: A std::unique_ptr to the street if it exists, nullptr otherwise

◆ originNodes() [1/2]

std::vector< Id > const & dsf::RoadNetwork::originNodes ( ) const

inlinenoexcept

Get the origin nodes of the graph.

Returns: std::vector<Id> const& The origin nodes of the graph

◆ originNodes() [2/2]

std::vector< Id > & dsf::RoadNetwork::originNodes ( )

inlinenoexcept

Get the origin nodes of the graph.

Returns: std::vector<Id>& The origin nodes of the graph

◆ shortestPath() [1/2]

template<typename Func>
requires ( std::is_same_v<std::invoke_result_t<Func, const RoadNetwork*, Id, Id>, double>)

std::optional< DijkstraResult > dsf::RoadNetwork::shortestPath	(	const Node &	source,
		const Node &	destination,
		Func	f = weight_functions::streetLength ) const

Get the shortest path between two nodes using dijkstra algorithm.

Parameters

source	The source node
destination	The destination node

Returns: A DijkstraResult object containing the path and the distance

◆ shortestPath() [2/2]

template<typename Func>
requires ( std::is_same_v<std::invoke_result_t<Func, const RoadNetwork*, Id, Id>, double>)

std::optional< DijkstraResult > dsf::RoadNetwork::shortestPath	(	Id	source,
		Id	destination,
		Func	f = weight_functions::streetLength ) const

Get the shortest path between two nodes using dijkstra algorithm.

Parameters

source	The source node id
destination	The destination node id

Returns: A DijkstraResult object containing the path and the distance

◆ street()

const std::unique_ptr< Street > * dsf::RoadNetwork::street	(	Id	source,
		Id	destination ) const

Get a street from the graph.

Parameters

source	The source node
destination	The destination node

Returns: A std::unique_ptr to the street if it exists, nullptr otherwise

The documentation for this class was generated from the following file:

src/dsf/headers/RoadNetwork.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RoadNetwork() [1/2]

◆ RoadNetwork() [2/2]

Member Function Documentation

◆ addStreet()

◆ adjustNodeCapacities()

◆ autoMapStreetLanes()

◆ buildAdj()

◆ destinationNodes() [1/2]

◆ destinationNodes() [2/2]

◆ exportEdges()

◆ exportMatrix()

◆ exportNodes()

◆ importCoordinates()

◆ importMatrix()

◆ importOSMEdges()

◆ importOSMNodes()

◆ importTrafficLights()

◆ initTrafficLights()

◆ makeRoundabout()

◆ makeSpireStreet()

◆ makeStation()

◆ makeTrafficLight()

◆ maxCapacity()

◆ nodeMapping()

◆ oppositeStreet()

◆ originNodes() [1/2]

◆ originNodes() [2/2]

◆ shortestPath() [1/2]

◆ shortestPath() [2/2]

◆ street()