Optimized animations.

Let characters that have been read continue highlighting.
Lower the frame rate inb notebook to fasten animation generation.

Author: dsr20030703

automata/base/animation.py

@@ -227,24 +227,6 @@ def change_symbol(self, current_index: int) -> Iterable[manim.ApplyMethod]:
         """
         if current_index >= 0:
             yield Animate.highlight(self[current_index])
-            if current_index >= 1:
-                yield Animate.to_default_color(self[current_index - 1])
-
-    def clean(self, current_index: int) -> Iterable[manim.ApplyMethod]:
-        """
-        Cancel all the highlighted elements.
-
-        Parameters
-        ----------
-        current_index : int
-            The highlighted symbol to cancel highlight.
-
-        Returns
-        -------
-        The animations (maybe none) for `Scene` object to `play`.
-        """
-        if 0 <= current_index < len(self):
-            yield Animate.to_default_color(self[current_index])
 
     def show_result(self, accept: bool) -> manim.Write:
         """

automata/fa/animation.py

@@ -17,9 +17,8 @@
 
 class _FAGraph(manim.VDict):
     """
-    The `FAGraph` class is the common class for FA to draw a picture of a `FA`
-    object by representing the `AGraph` object generated by `fa.show_diagram()` with
-    manim.
+    The `FAGraph` class is the common class for FA to draw a picture of a `FA` object by
+    representing the `AGraph` object generated by `fa.diagram` with manim.
 
     The `FAGraph` class is a `VDict`. The keys are the states (with type `FAStateT`)
     and the transitions (with type `tuple[FAStateT, FAStateT]`, which is their start
@@ -37,17 +36,17 @@ def __init__(self, fa: FA) -> None:
         fa : FA
             The FA object based to create the graph.
 
-            Note that states are discriminated by `FA._get_state_name`, so states
-            are not allowed to have same names. Plus, states are not allowed to be
-            named 'None'.
+        Note
+        ----
+        As states are discriminated by `FA._get_state_name`, they are not allowed to
+        have same names, nor named as 'None'.
         """
         name_state = {FA._get_state_name(state): state for state in fa.states}
-        fa_diagram = fa.show_diagram()
         super().__init__(
-            {name_state.get(node): _ManimNode(node) for node in fa_diagram.nodes_iter()}
+            {name_state.get(node): _ManimNode(node) for node in fa.diagram.nodes_iter()}
             | {
                 tuple(map(name_state.get, edge)): _ManimEdge(edge)
-                for edge in fa_diagram.edges_iter()
+                for edge in fa.diagram.edges_iter()
             }
         )
         self.scale_to_fit_width(manim.config.frame_width)
@@ -235,7 +234,6 @@ def construct(self) -> None:
             accepts_input = False
         self.play(
             *self.dfa_graph.clean(((states_queue[-2], states_queue[-1]),)),
-            *self.input_symbols.clean(symbol_index),
             self.input_symbols.show_result(accepts_input),
         )
 
@@ -370,11 +368,7 @@ def add_lambda_transitions() -> Iterable[tuple["NFAStateT", "NFAStateT"]]:
                 current_transitions = lambda_transitions
         self.play(
             *self.nfa_graph.clean(current_transitions),
-            *self.input_symbols.clean(input_index),
             self.input_symbols.show_result(
-                any(
-                    current_state in self.nfa.final_states
-                    for current_state in current_states
-                )
+                not current_states.isdisjoint(self.nfa.final_states)
             ),
         )

automata/fa/fa.py

@@ -5,6 +5,7 @@
 import abc
 import os
 from collections import defaultdict
+from functools import cached_property
 from typing import Any, Dict, Generator, List, Optional, Set, Tuple, Union
 
 from automata.base.automaton import Automaton, AutomatonStateT
@@ -28,7 +29,7 @@ class FA(Automaton, metaclass=abc.ABCMeta):
     """
     The `FA` class is an abstract base class from which all finite automata inherit.
     Every subclass of FA can be rendered natively inside of a Jupyter notebook
-    (automatically calling `show_diagram` without any arguments) if installed with
+    (automatically calling `diagram` property) if installed with
     the `visual` optional dependency.
     """
 
@@ -183,6 +184,16 @@ def show_diagram(
 
         return graph
 
+    @cached_property
+    def diagram(self) -> pgv.AGraph:
+        """
+        Returns
+        -------
+        AGraph
+            A diagram of this automaton.
+        """
+        return self.show_diagram()
+
     @abc.abstractmethod
     def _get_input_path(
         self, input_str: str
@@ -196,7 +207,7 @@ def _get_input_path(
     def _repr_mimebundle_(
         self, *args: Any, **kwargs: Any
     ) -> Dict[str, Union[bytes, str]]:
-        return self.show_diagram()._repr_mimebundle_(*args, **kwargs)
+        return self.diagram._repr_mimebundle_(*args, **kwargs)
 
     @staticmethod
     def _add_new_state(state_set: Set[FAStateT], start: int = 0) -> int:

example_notebooks/fa_animation.ipynb

@@ -18,6 +18,19 @@
     "from automata.fa.nfa import NFA"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import manim\n",
+    "\n",
+    "# By default, the frame rate is 60 fps. So it takes a while to generates the animation.\n",
+    "# This notebook set the frame rate lower to fasten the animation generation.\n",
+    "manim.config.frame_rate = 12"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -51,7 +64,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The animation genereated will be in the `media/videos/1080p60` folder by default. When set `preview=True`, the video will show as soon as it's generated."
+    "The animation genereated will be in the `media/videos/{pixel height}p{frame rate}` folder by default. When set `preview=True`, the video will show as soon as it's generated."
    ]
   },
   {
@@ -176,7 +189,6 @@
    "outputs": [],
    "source": [
     "from automata.base.animation import Animate\n",
-    "import manim\n",
     "\n",
     "Animate.HIGHLIGHT_COLOR = manim.XKCD.AVOCADO\n",
     "regex_nfa.animate_reading_input(\"0101000\", preview=True)"
@@ -225,7 +237,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.9"
+   "version": "3.12.10"
   }
  },
  "nbformat": 4,