FiniteStateMachine._latex_: more options, better documentation

[cheuberg]

Improved FiniteStateMachine._latex_:

• use state iterators instead of lists
• move code format_transition_label
• collect tikz options in array
• typeset final_word_out, introduce relevant options: if a final state has an attribute final_word_out, this is typeset as a leaving edge. This is in preparation for #16191
• new method latex_options: Provide a new convenience function collecting all options for LaTeX output. While all of its functionality can also be achieved by directly setting attributes of FiniteStateMachine, FSMState and FSMTransition, this function also (somewhat) checks its input and serves to collect documentation on all these options.
• Added a section in the introduction to the module explaining how to latex a FiniteStateMachine and pointing to this method for details.
• Similarly, expanded explanations in setup_latex_preamble.
• Use latex_options in other doctest instead of direct attribute assignment

• new method default_format_transition_label: Previously, when no custorm FiniteStateMachine.format_transition_label was provided by the user, words have simply typeset by calling latex. As words are always lists, parentheses [ ] have always been printed. This new default method typesets words by juxtaposition of their letters, the letters are piped through format_letter first. The latter now defaults to latex.

  Finally, format_transition_label is by default set to default_format_transition_label in the hope of providing a sensible default value.

• Convenience Formatting functions for digit problems: When using negative digits, it is quite customary to write e.g. \overline{1} instead of -1 in LaTeX. Introduce FiniteStateMachine.format_letter_negative for this purpose.

  Furthermore, In digit expansions, digits are frequently processed from the least significant to the most significant position, but it is customary to write the least significant digit at the right-most position. Therefore, the labels have to be reversed. Provide a method FiniteStateMachine.format_transition_label_reversed for this purpose.

Depends on #16132 Depends on #16145 Depends on #16146 Depends on #16200 Depends on #16205

CC: @dkrenn @sagetrac-skropf

Component: combinatorics

Author: Clemens Heuberger

Branch/Commit: e5a3191

Reviewer: Daniel Krenn

Issue created by migration from https://trac.sagemath.org/ticket/16207

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

fe9b380	marked 3 doctests as indirect
92526f6	Merge branch 'fsm/latex-initial-state-new' into fsm/latex-rotate-labels-new
0bd8c5a	Merge branch 'fsm/latex-rotate-labels-new' #16205 into fsm/latex-improved
2438f93	replaced range by srange
1e294f2	replace \overline{-1} by \overline{1}
53a700c	Moved FiniteStateMachine._latex_.accepting_where to finite_state_machine.tikz_automata_where

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from d6661e7 to 53a700c

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

2d43fdd	FiniteStateMachine: add failing doctests: non-hashable colors
547968a	FiniteStateMachine.product_FiniteStateMachine, composition: fix unhashable colors
d51be51	Automaton.determinisation(): docstring on hashable colors
c5dd860	Merge branch 'fsm/state_color' into fsm/process_output_new
70294bf	trac ticket number added
ed93dd3	Minor changes during review.
3820c49	corrected whitespaceerror
a14dd81	Merge remote-tracking branch 'origin/u/dkrenn/ticket/16132' into fsm/process_output_new-on-beta8
afc15e5	Replaced two raise ..., ... by raise ...(...) in the spirit of #15990
4aee511	Merge ticket #16132 into #16207 in order to resolve merge conflict.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 53a700c to 4aee511

[cheuberg]

Changed dependencies from #16146, #16200, #16205 to #16132, #16146, #16200, #16205

[cheuberg]

comment:4

Merged #16132, otherwise, this will not merge (commit 53a700c introduced a new module local variable at the same position where #16132 did the same).

[cheuberg]

comment:5

trac's automerge fails. Patch is based on 6.2.beta8, it merges cleanly with 6.2.rc0.

[dkrenn]

Reviewer: Daniel Krenn

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

a6a417d	FiniteStateMachine._latex_: write final_word_out as "$ | output"
1f14955	FiniteStateMachine._latex_: use tikz arrow style "latex"
56b1d48	default accepting_distance=7ex because of $ in final output

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 4aee511 to 56b1d48

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

f13725d	asymptotic_moments: add explanation on PolynomialRing vs SymbolicRing
878acff	asymptotic_moments: replaced parameter verbose by sage.misc.misc.verbose
40da528	Explanations for >1 final components, periodic final components
00e063e	asymptotic_moments: upgraded two tests to examples
1908a5d	asymptotic_moments: unique initial states, all states are final
78997f5	Corrected and improved version of commit 40da528
d56a769	Rewrote asymptotic_moments to output en+Order(1) etc.
24b6d69	explained the shifting in the Gray code-construction differently
0b1200d	Merge branch 't/16143/fsm/example_gray_code' into fsm/asymptotic-moments
a0d894e	Merge remote-tracking branch 'aau/fsm/asymptotic-moments' into fsm/latex-options-digits

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 56b1d48 to a0d894e

[cheuberg]

Changed dependencies from #16132, #16146, #16200, #16205 to #16132, #16145, #16146, #16200, #16205

[cheuberg]

comment:10

merged #16145 in order to avoid a merge conflict and listed #16145 as a dependency.

[dkrenn]

Changed branch from u/cheuberg/fsm/latex-improved to u/dkrenn/fsm/latex-improved

[dkrenn]

comment:12

finished my review; everything is fine; corrected one PEP8-spacing.

---

New commits:

e5a3191

corrected one spacing (PEP8)

[dkrenn]

Changed commit from a0d894e to e5a3191

[vbraun]

Changed branch from u/dkrenn/fsm/latex-improved to e5a3191