Merge pull request #1 from OmkarPathak/master

Pull from upstream

Author: Tjstretchalot

docs/Math.rst

@@ -24,6 +24,11 @@ Features
 * Algorithms available:
     - LCM (lcm)
     - Sieve of Eratostenes (sieve_of_eratosthenes)
+    - Factorial
+    - Binary To decimal conversion
+    - Decimal to binary conversion
+    - Hex To decimal conversion
+    - Decimal to hex conversion
 
 * To see all the available functions in a module there is a `modules()` function available. For example,
 
@@ -70,3 +75,43 @@ Sieve of Eratostenes
 .. function:: sieve_of_eratostenes.get_code()
 
 - **Return Value**    : returns the code for the ``sieve_of_eratostenes.sieve_of_eratostenes()`` function
+
+Factorial
+---------
+
+* Functions and their uses
+
+.. function:: factorial.factorial(number)
+
+- **number**          : integer number of which factorial is to be found
+- **Return Value**    : returns the integer of factorial of the number
+
+.. function:: factorial.get_code()
+
+- **Return Value**    : returns the code for the ``factorial.factorial()`` function
+
+
+Conversion
+----------
+
+* Functions and their uses
+
+.. function:: conversion.decimal_to_binary(number)
+
+- **number**          : decimal number in string or integer format
+- **Return Value**    : returns the string of equivalent binary number
+
+.. function:: conversion.binary_to_decimal(number)
+
+- **number**          : binary number in string or integer format
+- **Return Value**    : returns the integer of equivalent decimal number
+
+.. function:: conversion.decimal_to_hex(number)
+
+- **number**          : decimal number in string or integer format
+- **Return Value**    : returns the string of equivalent hex number
+
+.. function:: conversion.hex_to_decimal(number)
+
+- **number**          : hex number in string or integer format
+- **Return Value**    : returns the integer of equivalent decimal number

docs/Pathing.rst

@@ -91,12 +91,12 @@ Binary Search
 
 * Functions and their uses
 
-.. function:: binary_search.search(List, key)
+.. function:: binary_search.search(_list, target)
    :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
+- **_list**            : *Sorted* list in which the target is to be searched
+- **target**             : target to be searched in the list
+- **Return Value**    : returns the position (index) of the target if target found, else returns False
 
 .. function:: binary_search.time_complexities()
 
@@ -111,11 +111,11 @@ Linear Search
 
 * Functions and their uses
 
-.. function:: linear_search.search(List, key)
+.. function:: linear_search.search(_list, target)
 
-- **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
+- **_list**            : the list in which item is to searched
+- **target**             : target to be searched in the list
+- **Return Value**    : returns the position (index) of the target if target found, else returns False
 
 .. function:: linear_search.time_complexities()
 
@@ -182,3 +182,23 @@ Quick Select Search
 .. function:: quick_select.get_code()
 
 - **Return Value**    : returns the code for the ``quick_select.search()`` function
+
+Interpolation Search
+--------------------
+
+* Functions and their uses
+
+.. function:: interpolation_search.search(_list, target)
+   :module: pygorithm.searching
+
+- **_list**           : *Sorted* list in which the target is to be searched
+- **target**          : target to be searched in the list
+- **Return Value**    : returns the position (index) of the target if target found, else returns False
+
+.. function:: interpolation_search.time_complexities()
+
+- **Return Value**    : returns time complexities (Best, Average, Worst)
+
+.. function:: interpolation_search.get_code()
+
+- **Return Value**    : returns the code for the ``interpolation_search.search()`` function

docs/Searching.rst

