choreo.ActionSym.BuildCayleyGraph#

static ActionSym.BuildCayleyGraph()#

Builds the Cayley graph of a list of group generators.

Parameters:

  • nbody (int) – Number of bodies in the system.

  • geodim (int) – Dimension of ambiant space.

  • GeneratorList (list of choreo.ActionSym, optional) – List of generators, by default [].

  • max_layers (int, optional) – Maximum number of layers in the graph before raising an error, by default 1000.

  • add_edge_data (bool, optional) – Whether to add the generator to edges of the graph, by default False.

Returns:

The Cayley graph.

Return type:

networkx.DiGraph

Raises:

ValueError – If the number of layers in the graph is larger than max_layers.