pygrenade_vx.common.Topology

class pygrenade_vx.common.Topology

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)

Overloaded function.

__init__(self: pygrenade_common.Topology, arg0: pygrenade_common.Topology) -> None
__init__(self: pygrenade_common.Topology) -> None

Methods

`__init__`(args, *kwargs)	Overloaded function.
`add_edge`(self, source, target, edge)	Add edge between vertices into network.
`add_vertex`(self, vertex)	Add vertex into graph.
`clear`(self)	Clear graph.
`clear_in_edges`(self, descriptor)	Remove all in-edges of a vertex.
`clear_out_edges`(self, descriptor)	Remove all out-edges of a vertex.
`clear_vertex`(self, descriptor)	Remove all edges to and from a vertex.
`contains`(args, *kwargs)	Overloaded function.
`get`(args, *kwargs)	Overloaded function.
`get_vertex_index_map`(self)	Return Mapping of Vertex Descriptors to indices
`in_degree`(self, descriptor)	Get in-degree of given vertex.
`in_edges`(self, arg0)
`is_connected`(self)	Return if graph is fully connected
`isomorphism`(self, other, grenade, grenade, …)	Return one possible mapping of vertices of compared graphs.
`num_edges`(self)	Get number of edges in graph.
`num_vertices`(self)	Get number of vertices in graph.
`out_degree`(self, descriptor)	Get out-degree of given vertex.
`remove_edge`(args, *kwargs)	Overloaded function.
`remove_vertex`(self, descriptor)	Remove vertex.
`set`(args, *kwargs)	Overloaded function.
`source`(self, descriptor)	Get source vertex of given edge.
`strong_components`(self)	Get strong components of graph.
`target`(self, descriptor)	Get target vertex of given edge.
`valid`(self)	Check whether topology is valid.
`valid_strong_components`(self)	Check whether strong components of topology are valid.
`vertices`(self)

add_edge(self: pygrenade_common.Topology, source: pygrenade_common.VertexOnTopology, target: pygrenade_common.VertexOnTopology, edge: pygrenade_common.Edge) → pygrenade_common.EdgeOnTopology: Add edge between vertices into network.

add_vertex(self: pygrenade_common.Topology, vertex: pygrenade_common.Vertex) → pygrenade_common.VertexOnTopology: Add vertex into graph.

clear(self: pygrenade_common.Topology) → None: Clear graph. Removes all edges and vertices of graph.

clear_in_edges(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → None: Remove all in-edges of a vertex.

clear_out_edges(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → None: Remove all out-edges of a vertex.

clear_vertex(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → None: Remove all edges to and from a vertex.

contains(*args, **kwargs)

Overloaded function.

contains(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) -> bool

Get whether graph contains given vertex.

contains(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology) -> bool

Get whether graph contains given edge.

get(*args, **kwargs)

Overloaded function.

get(self: pygrenade_common.Topology, arg0: pygrenade_common.VertexOnTopology) -> pygrenade_common.Vertex
get(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology) -> pygrenade_common.Edge

Get edge property.

get_vertex_index_map(self: pygrenade_common.Topology) → dict[pygrenade_common.VertexOnTopology, int]: Return Mapping of Vertex Descriptors to indices

in_degree(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → int: Get in-degree of given vertex.

in_edges(self: pygrenade_common.Topology, arg0: pygrenade_common.VertexOnTopology) → list[pygrenade_common.EdgeOnTopology]

is_connected(self: pygrenade_common.Topology) → bool: Return if graph is fully connected

isomorphism(self: pygrenade_common.Topology, other: grenade::common::Graph<grenade::common::Topology, boost::adjacency_list<boost::multisetS, boost::listS, boost::bidirectionalS, boost::no_property, boost::no_property, boost::no_property, boost::listS>, grenade::common::Vertex, grenade::common::Edge, grenade::common::VertexOnTopology, grenade::common::EdgeOnTopology, std::shared_ptr>) → dict[pygrenade_common.VertexOnTopology, pygrenade_common.VertexOnTopology]: Return one possible mapping of vertices of compared graphs. If no mapping is possible an empty map is returned.

num_edges(self: pygrenade_common.Topology) → int: Get number of edges in graph.

num_vertices(self: pygrenade_common.Topology) → int: Get number of vertices in graph.

out_degree(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → int: Get out-degree of given vertex.

remove_edge(*args, **kwargs)

Overloaded function.

remove_edge(self: pygrenade_common.Topology, source: pygrenade_common.VertexOnTopology, target: pygrenade_common.VertexOnTopology) -> None

Removes all edges between source and target vertex from graph.

remove_edge(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology) -> None

Remove edge from graph.

remove_vertex(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology) → None: Remove vertex.

set(*args, **kwargs)

Overloaded function.

set(self: pygrenade_common.Topology, descriptor: pygrenade_common.VertexOnTopology, vertex: pygrenade_common.Vertex) -> None

Set vertex property.

set(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology, edge: pygrenade_common.Edge) -> None

Set edge property.

source(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology) → pygrenade_common.VertexOnTopology: Get source vertex of given edge.

strong_components(self: pygrenade_common.Topology) → dict[pygrenade_common.VertexOnTopology, int]: Get strong components of graph. For each vertex, the component ID is returned.

target(self: pygrenade_common.Topology, descriptor: pygrenade_common.EdgeOnTopology) → pygrenade_common.VertexOnTopology: Get target vertex of given edge.

valid(self: pygrenade_common.Topology) → bool: Check whether topology is valid. Only valid strong components need to be checked, since all else is checked on adding elements.

valid_strong_components(self: pygrenade_common.Topology) → bool: Check whether strong components of topology are valid. Ensures, that all strong components vertices feature a homogeneous invariant.

vertices(self: pygrenade_common.Topology) → list[pygrenade_common.VertexOnTopology]