Top-Level API
=============

Package Entry Points
--------------------

Asunder Package
^^^^^^^^^^^^^^^

.. automodule:: asunder

The top-level package re-exports the most common entry points for convenience.
Canonical API documentation is provided on the module pages below to avoid
duplicate object targets for the same symbols.

Common package-level imports
""""""""""""""""""""""""""""

- ``asunder.run_csd_decomposition``
- ``asunder.solve_master_problem``
- ``asunder.solve_subproblem``
- ``asunder.run_evaluation``
- ``asunder.create_solver``
- ``asunder.CSDDecomposition``
- ``asunder.CSDDecompositionConfig``
- ``asunder.IterationRecord``
- ``asunder.DecompositionResult``

Application package imports
"""""""""""""""""""""""""""

- ``asunder.load_balancing.LoadBalancer`` for the built-in load-balanced graph
  partitioning workflow
- ``asunder.nlbnp.CorePeripheryPartition`` for component-level NLBNP
  partitioning after core removal
- ``asunder.nlbnp.NonlinearBranchAndPrice`` for generic nonlinear
  branch-and-price runs on user-provided graphs
- ``asunder.nlbnp.run_evaluation`` for the built-in nonlinear branch-and-price
  case-study evaluation workflow

Configuration
^^^^^^^^^^^^^

.. automodule:: asunder.config
   :members:
   :member-order: bysource
   :show-inheritance:

Orchestrator
^^^^^^^^^^^^

.. automodule:: asunder.orchestrator
   :members:
   :member-order: bysource
   :show-inheritance:

Solvers
^^^^^^^

.. automodule:: asunder.solvers
   :members:
   :member-order: bysource
   :show-inheritance:

Types
^^^^^

.. automodule:: asunder.types
   :members:
   :member-order: bysource
   :show-inheritance: