Merge remote-tracking branch 'upstream/master'

Moved implentation of kruskal into WeightedGraph class into data_structures/graph.py and refactor relative tests. Changed some implementation details into Graph class to simplify the code into add_edge method

Author: Michele De Vita

.gitignore

@@ -55,3 +55,4 @@ docs/_build/
 
 # PyBuilder
 target/
+.idea/

README.rst

@@ -31,7 +31,13 @@ Installation
    pip3 install pygorithm
 
 - | It's that easy. If you are using Python 2.7 use pip instead. Depending on your
-  | permissions, you might need to ``sudo`` before installing
+  | permissions, you might need to use ``pip install --user pygorithm`` to install.
+
+* Or you can download the source code from `here <https://github.com/OmkarPathak/pygorithm>`_, and then just install the package using
+
+::
+
+    python setup.py install
 
 
 Quick Start Guide
@@ -63,3 +69,30 @@ Quick Start Guide
     from pygorithm.sorting import bubble_sort
     time_complexity = bubble_sort.time_complexities()
     print(time_complexity)
+
+* To see all the available functions in a module. For example, if you want to see what all sorts are available in the sorting module, then just do
+
+.. code:: python
+
+    >>> from pygorithm.sorting import modules
+    >>> modules()
+    ['bubble_sort', 'bucket_sort', 'counting_sort', 'heap_sort', 'insertion_sort', 'merge_sort', 'quick_sort', 'selection_sort', 'shell_sort']
+
+Tests
+~~~~~
+
+* Just type in the following command to run the tests
+::
+
+    python3 -m unittest
+
+* This will run all the tests defined in the files of the ``tests/`` directory
+
+
+Donation
+~~~~~~~~
+
+If you have found my softwares to be of any use to you, do consider helping me pay my internet bills. This would encourage me to create many such softwares :)
+
+- `PayPal <https://paypal.me/omkarpathak27>`_
+- `₹ (INR) <https://www.instamojo.com/@omkarpathak/>`_

TODO.md

@@ -0,0 +1,26 @@
+# TODO
+
+### Tree
+
+- [x] Binary Tree
+- [x] Binary Search Tree
+- [ ] Inorder to Preorder
+- [ ] Count Leaf Nodes
+
+### Graph
+
+- [x] Graph implementation
+- [x] Detect cycle in Graph
+- [x] Topological Sort
+- [ ] Prim's Algorithm
+- [ ] Kruskal's Algorithm
+
+### Dynamic Programming
+
+- [ ] Fibonacci
+- [ ] Longest Increasing Subsequence
+
+### Heap
+
+- [x] Heap  implementation
+- [x] Heap Sort

docs/Data_Structure.rst

@@ -0,0 +1,78 @@
+===============
+Data Structures
+===============
+
+Implementing Data Structures purely in Python.
+
+Quick Start Guide
+-----------------
+
+.. code-block:: python
+
+    # import the required data structure
+    from pygorithm.data_structures import stack
+
+    # create a stack with default stack size 10
+    myStack = stack.Stack()
+    myStack.push(2)
+
+    # print the contents of stack
+    print(myStack)
+
+Features
+--------
+
+* Data Structures implementations available:
+    - **Stack**
+        - Stack (data_structures.stack.Stack)
+        - Infix to Postfix conversion (data_structures.stack.InfixToPostfix)
+    - **Queue**
+        - Queue (data_structures.queue.Queue)
+        - Deque (data_structures.queue.Deque)
+    - **Linked List**
+        - Singly Linked List (data_structures.linked_list.SinglyLinkedList)
+        - Doubly Linked List (data_structures.linked_list.DoublyLinkedList)
+    - **Tree**
+        - Binary Tree (data_structures.tree.BinaryTree)
+        - Binary Seach Tree (data_structures.tree.BinarySearchTree)
+    - **Graph**
+        - Graph (data_structures.graph.Graph)
+        - Topological Sort (data_structures.graph.TopologicalSort)
+        - Check cycle in Directed Graph (data_structures.graph.CheckCycleDirectedGraph)
+        - Check cycle in Undirected Graph (data_structures.graph.CheckCycleUndirectedGraph)
+    - **Heap**
+        - Heap (data_structures.heap.Heap)
+
+* Get the code used for any of the implementation
+
+.. code:: python
+
+    from pygorithm.data_structures.stack import Stack
+
+    myStack = Stack()
+    print(myStack.get_code())
+
+* To see all the available functions in a module there is a `modules()` function available. For example,
+
+.. code:: python
+
+    >>> from pygorithm.data_structures import modules
+    >>> modules()
+    ['graph', 'heap', 'linked_list', 'queue', 'stack', 'tree']
+
+Stack
+-----
+
+.. automodule:: pygorithm.data_structures.stack
+
+   Stack
+   -----
+   .. autoclass:: Stack
+      :members:
+
+.. automodule:: pygorithm.data_structures.stack
+
+ Stack
+ -----
+ .. autoclass:: InfixToPostfix
+    :members:

docs/Fibonacci.rst

