metrics
=======

:py:mod:`appointment.metrics` provides diagnostics to analyze the results of elections, apportionments, and other political science scenarios.

**Functions**

* :py:func:`poli_sci_kit.appointment.metrics.ideal_share`
* :py:func:`poli_sci_kit.appointment.metrics.alloc_to_share_ratio`
* :py:func:`poli_sci_kit.appointment.metrics.sqr_alloc_to_share_error`
* :py:func:`poli_sci_kit.appointment.metrics.total_allocation_to_share_error`
* :py:func:`poli_sci_kit.appointment.metrics.representative_weight`
* :py:func:`poli_sci_kit.appointment.metrics.sqr_representative_weight_error`
* :py:func:`poli_sci_kit.appointment.metrics.total_representative_weight_error`
* :py:func:`poli_sci_kit.appointment.metrics.diversity_index`
* :py:func:`poli_sci_kit.appointment.metrics.effective_number_of_groups`
* :py:func:`poli_sci_kit.appointment.metrics.disproportionality_index`

.. autofunction:: poli_sci_kit.appointment.metrics.ideal_share
.. autofunction:: poli_sci_kit.appointment.metrics.alloc_to_share_ratio
.. autofunction:: poli_sci_kit.appointment.metrics.sqr_alloc_to_share_error
.. autofunction:: poli_sci_kit.appointment.metrics.total_allocation_to_share_error
.. autofunction:: poli_sci_kit.appointment.metrics.representative_weight
.. autofunction:: poli_sci_kit.appointment.metrics.sqr_representative_weight_error
.. autofunction:: poli_sci_kit.appointment.metrics.total_representative_weight_error
.. autofunction:: poli_sci_kit.appointment.metrics.diversity_index
.. autofunction:: poli_sci_kit.appointment.metrics.effective_number_of_groups
.. autofunction:: poli_sci_kit.appointment.metrics.disproportionality_index