Full Package Reference
======================

This page contains the full reference for the ``gerrychain`` package, and
is included primarily for the sake of developers trying to hunt down errors
or understand the codebase. For a more user-friendly introduction to the
usage of the package, please see the :ref:`api_reference`.

.. automodule:: gerrychain
    :noindex:

Accept
------

.. automodule:: gerrychain.accept
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Chain
-----

.. automodule:: gerrychain.chain
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Constraints
-----------

.. automodule:: gerrychain.constraints.bounds
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.constraints.compactness
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.constraints.contiguity
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.constraints.validity
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:


Graph
-----

.. automodule:: gerrychain.graph.adjacency
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.graph.geo
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.graph.graph
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Grid
----

.. automodule:: gerrychain.grid
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Meta
----

.. automodule:: gerrychain.meta.diversity
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Metagraph
---------

.. automodule:: gerrychain.metagraph
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Metrics
-------

.. automodule:: gerrychain.metrics.compactness
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.metrics.partisan
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Optimization
------------

.. automodule:: gerrychain.optimization.optimization
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:


.. automodule:: gerrychain.optimization.gingleator
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Partition
---------

.. automodule:: gerrychain.partition.assignment
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.partition.geographic
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.partition.partition
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.partition.subgraphs
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Proposals
---------

.. automodule:: gerrychain.proposals.proposals
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.proposals.spectral_proposals
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.proposals.tree_proposals
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

Tree
----

.. automodule:: gerrychain.tree
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:


Updaters
--------

.. automodule:: gerrychain.updaters.compactness
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.county_splits
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.cut_edges
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.election
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.flows
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.locality_split_scores
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.spanning_trees
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: gerrychain.updaters.tally
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex: