Usage
=====

How to installing the package
-----------------------------

Install the project into your Python environment:

.. code:: console

    $ pip install boring-math-recursive-functions

Importing the modules
---------------------

Import the functions from either or both the ``number_theory`` or ``combinatorics``

.. code:: python

    from boring_math.recursive_functions.examples import ackermann_list
    from boring_math.recursive_functions.examples import fibonacci_generator
    from boring_math.recursive_functions.examples import rev_fibonacci_generator

Executing the applications
--------------------------

When you install the PyPI project, the application is installed into your Python environment.

.. code:: console

    $ ackermann 0 0
    1
    $ ackermann 0 1
    2
    $ ackermann 0 10
    11
    $ ackermann 1 0
    2
    $ ackermann 1 1
    3
    $ ackermann 1 10
    12
    $ ackermann 2 0
    3
    $ ackermann 2 1
    5
    $ ackermann 2 10
    23
    $ ackermann 3 0
    5
    $ ackermann 3 1
    13
    $ ackermann 3 2
    29
    $ ackermann 3 5
    253
    $ ackermann 3 10
    8189
    $ ackermann 4 0
    13
    $ ackermann 4 1
    65533
    $ ackermann 5 0
    65533