@@ -0,0 +1,53 @@
+=========
+Fibonacci
+=========
+
+Learning fibonacci implementations in few ways!
+
+Quick Start Guide
+-----------------
+
+.. code-block:: python
+
+    from pygorithm.fibonacci import recursion as fib_recursion
+
+    sequence = fib_recursion.get_sequence(10)
+    print(sequence)  # [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
+
+Features
+--------
+
+* Fibonacci implementations available:
+    - Recursion
+    - Cache (which saves some recursions to avoid computation of same series again and again)
+
+* Get the code used for any of the implementation
+
+.. code:: python
+
+    from pygorithm.fibonacci import recursion as fib_recursion
+
+    code = fib_recursion.get_code()
+    print(code)
+
+* To see all the available functions in a module there is a `modules()` function available. For example,
+
+.. code:: python
+
+    >>> from pygorithm.fibonacci import modules
+    >>> modules()
+    ['cache', 'recursion']
+
+Implementations API
+-------------------
+
+* Functions and their uses
+
+.. function:: get_sequence(number)
+
+- **number**          : arbitrary integer, that need to be calculated in Fibonacci number type
+- **Return Value**    : return Fibonacci value by specified number as integer
+
+.. function:: get_code()
+
+- **Return Value**    : returns the code for the ``get_sequence()`` function

docs/Minumum spanning tree.rst

@@ -4,7 +4,6 @@ Searching
 
 Learning searching algorithms easily!
 
------------------
 Quick Start Guide
 -----------------
 
@@ -18,11 +17,10 @@ Quick Start Guide
     # pre-requisite for binary search is that the list should be sorted
     myList.sort()
 
-    # to search en element in the above list
+    # to search an element in the above list
     index = binary_search.search(myList, 7)
     print(index)
 
---------
 Features
 --------
 
@@ -32,8 +30,16 @@ Features
     - Breadth First Search (breadth_first_search)
     - Depth First Search (depth_first_search)
 
+* To see all the available functions in a module there is a `modules()` function available. For example,
+
+.. code:: python
+
+    >>> from pygorithm.searching import modules
+    >>> modules()
+    ['binary_search', 'breadth_first_search', 'depth_first_search', 'linear_search', 'quick_select']
+
 * For Searching:
-  Remember search() function takes two parameters as a sorted list and the target element to be searched.
+  Remember ``search()`` function in `binary_search` module takes two parameters as a sorted list and the target element to be searched.
 
 .. code-block:: python
 
@@ -45,7 +51,7 @@ Features
     # pre-requisite for binary search is that the list should be sorted
     myList.sort()
 
-    # to search en element in the above list
+    # to search an element in the above list
     index = binary_search.search(myList, 7)
     print(index)
 
@@ -66,3 +72,101 @@ Features
 
     # for printing the source code of bubble_sort
     print(binary_search.get_code())
+
+
+Binary Search
+-------------
+
+* Functions and their uses
+
+.. function:: binary_search.search(List, key)
+   :module: pygorithm.searching
+
+- **List**            : *Sorted* list in which the key is to be searched
+- **key**             : key to be searched in the list
+- **Return Value**    : returns the position (index) of the key if key found, else returns -1
+
+.. function:: binary_search.time_complexities()
+
+- **Return Value**    : returns time complexities (Best, Average, Worst)
+
+.. function:: binary_search.get_code()
+
+- **Return Value**    : returns the code for the ``binary_search.search()`` function
+
+Linear Search
+-------------
+
+* Functions and their uses
+
+.. function:: linear_search.search(List, key)
+
+- **List**            : the list in which item is to searched
+- **key**             : key to be searched in the list
+- **Return Value**    : returns the position (index) of the key if key found, else returns -1
+
+.. function:: linear_search.time_complexities()
+
+- **Return value**      : returns time complexities (Best, Average, Worst)
+
+.. function:: linear_search.get_code()
+
+- **Return Value**      : returns the code for the ``linear_search.search()`` function
+
+Breadth First Search
+--------------------
+
+* Functions and their uses
+
+.. function:: breadth_first_search.search(graph, startVertex)
+
+- **graph**           : takes the graph data structures with edges and vertices
+- **startVertex**     : it tells the function the vertex to start with
+- **Return Value**    : returns the `set` of bfs for the ``graph``
+
+.. function:: breadth_first_search.time_complexities()
+
+- **Return Value**    : returns time complexities
+
+.. function:: breadth_first_search.get_code()
+
+- **Return Value**    : returns the code for the ``breadth_first_search.search()`` function
+
+Depth First Search
+------------------
+
+* Functions and their uses
+
+.. function:: breadth_first_search.search(graph, start, path)
+
+- **graph**           : takes the graph data structures with edges and vertices
+- **start**           : it tells the function the vertex to start with
+- **path**            : returns the list containing the required dfs
+- **Return Value**    : returns the `list` of dfs for the ``graph``
+
+.. function:: breadth_first_search.time_complexities()
+
+- **Return Value**    : returns time complexities
+
+.. function:: breadth_first_search.get_code()
+
+- **Return Value**    : returns the code for the ``depth_first_search.search()`` function
+
+Quick Select Search
+------------------
+
+* Functions and their uses
+
+.. function:: quick_select.search(array, n)
+
+- **array**           : an unsorted array
+- **n**               : nth number to be searched in the given `array`
+- **Return Value**    : returns the nth element
+
+.. function:: quick_select.time_complexities()
+
+- **Return Value**    : returns time complexities
+
+.. function:: quick_select.get_code()
+
+- **Return Value**    : returns the code for the ``quick_select.search()`` function