jax_dna.simulators.io
=====================

.. py:module:: jax_dna.simulators.io

.. autoapi-nested-parse::

   Common data structures for simulator I/O.



Classes
-------

.. autoapisummary::

   jax_dna.simulators.io.SimulatorTrajectory


Module Contents
---------------

.. py:class:: SimulatorTrajectory

   A trajectory of a simulation run.


   .. py:attribute:: rigid_body
      :type:  jax_md.rigid_body.RigidBody


   .. py:method:: slice(key: int | slice) -> SimulatorTrajectory

      Slice the trajectory.



   .. py:method:: length() -> int

      Return the length of the trajectory.

      Note, that this may have been more natural to implement as the built-in
      __len__ method. However, the chex.dataclass decorator overrides that
      method to be compatabile with the abc.Mapping interface

      See here:
      https://github.com/google-deepmind/chex/blob/8af2c9e8a19f3a57d9bd283c2a34148aef952f60/chex/_src/dataclass.py#L50



   .. py:method:: __add__(other: SimulatorTrajectory) -> SimulatorTrajectory

      Concatenate two trajectories.