The namespace of DynG. More...

Data Structures
class	CorridorGravWriter
	Writes the Grav with the corridor and active graph highlighted. More...

class	DyngError
	A logical error in the use of the dynamic network occurred. More...

class	FlowGravWriter
	Grav writer for fractional flows. More...

class	GravWriter
	Base class for writing to Grav files. More...

class	Net
	A dynamic time expanded network. More...

class	PathGravWriter
	Writes a path. More...

Typedefs
typedef int	index_type
	Type of indices.

Enumerations
enum	Attribute : int { COST = 0, BASECOST = 1, AUGCOST = 2, FLOW = 3, NODE = 4, TIME = 5 }
	Attribute for building node/arc descriptions. More...

Functions
void	write_basegraph_tikz (const Net &net, bool withdoc, std::ostream &out)
	Write base graph in Tikz format. More...

void	write_basegraph_grav (const Net &net, const std::string &name, std::ostream &out)
	Write base graph in grav format. More...

void	write_rgraph (const Net &net, std::ostream &out)
	Write time expansion in rgraph format. More...

void	write_corridor_grav (std::ostream &out, const Net &net, const std::string &name, bool addgraph=false)
	Write time expansion in grav format. More...

void	write_grav (const Net &net, const std::string &name, const std::vector< index_type > &path, std::ostream &out)
	Write time expansion in grav format with some highlighted path. More...

void	write_grav (const Net &net, const std::string &name, const std::vector< double > &basecosts, const std::vector< double > &augcosts, const std::vector< index_type > &path, std::ostream &out)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path. More...

void	write_grav (const Net &net, const std::string &name, int(getattr)(Attribute attr, index_type id, void value), const std::vector< index_type > &path, std::ostream &out)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path. More...

void	write_grav (const Net &net, const std::string &name, const std::vector< const char > &nodedesc, const std::vector< const char > &arcdesc, const std::vector< index_type > &path, std::ostream &out)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path. More...

void	write_grav (const Net &net, const std::string &name, const std::vector< double > &basecosts, const std::vector< double > &augcosts, const std::vector< const char > &nodedesc, const std::vector< const char > &arcdesc, const std::vector< index_type > &path, std::ostream &out)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path. More...

void	write_flow_grav (std::ostream &out, const Net &net, const std::string &name, const std::vector< double > &basecosts, const std::vector< double > &augcosts, const std::vector< const char > &nodedesc, const std::vector< const char > &arcdesc, const std::vector< double > &flow, bool append=false)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some colorized flow. More...

Detailed Description

The namespace of DynG.

Enumeration Type Documentation

◆ Attribute

enum Dyng::Attribute : int

Attribute for building node/arc descriptions.

Enumerator
COST	cost of an arc, double
BASECOST	base cost of an arc, double
AUGCOST	augmented cost of an arc, double
FLOW	flow of an arc, double
NODE	node description, c string of size 80
TIME	time description, c string of size 80

Function Documentation

◆ write_basegraph_grav()

void Dyng::write_basegraph_grav	(	const Net &	net,
		const std::string &	name,
		std::ostream &	out
	)

Write base graph in grav format.

Parameters

net	The dynamic network.
name	The name of the network.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_basegraph_tikz()

void Dyng::write_basegraph_tikz	(	const Net &	net,
		bool	withdoc,
		std::ostream &	out
	)

Write base graph in Tikz format.

Parameters

net	The dynamic network.
withdoc	If true generate document framework code.
out	The output stream to write to.

◆ write_corridor_grav()

void Dyng::write_corridor_grav	(	std::ostream &	out,
		const Net &	net,
		const std::string &	name,
		bool	addgraph = `false`
	)

Write time expansion in grav format.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written.

Parameters

out	The output stream to write to.
net	The dynamic network.
name	The name of the network.
addgraph	If true generate 'addgraph' instead of 'newgraph' commands.

Exceptions

DyngError if time expansion is not initialized

◆ write_flow_grav()

void Dyng::write_flow_grav	(	std::ostream &	out,
		const Net &	net,
		const std::string &	name,
		const std::vector< double > &	basecosts,
		const std::vector< double > &	augcosts,
		const std::vector< const char *> &	nodedesc,
		const std::vector< const char *> &	arcdesc,
		const std::vector< double > &	flow,
		bool	append = `false`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some colorized flow.

Parameters

out	The output stream to write to.
net	The dynamic network.
name	The name of the network.
basecosts	The base costs.
augcosts	The augmented costs.
nodedesc	The node descriptions.
arcdesc	The arc descriptions.
append	If true generate `addgraph` instead of `newgraph` commands.
flow	The arc flows.

Exceptions

DyngError if time expansion is not initialized

◆ write_grav() [1/5]

void Dyng::write_grav	(	const Net &	net,
		const std::string &	name,
		const std::vector< index_type > &	path,
		std::ostream &	out
	)

Write time expansion in grav format with some highlighted path.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written.

Parameters

net	The dynamic network.
name	The name of the network.
path	The path (arcs) to be highlighted.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_grav() [2/5]

void Dyng::write_grav	(	const Net &	net,
		const std::string &	name,
		const std::vector< double > &	basecosts,
		const std::vector< double > &	augcosts,
		const std::vector< index_type > &	path,
		std::ostream &	out
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written. This functions accepts additional cost vectors to be used in the arc description.

Parameters

net	The dynamic network.
name	The name of the network.
path	The path (arcs) to be highlighted.
basecosts	The base costs.
augcosts	The augmented costs.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_grav() [3/5]

void Dyng::write_grav	(	const Net &	net,
		const std::string &	name,
		int()(Attribute attr, index_type id, void value)	getattr,
		const std::vector< index_type > &	path,
		std::ostream &	out
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written.

Parameters

net	The dynamic network.
name	The name of the network.
getattr	Attribute getter function.
path	The path (arcs) to be highlighted.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_grav() [4/5]

void Dyng::write_grav	(	const Net &	net,
		const std::string &	name,
		const std::vector< const char *> &	nodedesc,
		const std::vector< const char *> &	arcdesc,
		const std::vector< index_type > &	path,
		std::ostream &	out
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written.

Parameters

net	The dynamic network.
name	The name of the network.
nodedesc	The node descriptions.
arcdesc	The arc descriptions.
path	The path (arcs) to be highlighted.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_grav() [5/5]

void Dyng::write_grav	(	const Net &	net,
		const std::string &	name,
		const std::vector< double > &	basecosts,
		const std::vector< double > &	augcosts,
		const std::vector< const char *> &	nodedesc,
		const std::vector< const char *> &	arcdesc,
		const std::vector< index_type > &	path,
		std::ostream &	out
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Write time expansion in grav format with some highlighted path.

The graph will generate a newgraph command, i.e. all nodes and arcs will be written.

Parameters

net	The dynamic network.
name	The name of the network.
basecosts	The base costs.
augcosts	The augmented costs.
nodedesc	The node descriptions.
arcdesc	The arc descriptions.
path	The path (arcs) to be highlighted.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

◆ write_rgraph()

void Dyng::write_rgraph	(	const Net &	net,
		std::ostream &	out
	)

Write time expansion in rgraph format.

Parameters

net	The dynamic network.
out	The output stream to write to.

Exceptions

DyngError if time expansion is not initialized

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ Attribute

Function Documentation

◆ write_basegraph_grav()

◆ write_basegraph_tikz()

◆ write_corridor_grav()

◆ write_flow_grav()

◆ write_grav() [1/5]

◆ write_grav() [2/5]

◆ write_grav() [3/5]

◆ write_grav() [4/5]

◆ write_grav() [5/5]

◆ write_rgraph()