Source code for mcs.de

from .mcs import *




class DE(MCS):
    """Difference equations simulation.

    Attributes:
        max_step: The max step.
        dim: The number of variables.
        x: An `~numpy.ndarray` representing the states of shape (max_step, dim).
        step: The current step.
    """

    def __init__(self, max_step: int, dim: int):
        super().__init__(max_step)
        self.dim = dim
        self.x = np.zeros((max_step, dim))



    def initialize(self, *, x0: List[float] = None):
        """Sets up the initial values for the state variables.

        Args:
            x0: A list of initial states.
        """
        if x0 is None:
            x0 = [0] * len(self.dim)
        assert len(x0) == self.dim
        self.x[0] = x0




    def update(self, *, f: Callable = None):
        """Updates the states in the next step.

        Args:
            f: A function, :math:`x_t = f(x_{t-1})`.
        """
        if f is None:
            f = self._identity
        x = self.x[self.step]
        self.step += 1
        self.x[self.step] = np.array(f(x))




    def visualize(self, *, step: int = -1, indices: List[int] = None):
        """Visualizes the series of states of the system.

        Args:
            step: The step to plot.
            indices: A list of indices of the states to plot.
                If `None`, plot all states.
        Returns:
            A `matplotlib.figure.Figure` object.
        """
        fig, ax = plt.subplots()
        indices = np.arange(self.dim) if indices is None else indices
        for state in indices:
            ax.plot(self.x[:step, state])
        return fig