API Reference
=============

This section provides detailed API documentation for all modules and classes in the BiSC algorithm package.

bisc_package
------------

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

Core Modules
------------

bisc_package.core.bisc_algorithm
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.core.bisc_algorithm
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.core.permutation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.core.permutation
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.core.mesh_pattern
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.core.mesh_pattern
   :members:
   :undoc-members:
   :show-inheritance:

Utility Modules
---------------

bisc_package.utils.pattern_utils
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.utils.pattern_utils
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.utils.mesh_utils
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.utils.mesh_utils
   :members:
   :undoc-members:
   :show-inheritance:

Example Modules
---------------

bisc_package.examples.known_classes.stack_sortable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.examples.known_classes.stack_sortable
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.examples.known_classes.smooth_permutations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.examples.known_classes.smooth_permutations
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.examples.known_classes.baxter_permutations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.examples.known_classes.baxter_permutations
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.examples.bisc_demo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.examples.bisc_demo
   :members:
   :undoc-members:
   :show-inheritance:

Command Line Interface
----------------------

bisc_package.cli
~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.cli
   :members:
   :undoc-members:
   :show-inheritance:

Testing Modules
---------------

bisc_package.tests.unit.test_permutation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.tests.unit.test_permutation
   :members:
   :undoc-members:
   :show-inheritance:

bisc_package.tests.integration.verify_examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: bisc_package.tests.integration.verify_examples
   :members:
   :undoc-members:
   :show-inheritance: