Metadata-Version: 2.1
Name: algopack
Version: 0.0.2
Summary: Implementation of various common CS algortihms in Cython
Home-page: https://github.com/divykj/algopack
Author: Divya Jain
Author-email: dkj@somaiya.edu
License: MIT
Project-URL: Documentation, https://github.com/divykj/algopack
Project-URL: Code, https://github.com/divykj/algopack
Project-URL: Issue tracker, https://github.com/divykj/algopack/issues
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: dev
Requires-Dist: doit (==0.32.0) ; extra == 'dev'
Requires-Dist: pytest (==5.4.1) ; extra == 'dev'
Requires-Dist: Cython (==0.29.16) ; extra == 'dev'
Requires-Dist: twine (==3.1.1) ; extra == 'dev'

========
algopack
========
Implementation of various common CS algorithms in Cython

Usage
=====

Installation
------------
.. code-block:: shell

    $ pip install algopack

Examples
--------

Sorting:

.. code-block:: python3

    from algopack import sort

    my_array = [10, 0, 5, 15, -5]
    sorted_array = sort.bubble(my_array)
    print(sorted_array)
    # [-5, 0, 5, 10, 15]

Testing
-------

Clone the repository::

    $ git clone https://github.com/divykj/algopack.git
    $ cd algopack


Install requirements::

    $ pip install -r requirements.txt
    $ pip install -r requirements_dev.txt

Run tests::

    $ doit tests


Modules
=======

- `sort <algopack/sort.pyx>`_
    - `bubble <algopack/sort.pyx#L2-L18>`_
    - `bucket <algopack/sort.pyx#L22-L38>`_
    - `cocktail_shaker <algopack/sort.pyx#L42-L64>`_
    - `comb <algopack/sort.pyx#L68-L90>`_
    - `counting <algopack/sort.pyx#L94-L124>`_
    - `gnome <algopack/sort.pyx#L128-L139>`_
    - `heap <algopack/sort.pyx#L143-L175>`_
    - `insertion <algopack/sort.pyx#L179-L196>`_
    - `merge <algopack/sort.pyx#L200-L238>`_
    - `pancake <algopack/sort.pyx#L242-L255>`_
    - `quick <algopack/sort.pyx#L259-L287>`_
    - `radix <algopack/sort.pyx#L291-L315>`_
    - `selection <algopack/sort.pyx#L319-L335>`_
    - `shell <algopack/sort.pyx#L339-L358>`_

