HAT Documentation
=================
This page provides an overview of the ``Hypergraph`` class and its associated modules, which offer tools for analyzing, visualizing, and working with the structure and dynamics of hypergraphs.


Hypergraph Class
---------------------

The ``Hypergraph`` class serves as the core data structure in HAT. It represents a hypergraph's nodes, hyperedges, and related metadata. It also supports a variety of numerical representations, including tensors and incidence matrices.

Creating a ``Hypergraph`` object provides access to additional analysis and visualization functionality across the toolbox’s modules.

.. automodule:: HAT.hypergraph
   :members:
   :undoc-members:
   :show-inheritance:

Tensor Representations
----------------------

.. automodule:: HAT.tensors
   :members:
   :undoc-members:
   :show-inheritance:

Laplacians
----------------------

.. automodule:: HAT.laplacian
   :members:
   :undoc-members:
   :show-inheritance:

Graph Interface
---------------------

.. automodule:: HAT.graph
   :members:
   :undoc-members:
   :show-inheritance:

Hypergraph Metrics
---------------------

.. automodule:: HAT.metrics
   :members:
   :undoc-members:
   :show-inheritance:

Dynamics and Control
---------------------

.. automodule:: HAT.dynamics
   :members:
   :undoc-members:
   :show-inheritance:

HAT.HAT module
---------------

.. automodule:: HAT.HAT
   :members:
   :undoc-members:
   :show-inheritance:

HAT.draw module
---------------

.. automodule:: HAT.draw
   :members:
   :undoc-members:
   :show-inheritance:

HAT.multilinalg module
----------------------

.. automodule:: HAT.multilinalg
   :members:
   :undoc-members:
   :show-inheritance:

Bug Reporting
-------------
Please report all bugs or defects in HAT to `this page <https://github.com/Jpickard1/Hypergraph-Analysis-Toolbox/issues>`_.