API reference
=============

The public API is re-exported from the top-level :mod:`yggdrax` package. The
modules below are documented from their source docstrings.

Tree building
-------------

.. automodule:: yggdrax.tree
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: yggdrax.octree
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: yggdrax.kdtree
   :members:
   :undoc-members:
   :show-inheritance:

Geometry
--------

.. automodule:: yggdrax.geometry
   :members:
   :undoc-members:

Interactions and traversal
---------------------------

.. automodule:: yggdrax.interactions
   :members:
   :undoc-members:

.. automodule:: yggdrax.traversal
   :members:
   :undoc-members:

.. automodule:: yggdrax.dense_interactions
   :members:
   :undoc-members:

.. automodule:: yggdrax.grouped_interactions
   :members:
   :undoc-members:

Moments
-------

.. automodule:: yggdrax.tree_moments
   :members:
   :undoc-members:

.. automodule:: yggdrax.multipole_utils
   :members:
   :undoc-members:

Morton ordering and primitives
-------------------------------

.. automodule:: yggdrax.morton
   :members:
   :undoc-members:

.. automodule:: yggdrax.bounds
   :members:
   :undoc-members:

.. automodule:: yggdrax.dtypes
   :members:
   :undoc-members:

Contracts and types
--------------------

.. automodule:: yggdrax.protocols
   :members:
   :undoc-members:

.. automodule:: yggdrax.types
   :members:
   :undoc-members:

.. automodule:: yggdrax.policies
   :members:
   :undoc-members: