Skip to content

Commit

Permalink
doc for BurntPancakeGraph
Browse files Browse the repository at this point in the history
  • Loading branch information
Marina Anagnostopoulou-Merkouri authored and james-d-mitchell committed May 26, 2021
1 parent 7648cb3 commit cc3fb38
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions doc/examples.xml
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,43 @@ true]]></Example>
</ManSection>
<#/GAPDoc>

<#GAPDoc Label="BurntPancakeGraph">
<ManSection>
<Oper Name="BurntPancakeGraph" Arg="[filt, ]n"/>
<Returns>A digraph.</Returns>
<Description>
If <A>n</A> is a positive integer, then this operation returns
the <E>Burnt Pancake graph</E> with <M>n!</M> vertices and <M>n!(n - 1)</M>
directed edges. The <M>n</M>th Pancake graph is the Cayley graph of the
hyperoctahedral group acting on <C>[<A>-n</A> .. -1, 1 .. <A>n</A>]</C> with respect to the
generating set consisting of the <Q>prefix reversals</Q>, which are defined in exactly
the same way as in <Ref Attr="PancakeGraph"/>. The hyperoctahedral group consists of
permutations <M>p</M> acting on <C>[<A>-n</A> .. -1, 1 .. <A>n</A>]</C>, where the image
of any arbitrary point <M>i</M> in <C>[<A>-n</A> .. -1, 1 .. <A>n</A>]</C> is equal to the
negative of the image of <M>-i</M> under <M>p</M>.
If the optional first argument <A>filt</A> is not present, then <Ref
Filt="IsImmutableDigraph"/> is used by default.<P/>

See <URL>https://en.wikipedia.org/wiki/Pancake_graph</URL> for further
details.

<Example><![CDATA[
gap> BurntPancakeGraph(3);
<immutable Hamiltonian connected symmetric digraph with 48 vertices, 144 edges\
>
gap> BurntPancakeGraph(4);
<immutable Hamiltonian connected symmetric digraph with 384 vertices, 1536 edg\
es>
gap> BurntPancakeGraph(5);
<immutable Hamiltonian connected symmetric digraph with 3840 vertices, 19200 e\
dges>
gap> BurntPancakeGraph(IsMutableDigraph, 1);
<mutable digraph with 1 vertex, 1 edge>
]]></Example>
</Description>
</ManSection>
<#/GAPDoc>

<#GAPDoc Label="StarDigraph">
<ManSection>
<Oper Name="StarDigraph" Arg="[filt, ]k"/>
Expand Down

0 comments on commit cc3fb38

Please sign in to comment.