Alphabetically and pruning of algorithms

Author: lucashc

.gitignore

@@ -1,4 +1,2 @@
 main_mod.tex
 build/*
-main.pdf
-*.pdf

algorithms/KruskalMST.py

@@ -1,5 +1,5 @@
-#Newton-Raphson
-## \note Algorithm to find zeros
+# Newton-Raphson
+## \note Algorithm to find zeros of an arbitrary function
 def derivative(f, x, h):
       return (f(x+h) - f(x-h)) / (2.0*h)  # might want to return a small non-zero if ==0
 
@@ -17,4 +17,3 @@ def solve(f, x0, h):
     return nextX
 
 xFound = solve(quadratic, 5, 0.01)    # call the solver
-print "solution: x = ", xFound        # print the result

algorithms/Newton_R_1dim.py

@@ -1,5 +1,5 @@
 # Kosaraju's algorithm
-## \note Algorithm that finds all stringly connected components
+## \note Algorithm that finds all strongly connected components
 from collections import defaultdict
 # This class represents a directed graph using adjacency list representation
 class Graph:

algorithms/SCC.py

@@ -1,4 +1,5 @@
 # Coin sum
+## \note Expects a list with the coin values, and repetitions if there are more coins with this value.
 def recMC(coinValueList,change):
    minCoins = change
    if change in coinValueList:

algorithms/coin_sum.py

@@ -1,5 +1,5 @@
 # Dijkstra's algorithm
-## \note Replacing heapq with a priorityqueue from the \ms{queue}-package might be necessary
+## \note \ms{nodes} is a list with node $i$ at index $i$ and then this node contains a list of tuples that indicate the length of the edge and whereto.
 def dijkstra(a, b, nodes):
     import heapq
     visited = {}

algorithms/dijkstra.py

@@ -1,5 +1,5 @@
 # Fenwick Tree
-## \note Efficiently calculate sums and update elements
+## \note Efficiently calculate sums and update elements. The sum is taken from $0$ up to index \ms{r}. Updates happen with deltas and not with setting.
 class FenwickSum:
     def __init__(self, items):
         self.items = [0 for _ in range(len(items))]

algorithms/fenwick.py

@@ -1,4 +1,5 @@
 # Topological sort
+## \note \ms{graph} is an adjacency matrix with directed edges
 def topological_sort(graph):
     from collections import deque
     indeg = [0] * len(graph)

algorithms/intersection_line_segments.cpp

@@ -1,4 +1,5 @@
 # Union Find
+## \note Union find as used in Kruskal's minimum spanning tree.
 class UnionFind:
 
     def __init__(self, nodes):

algorithms/partition.py

@@ -1,12 +1,12 @@
 #!/bin/env python
 import sys
 from os import listdir
-from os.path import isfile, join, getsize
+from os.path import isfile, join, getsize, basename
 
 # Get files in directory
 algorithm_dir = sys.argv[1]
 filelist = [join(algorithm_dir, f) for f in listdir(algorithm_dir) if isfile(join(algorithm_dir, f))]
-filelist.sort(key=lambda x: getsize(x))
+filelist.sort(key=lambda x: basename(x))
 
 def get_lang(f):
     if f[-3:] == ".py": return "Python"