.. module:: peccary.utils

.. _peccary-utils:

*************************************
Utility Functions (``peccary.utils``)
*************************************

Introduction
============

The ``utils`` module provides a variety of useful functions
for related to the PECCARY method. This includes converting
between sampling intervals and pattern timescales, calculating 
limits of the HC plane given some sampling size :math:`n`,
and calculating the allowed region of the HC plane.

.. _peccary-utils-api:

API
===

.. automodapi:: peccary.utils
    :no-inheritance-diagram: