CodeViking Math Documentation
=============================

A collection of mathematical utility funcitons.

This package currently supports Python 3 only.  There is no planned support for
Python 2.  Patches that provide Python 2 compatibility are welcome.

**WARNING**:  Code and documentation are currently in beta testing.
Everything documented here is expected to work, but not all features have
been thoroughly tested yet.  If you find any bugs, please file a bug report.
at https://bitbucket.org/codeviking/python-codeviking.math/


.. toctree::
    :maxdepth: 8


:mod:`codeviking.math` Package
------------------------------


Numerical Comparison Functions
------------------------------
.. automodule:: codeviking.math.comparisons
   :members:

Easing Functions
----------------
.. automodule:: codeviking.math.ease
   :members:

Functions
---------
.. automodule:: codeviking.math.functions
   :members:

2D Geometry
-----------
.. automodule:: codeviking.math.geom2d
   :members:

Linear Algebra
--------------
.. automodule:: codeviking.math.linalg
   :members:


Primitive Functions
-------------------
.. automodule:: codeviking.math.primitives
   :members:




Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`