Welcome to Python Algorithms’s documentation!¶
Contents:
Python Algorithms¶
Python Algorithms contains a collection of useful algorithms written in python. The algorithms include (but not limited to) topics such as searching, sorting, graph, and string theory.
This project is inspired from the textbook Algorithms, 4th Edition by Robert Sedgewick and Kevin Wayne and associated book-site http://algs4.cs.princeton.edu/home/. The goal of this book is summarized in the following excerpt from the book-site:
Our original goal for this book was to cover the 50 algorithms that every programmer should know. We use the word programmer to refer to anyone engaged in trying to accomplish something with the help of a computer, including scientists, engineers, and applications developers, not to mention college students in science, engineering, and computer science.
However, the algorithms for this project are not meant to be a ported version of the algorithms found in the book. Efforts should be made to implement those algorithms from the scratch following Pythonic coding style. Some of the algorithms are well known and the reference for those algorithms should appear in the documentation. While, some of the algorithms are very specific and difficult implement in a different way while maintaining accuracy and efficiency. Such algorithms appear in the scientific literatures and/or books and those should be properly referenced as well.
Features¶
- Mainly for educational purposes, but can be useful in certain practical scenarios as well.
- Consequently, built-in algorithms are avoided as much as possible and detailed implementation is done from the scratch.
- Preference is given towards a pythonic style rather than sticking to true OOP style.
- Free software: BSD license.
- Documentation: http://python_algorithms.rtfd.org.
Algorithms¶
Here is a list of algorithms divided into packages.
Note
Not all of the algorithms have been fully implemented yet.
Basic¶
A collection of few basic algorithms that do not fit in other packages. Trivial algorithms and data structures that are built into python are skipped.
- Binary search
- Knuth shuffle
- Stack
- Queue
- Bag
- Union find
| Estimated Release: | |
|---|---|
| 0.2.0 | |
Searching¶
Specialized searching algorithms and/or corresponding data structures are included in this package. Although some of the following data structures, such as Hash, are implemented in python, they have been implemented for demonstration purpose. Unless, specific needs arise, the built-in data structures should be preferred in production code.
- BST
- Red black BST
- Hash
| Estimated Release: | |
|---|---|
| 0.3.0 | |
Installation¶
At the command line:
$ easy_install python_algorithms
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv python_algorithms
$ pip install python_algorithms
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/mihassan/python_algorithms/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
Python Algorithms could always use more documentation, whether as part of the official Python Algorithms docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/mihassan/python_algorithms/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up python_algorithms for local development.
Fork the python_algorithms repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/python_algorithms.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv pyalgs $ cd pyalgs/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
Alternatively, use git flow to start a new feature or bugfix branch and work on that branch locally. Once, ready to publish, push the branch to github:
$ git flow feature start name-of-feature $ echo "Develop the feature on this feature branch" $ git flow feature finish $ git push
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 pyalgs tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Update Python Packages¶
Be mindful of updating packages as it may break some dependencies. Still, from time to time we need to update the packages following these steps:
1. $ pip freeze --local | grep -v '^\-e' | cut -d = -f 1 | xargs -n1 pip install -U
2. $ pip freeze --local -r requirements.txt > requirements.txt
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, 3.3, 3.4, and 3.5, and for PyPy. Check https://travis-ci.org/mihassan/python_algorithms/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Md. Imrul Hassan <mihassan@gmail.com>
Contributors¶
None yet. Why not be the first?
API Reference¶
pyalgs package¶
Subpackages¶
pyalgs.basic package¶
Submodules¶
pyalgs.basic.bag module¶
This module implements a bag or multiset data structure.
A bag or multiset is a generalization of the set data structure which allows repeated or duplicate items to be stored. Items can only be added to the bag and may not be removed. When the items in the bag are iterated there is not restriction on the ordering of the items.
In this module, the implementation of bag is similar to a linked list based stack implementation. In the linked list based implementation, the bag object need to keep track of only the head node. Each node contains an item and a link to the next node.
Note
Python has a built-in class collections.Counter which is similar to a bag or multiset. instead of adding an item, 1 need to be added with the counter associated with that item and elements return all items (including duplicates) in the bag.
- Complexity:
- add – O(1)
pyalgs.basic.binary_search module¶
This module implements binary search method.
-
pyalgs.basic.binary_search.search(seq, val)[source]¶ Search location of key in a sorted list.
The method searches the location of a value in a list using binary searching algorithm. If it does not find the value, it returns -1.
- Args:
- seq: A sorted list from which the value(val) has to be searched. val: A value to search for.
- Returns:
- The location of the value in the sorted list if found. Otherwise returns -1.
pyalgs.basic.knuth_shuffle module¶
This module implements a shuffle method using Knuth’s algorithm.
-
pyalgs.basic.knuth_shuffle.shuffle(seq)[source]¶ Shuffle a list randomly using Knuth’s algorithm.
The method randomly shuffles a list by iterating over each position and exchanging the element with another random element. The original list is not maintained and will change.
- Args:
- seq: A list to shuffle.
- Returns:
- The original list with all elements shuffled.
pyalgs.basic.queue module¶
This module implements a linked list based queue data structure.
A queue is a data structure to hold a collection of items in order ad which supports operations such as the addition of an item (enqueue) and removal of an item (dequeue) can be performed. The items are always enqueued at the rear end of the queue and dequeued from the front end of the queue. As such, the queue can be also viewed as a First-In-First-Out(FIFO) data structure. In a FIFO data structure, the first item added to the structure is the first one to be removed. Apart from those two operations, peek operation can also be implemented, returning the value at the front end without removing it.
The particular implementation of queue in this module is based on linked list, as array based queue implementation is already supported in python’s list. In the linked list based implementation, the queue object need to keep track of the front and the rear nodes where each node contains an item and a link to the next node.
Note
For most practical purposes, the python’s implementation as dequeue suffices as a queue object. Use append method instead of enqueue and popleft method instead of dequeue for queue operations in a list.
- Complexity:
- push – O(1)
- pop – O(1)
- peek – O(1)
-
class
pyalgs.basic.queue.Queue[source]¶ Bases:
objectAn implementation of a simple queue with linked list.
-
dequeue()[source]¶ Remove and return the first item from the queue.
- Returns:
- The first item from the queue.
- Raises:
- IndexError: If the queue is empty.
-
isEmpty()[source]¶ Check if the queue is empty.
- Returns:
- True if the queue is empty. False otherwise.
-
peek()[source]¶ Return the first item from the queue.
- Returns:
- The first item from the queue.
- Raises:
- IndexError: If the queue is empty.
-
size¶ The number of items in the queue.
-
pyalgs.basic.stack module¶
This module implements a linked list based stack data structure.
A stack is a data structure to hold a collection of items in which operations such as the addition of an item (push) and removal of an item (pop) can be performed. The items are always pushed or popped from the so called top of the data structure which is the last item added or first item to be removed. The stack can be also viewed as a Last-In-First-Out(LIFO) data structure. In a LIFO data structure, the last item added to the structure must be the first item one to be removed. Apart from those two operations, peek operation can also be implemented, returning the value of the top item without removing it.
The particular implementation of stack in this module is based on linked list, as array based stack implementation is already supported in python’s list. In the linked list based implementation, the stack object need to keep track of only the head node. Each node contains an item and a link to the next node.
Note
For most practical purposes, the python’s list suffices as a stack object. Use append method instead of push and pop method as it is for stack operations in a list.
- Complexity:
- push – O(1)
- pop – O(1)
- peek – O(1)
-
class
pyalgs.basic.stack.Stack[source]¶ Bases:
objectAn implementation of a simple stack with linked list.
-
isEmpty()[source]¶ Check if the stack is empty.
- Returns:
- True if the stack is empty. False otherwise.
-
peek()[source]¶ Return the last added item from the stack.
- Returns:
- The last item added to the stack.
- Raises:
- IndexError: If the stack is empty.
-
pop()[source]¶ Remove and return the last added item from the stack.
- Returns:
- The last item added to the stack.
- Raises:
- IndexError: If the stack is empty.
-
size¶ The number of items in the stack.
-
pyalgs.basic.union_find module¶
This module implements an union find or disjoint set data structure.
An union find data structure can keep track of a set of elements into a number of disjoint (nonoverlapping) subsets. That is why it is also known as the disjoint set data structure. Mainly two useful operations on such a data structure can be performed. A find operation determines which subset a particular element is in. This can be used for determining if two elements are in the same subset. An union Join two subsets into a single subset.
The complexity of these two operations depend on the particular implementation. It is possible to achieve constant time (O(1)) for any one of those operations while the operation is penalized. A balance between the complexities of these two operations is desirable and achievable following two enhancements:
- Using union by rank – always attach the smaller tree to the root of the larger tree.
- Using path compression – flattening the structure of the tree whenever find is used on it.
- complexity:
- find –
where 
is
inverse ackerman function. - union – where is
inverse ackerman function.
- find –
Module contents¶
This module contains few basic algorithms that do not fit in other packages. Trivial algorithms and data structures that are built into python are skipped.
Module contents¶
The module contains a collection of useful algorithms written in python.