@@ -0,0 +1,102 @@
+"""
+Author: OMKAR PATHAK
+Created On: 23 August 2017
+"""
+
+def decimal_to_binary(number):
+    '''
+        This function calculates the binary of the given decimal number
+        :param number: decimal number in string or integer format
+        :return : string of the equivalent binary number
+
+        Algo:
+        1. Divide the decimal number by 2. Treat the division as an integer division.
+        2. Write down the remainder (in binary).
+        3. Divide the result again by 2. Treat the division as an integer division.
+        4. Repeat step 2 and 3 until result is 0.
+        5. The binary value is the digit sequence of the remainders from the last to first.
+    '''
+    if isinstance(number, str):
+        number = int(number)
+    binary = []
+    while number >= 1:
+        remainder = number % 2
+        binary.append(remainder)
+        number = number // 2
+
+    return ''.join(map(str, binary[::-1]))
+
+def binary_to_decimal(number):
+    '''
+        This function calculates the decimal of the given binary number
+        :param number: decimal number in string or integer format
+        :return : integer of the equivalent decimal number
+
+        Algo:
+        1. Get the last digit of the binary number.
+        2. Multiply the current digit with (2^power), store the result.
+        3. Increment power by 1.
+        4. Repeat from step 2 until all digits have been multiplied.
+        5. Sum the result of step 2 to get the answer number.
+    '''
+    decimal = []
+    number = list(str(number)[::-1])
+    for i in range(len(number)):
+        decimal.append(int(number[i]) * (2 ** i))
+
+    return sum(decimal)
+
+def decimal_to_hex(number):
+    '''
+        This function calculates the hex of the given decimal number
+        :param number: decimal number in string or integer format
+        :return : string of the equivalent hex number
+
+        Algo:
+        1. Divide the decimal number by 16. Treat the division as an integer division.
+        2. Write down the remainder (in hexadecimal).
+        3. Divide the result again by 16. Treat the division as an integer division.
+        4. Repeat step 2 and 3 until result is 0.
+        5. The hex value is the digit sequence of the remainders from the last to first.
+    '''
+    if isinstance(number, str):
+        number = int(number)
+    hexadec = []
+    hex_equivalents = {10:'A', 11:'B', 12:'C', 13:'D', 14:'E', 15:'F'}
+    while number >= 1:
+        remainder = number % 16
+        if remainder < 10:
+            hexadec.append(remainder)
+        elif remainder >= 10:
+            hexadec.append(hex_equivalents[remainder])
+
+        number = number // 16
+
+    return ''.join(map(str, hexadec[::-1]))
+
+def hex_to_decimal(number):
+    '''
+        This function calculates the decimal of the given hex number
+        :param number: hex number in string or integer format
+        :return : integer of the equivalent decimal number
+
+        Algo:
+        1. Get the last digit of the hex number.
+        2. Multiply the current digit with (16^power), store the result.
+        3. Increment power by 1.
+        4. Repeat from step 2 until all digits have been multiplied.
+        5. Sum the result of step 2 to get the answer number.
+    '''
+    decimal = []
+    decimal_equivalents = {'A':10, 'B':11, 'C':12, 'D':13, 'E':14, 'F':15}
+    number = list(str(number)[::-1])
+    for i in range(len(number)):
+        try:
+            if int(number[i]) < 10:
+                decimal.append(int(number[i]) * (16 ** i))
+        except ValueError:
+            decimal.append(decimal_equivalents[number[i]] * (16 ** i))
+
+    return sum(decimal)
+
+print(hex_to_decimal('7DE'))

pygorithm/math/conversion.py

@@ -0,0 +1,19 @@
+"""
+Author: OMKAR PATHAK
+Created On: 22 August 2017
+"""
+
+def factorial(number):
+    ''' This function calculates the factorial of a number '''
+    if not isinstance(number, int):
+        raise Exception('Enter an integer number to find the factorial')
+    if number == 1 or number == 0:
+        return 1
+    else:
+        return number * factorial(number - 1)
+
+def get_code():
+    """
+    returns the code for the factorial function
+    """
+    return inspect.getsource(factorial)

pygorithm/math/factorial.py

@@ -0,0 +1,65 @@
+"""
+Author: SHARAD BHAT
+Created On: 22nd August 2017
+
+ - Best O(1)
+ - Average O(log(logn))
+ - Worst O(n)
+"""
+
+import inspect
+
+def search(_list, target):
+    """
+    This function performs an interpolation search
+    on a sorted list and returns the index
+    of item if successful else returns False
+
+    :param _list: list to search
+    :param target: item to search for
+    :return: index of item if successful else returns False
+    """
+
+    if type(_list) is not list:
+        raise TypeError("interpolation search only accepts lists, not {}".format(str(type(_list))))
+
+    # First element
+    low = 0
+    # Last element
+    high = len(_list) - 1
+
+    # List is assumed to be sorted
+    while low <= high and target >= _list[low] and target <= _list[high]:
+        position = low + int(((float(high - low) / (_list[high] - _list[low])) * (target - _list[low])))
+
+        if _list[position] == target:
+            return position
+
+        # If target is greater, search in right half
+        if _list[position] < target:
+            low = position + 1
+
+        # If target is smaller, search in left half
+        else:
+            high = position - 1
+
+    return False
+
+
+
+def time_complexities():
+    """
+    Return information on functions
+    time complexity
+    :return: string
+    """
+    return "Best Case: O(1), Average Case: O(log(logn)), Worst Case: O(logn)"
+
+
+def get_code():
+    """
+    easily retrieve the source code
+    of the function
+    :return: source code
+    """
+    return inspect.getsource(search)