algorithm-prep 0.0.2

Programming algorithm training package for programmers and students

#Algorithm Training for Python

This project is for programmers and students to practice the programming of algorithms. The test cases and example implementation are included and ready to use.

Installation

$ pip install algorithm-training

Usage

Test your own algorithm

Let's take sorting algorithm as an example. You can create your own algorithm in a function, then add a main block to test your function.

from algorithm_training import test
from algorithm_training.classic.sort import test_cases

def my_sort_function(arr):
    # my implementation
    return arr

if __name__ == '__main__':
    test(my_sort_function, test_cases)

Benchmark your algorithm against reference implementations

from algorithm_training import benchmark
from algorithm_training.classic.sort import algorithms, test_cases

def my_sort_function(arr):
    # my implementation
    return arr

if __name__ == '__main__':
    benchmark(my_sort_function, algorithms, test_cases)

Implemented Algorithms

Sort

Following import statement should be included in your code.

from algorithm_prep import test, benchmark
from algorithm_prep.classic.sort import test_cases, algorithms

Define your sorting function

def your_sort_algorithm(arr):
	"""
    :type arr: List[int]
    :rtype: List[int]
    """
	# your codes go here

To test the function

test(your_sort_algorithm, test_cases)

To benchmark your algorithm

benchmark(your_sort_algorithm, algorithms, test_cases)

Following reference algorithms are implemented for benchmark

• Bubble Sort
• Insertion Sort
• Merge Sort
• Quick Sort
• Heap Sort
• Radix Sort

String Search