Algorithms & data structures project

Algorithms and data structures are fundamental to efficient code and good software design. Creating and designing excellent algorithms is required for being an exemplary programmer. This repository's goal is to demonstrate how to correctly implement common data structures and algorithms in the simplest and most elegant ways.

DD2480 - Group 2 Paragraph

DIY Branch Coverage tool

Use the BranchCoverageAnalyser to mark all the branches in you function. See the getTreeDisplay() in TreePrinter.java for a full example how it should be used (The example is not perfect however, many branches are not checked). Remember to also put all the branch ids that you create in the diy-branch-coverage-control.txt file.

Pro tip! In order to also cover conditional expression, you can use the BranchCoverageAnalyser.markCoveredValue() function. See line 100 in getTreeDisplay().

To see the statistics report run gradle build first and then execute com.williamfiset.algorithms.utils.CoverageStatistics.main(). The report will be generated in build/reports/DIY-Coverage-Report.txt

Lizard Results

NLOC	CCN	token	PARAM	length	location
58	17	551	1	81	TreeIsomorphismWithBfs::encodeTree@63-143@./src/main/java/com/williamfiset/algorithms/graphtheory/treealgorithms/TreeIsomorphismWithBfs.java
55	23	469	0	69	TspDynamicProgrammingIterative::solve@55-123@./src/main/java/com/williamfiset/algorithms/graphtheory/TspDynamicProgrammingIterative.java
26	17	399	0	26	SubstringVerificationSuffixArray::SuffixArray::construct@56-81@./src/main/java/com/williamfiset/algorithms/strings/SubstringVerificationSuffixArray.java
26	17	399	0	26	LongestCommonPrefixArray::SuffixArray::construct@54-79@./src/main/java/com/williamfiset/algorithms/strings/LongestCommonPrefixArray.java
26	17	399	0	26	LongestRepeatedSubstring::SuffixArray::construct@58-83@./src/main/java/com/williamfiset/algorithms/strings/LongestRepeatedSubstring.java
22	31	290	3	66	Solution::f@15-80@./src/main/java/com/williamfiset/algorithms/dp/examples/domino-and-tromino-tiling/Solution.java
35	20	593	4	68	LineSegmentLineSegmentIntersection::lineSegmentLineSegmentIntersection@41-108@./src/main/java/com/williamfiset/algorithms/geometry/LineSegmentLineSegmentIntersection.java
113	91	1384	4	150	QuadTree::Node::knn@166-315@./src/main/java/com/williamfiset/algorithms/datastructures/quadtree/QuadTree.java
30	17	442	0	31	SuffixArrayFast::construct@32-62@./src/main/java/com/williamfiset/algorithms/datastructures/suffixarray/SuffixArrayFast.java
83	24	468	3	93	GenericSegmentTree::GenericSegmentTree@165-257@./src/main/java/com/williamfiset/algorithms/datastructures/segmenttree/GenericSegmentTree.java
58	16	318	0	68	GenericSegmentTree2::GenericSegmentTree2@177-244@./src/main/java/com/williamfiset/algorithms/datastructures/segmenttree/GenericSegmentTree2.java
82	27	736	1	97	TreePrinter::getTreeDisplay@23-119@./src/main/java/com/williamfiset/algorithms/datastructures/utils/TreePrinter.java
72	21	611	0	101	GenericSegmentTreeTest::testAllFunctionCombinations@222-322@./src/test/java/com/williamfiset/algorithms/datastructures/segmenttree/GenericSegmentTreeTest.java

Total nloc	Avg.NLOC	AvgCCN	Avg.token	Fun Cnt	Warning cnt	Fun Rt	nloc Rt
28870	9.4	2.5	84.5	2696	13	0.00	0.03

Statement of contributions

• Lara: chose lineSegmentLineSegmentIntersection() in LineSegmentLineSegmentIntersection.java and construct() in SubstringVerificationSuffixArray.java, manually counted CC of lineSegmentLineSegmentIntersection(), wrote four tests for lineSegmentLineSegmentIntersection(), created a refactoring plan and refactored lineSegmentLineSegmentIntersection(), documented the process of this assignment.
• Adam Jonsson: chose getTreeDisplay(), in TreePrinter.java.
  • Created 4+ tests to increase coverage
  • Manually counted CC
  • Create a refactoring plan and refactored
  • documented the process of this assignment.
  • Did also create the DIY coverage analyser
• Isak: chose encodeTree() in TreeIsomorphismWithBfs. Manually counted CC of encodeTree(). Wrote four tests for encodeTree(). Wrote a refactoring plan for encodeTree(). Contributed to the assignment report.
• Tony: Improved GenericSegmentTree() in GenericSegmentTree.java by writing 4 tests and a refactoring plan, as well as manually counted the CC for that method and knn() in QuadTree.java.
• Hovig: chose knn() in QuadTree.java
  • Created 4+ tests to increase coverage.
  • Manually counted CC for this function and two other.
  • Create a refactoring plan and refactored achieving complexity reduction of >35%.
  • Developed the statistic tool for the DIY coverage analyser.
  • Documented the usage of the DIY tool in README.md.
  • Implemented the DIY coverage tool.

Contributing

This repository is contribution friendly 😃. If you'd like to add or improve an algorithm, your contribution is welcome! Please be sure to checkout the Wiki for instructions.

Other programming languages?

This repository provides algorithm implementations in Java, however there are other forks that provide implementations in other languages, most notably:

• C++/Python: https://github.com/akzare/Algorithms
• Rust: https://github.com/TianyiShi2001/Algorithms

Running an algorithm implementation

To compile and run any of the algorithms here, you need at least JDK version 8. Gradle can make things more convenient for you, but it is not required.

Running with Gradle (recommended)

This project supports the Gradle Wrapper. The Gradle wrapper automatically downloads Gradle at the first time it runs, so expect a delay when running the first command below.

If you are on Windows, use gradlew.bat instead of ./gradlew below.

Run a single algorithm like this:

./gradlew run -Palgorithm=<algorithm-subpackage>.<algorithm-class>

Alternatively, you can run a single algorithm specifying the full class name

./gradlew run -Pmain=<algorithm-fully-qualified-class-name>

For instance:

./gradlew run -Palgorithm=search.BinarySearch

or

./gradlew run -Pmain=com.williamfiset.algorithms.search.BinarySearch

Compiling and running with only a JDK

Create a classes folder

cd Algorithms
mkdir classes

Compile the algorithm

javac -sourcepath src/main/java -d classes src/main/java/ <relative-path-to-java-source-file>

Run the algorithm

java -cp classes <class-fully-qualified-name>

Example

$ javac -d classes -sourcepath src/main/java src/main/java/com/williamfiset/algorithms/search/BinarySearch.java
$ java -cp classes com.williamfiset.algorithms.search.BinarySearch

Data Structures

• 🎥 Balanced Trees
  • AVL Tree (recursive)
  • Red Black Tree (recursive)
• 🎥 Binary Search Tree
• Splay Tree
• 🎥 Dynamic Array
  • Dynamic array (integer only, fast)
  • Dynamic array (generic)
• 🎥 Fenwick Tree
  • Fenwick Tree (range query, point updates)
  • Fenwick Tree (range update, point query)
• Fibonacci Heap
• 🎥 Hashtable
  • Hashtable (double hashing)
  • Hashtable (linear probing)
  • Hashtable (quadratic probing)
  • Hashtable (separate chaining)
• 🎥 Linked List
• 🎥 Priority Queue
  • Min Binary Heap
  • Min Indexed Binary Heap (sorted key-value pairs, similar to hash-table)
  • Min D-Heap
  • 🎥 Min Indexed D-Heap (sorted key-value pairs, similar to hash-table)
• 🎥 Queue
  • Queue (integer only, fixed size, fast)
  • Queue (linked list, generic)
• Segment Tree
  • Segment tree (array based, compact)
  • Segment tree (pointer implementation)
• 🎥 Sparse Table
• 🎥 Stack
  • Stack (integer only, fixed size, fast)
  • Stack (linked list, generic)
  • Stack (array, generic)
• 🎥 Suffix Array
  • Suffix Array (O(n²logn) construction)
  • Suffix Array (O(nlog²(n)) construction)
  • Suffix Array (O(nlog(n)) construction)
• Trie
• 🎥 Union Find

Dynamic Programming

Dynamic Programming Classics

• Coin change problem - O(nW)
• Edit distance - O(nm)
• 🎥 Knapsack 0/1 - O(nW)
• Knapsack unbounded (0/∞) - O(nW)
• Maximum contiguous subarray - O(n)
• Longest Common Subsequence (LCS) - O(nm)
• Longest Increasing Subsequence (LIS) - O(n²)
• Longest Palindrome Subsequence (LPS) - O(n²)
• 🎥 Traveling Salesman Problem (dynamic programming, iterative) - O(n²2ⁿ)
• Traveling Salesman Problem (dynamic programming, recursive) - O(n²2ⁿ)
• Minimum Weight Perfect Matching (iterative, complete graph) - O(n²2ⁿ)

Dynamic Programming Problem Examples

Adhoc

• 🎥 Magic Cows
• 🎥 Narrow Art Gallery

Tiling problems

• 🎥 Tiling Dominoes
• 🎥 Tiling Dominoes and Trominoes
• 🎥 Mountain Scenes

Geometry

• Angle between 2D vectors - O(1)
• Angle between 3D vectors - O(1)
• Circle-circle intersection point(s) - O(1)
• Circle-line intersection point(s) - O(1)
• Circle-line segment intersection point(s) - O(1)
• Circle-point tangent line(s) - O(1)
• Closest pair of points (line sweeping algorithm) - O(nlog(n))
• Collinear points test (are three 2D points on the same line) - O(1)
• Convex hull (Graham Scan algorithm) - O(nlog(n))
• Convex hull (Monotone chain algorithm) - O(nlog(n))
• Convex polygon area - O(n)
• Convex polygon cut - O(n)
• Convex polygon contains points - O(log(n))
• Coplanar points test (are four 3D points on the same plane) - O(1)
• Line class (handy infinite line class) - O(1)
• Line-circle intersection point(s) - O(1)
• Line segment-circle intersection point(s) - O(1)
• Line segment to general form (ax + by = c) - O(1)
• Line segment-line segment intersection - O(1)
• Longitude-Latitude geographic distance - O(1)
• Point is inside triangle check - O(1)
• Point rotation about point - O(1)
• Triangle area algorithms - O(1)
• [UNTESTED] Circle-circle intersection area - O(1)
• [UNTESTED] Circular segment area - O(1)

Graph theory

Tree algorithms

• 🎥 Rooting an undirected tree - O(V+E)
• 🎥 Identifying isomorphic trees - O(?)
• 🎥 Tree center(s) - O(V+E)
• Tree diameter - O(V+E)
• 🎥 Lowest Common Ancestor (LCA, Euler tour) - O(1) queries, O(nlogn) preprocessing

Network flow

• Bipartite graph verification (adjacency list) - O(V+E)
• 🎥 Max flow & Min cut (Ford-Fulkerson with DFS, adjacency list) - O(fE)
• Max flow & Min cut (Ford-Fulkerson with DFS, adjacency matrix) - O(fV²)
• 🎥 Max flow & Min cut (Edmonds-Karp, adjacency list) - O(VE²)
• 🎥 Max flow & Min cut (Capacity scaling, adjacency list) - O(E²log₂(U))
• 🎥 Max flow & Min cut (Dinic's, adjacency list) - O(EV²) or O(E√V) for bipartite graphs
• Maximum Cardinality Bipartite Matching (augmenting path algorithm, adjacency list) - O(VE)
• Min Cost Max Flow (Bellman-Ford, adjacency list) - O(E²V²)
• Min Cost Max Flow (Johnson's algorithm, adjacency list) - O(E²Vlog(V))

Main graph theory algorithms

• Articulation points/cut vertices (adjacency list) - O(V+E)
• Bellman-Ford (edge list, negative cycles, fast & optimized) - O(VE)
• 🎥 Bellman-Ford (adjacency list, negative cycles) - O(VE)
• Bellman-Ford (adjacency matrix, negative cycles) - O(V³)
• 🎥 Breadth first search (adjacency list) - O(V+E)
• Breadth first search (adjacency list, fast queue) - O(V+E)
• Bridges/cut edges (adjacency list) - O(V+E)
• Find connected components (adjacency list, union find) - O(Elog(E))
• Find connected components (adjacency list, DFS) - O(V+E)
• Depth first search (adjacency list, iterative) - O(V+E)
• Depth first search (adjacency list, iterative, fast stack) - O(V+E)
• 🎥 Depth first search (adjacency list, recursive) - O(V+E)
• 🎥 Dijkstra's shortest path (adjacency list, lazy implementation) - O(Elog(V))
• 🎥 Dijkstra's shortest path (adjacency list, eager implementation + D-ary heap) - O(Elog_E/V(V))
• 🎥 Eulerian Path (directed edges) - O(E+V)
• 🎥 Floyd Warshall algorithm (adjacency matrix, negative cycle check) - O(V³)
• Graph diameter (adjacency list) - O(VE)
• 🎥 Kahn's algorithm (topological sort, adjacency list) - O(E+V)
• Kruskal's min spanning tree algorithm (edge list, union find) - O(Elog(E))
• 🎥 Kruskal's min spanning tree algorithm (edge list, union find, lazy sorting) - O(Elog(E))
• 🎥 Prim's min spanning tree algorithm (lazy version, adjacency list) - O(Elog(E))
• Prim's min spanning tree algorithm (lazy version, adjacency matrix) - O(V²)
• 🎥 Prim's min spanning tree algorithm (eager version, adjacency list) - O(Elog(V))
• Steiner tree (minimum spanning tree generalization) - O(V³ + V² _ 2^T + V _ 3^T)
• 🎥 Tarjan's strongly connected components algorithm (adjacency list) - O(V+E)
• 🎥 Topological sort (acyclic graph, adjacency list) - O(V+E)
• Topological sort (acyclic graph, adjacency matrix) - O(V²)
• Traveling Salesman Problem (brute force) - O(n!)
• 🎥 Traveling Salesman Problem (dynamic programming, iterative) - O(n²2ⁿ)
• Traveling Salesman Problem (dynamic programming, recursive) - O(n²2ⁿ)

Linear algebra

• Freivald's algorithm (matrix multiplication verification) - O(kn²)
• Gaussian elimination (solve system of linear equations) - O(cr²)
• Gaussian elimination (modular version, prime finite field) - O(cr²)
• Linear recurrence solver (finds nth term in a recurrence relation) - O(m³log(n))
• Matrix determinant (Laplace/cofactor expansion) - O((n+2)!)
• Matrix inverse - O(n³)
• Matrix multiplication - O(n³)
• Matrix power - O(n³log(p))
• Square matrix rotation - O(n²)

Mathematics

• [UNTESTED] Chinese remainder theorem
• Prime number sieve (sieve of Eratosthenes) - O(nlog(log(n)))
• Prime number sieve (sieve of Eratosthenes, compressed) - O(nlog(log(n)))
• Totient function (phi function, relatively prime number count) - O(n^1/4)
• Totient function using sieve (phi function, relatively prime number count) - O(nlog(log(n)))
• Extended euclidean algorithm - ~O(log(a + b))
• Greatest Common Divisor (GCD) - ~O(log(a + b))
• Fast Fourier transform (quick polynomial multiplication) - O(nlog(n))
• Fast Fourier transform (quick polynomial multiplication, complex numbers) - O(nlog(n))
• Primality check - O(√n)
• Primality check (Rabin-Miller) - O(k)
• Least Common Multiple (LCM) - ~O(log(a + b))
• Modular inverse - ~O(log(a + b))
• Prime factorization (pollard rho) - O(n^1/4)
• Relatively prime check (coprimality check) - ~O(log(a + b))

Other

• Bit manipulations - O(1)
• List permutations - O(n!)
• 🎥 Power set (set of all subsets) - O(2ⁿ)
• Set combinations - O(n choose r)
• Set combinations with repetition - O((n+r-1) choose r)
• Sliding Window Minimum/Maximum - O(1)
• Square Root Decomposition - O(1) point updates, O(√n) range queries
• Unique set combinations - O(n choose r)
• Lazy Range Adder - O(1) range updates, O(n) to finalize all updates

Search algorithms

• Binary search (real numbers) - O(log(n))
• Interpolation search (discrete discrete) - O(n) or O(log(log(n))) with uniform input
• Ternary search (real numbers) - O(log(n))
• Ternary search (discrete numbers) - O(log(n))

Sorting algorithms

• Bubble sort - O(n²)
• Bucket sort - Θ(n + k)
• Counting sort - O(n + k)
• Heapsort - O(nlog(n))
• Insertion sort - O(n²)
• Mergesort - O(nlog(n))
• Quicksort (in-place, Hoare partitioning) - Θ(nlog(n))
• Quicksort3 (Dutch National Flag algorithm) - Θ(nlog(n))
• Selection sort - O(n²)
• Radix sort - O(n*w)

String algorithms

• Booth's algorithm (finds lexicographically smallest string rotation) - O(n)
• Knuth-Morris-Pratt algorithm (finds pattern matches in text) - O(n+m)
• Longest Common Prefix (LCP) array - O(nlog(n)) bounded by SA construction, otherwise O(n)
• 🎥 Longest Common Substring (LCS) - O(nlog(n)) bounded by SA construction, otherwise O(n)
• 🎥 Longest Repeated Substring (LRS) - O(nlog(n))
• Manacher's algorithm (finds all palindromes in text) - O(n)
• Rabin-Karp algorithm (finds pattern match positions in text) - O(n+m)
• Substring verification with suffix array - O(nlog(n)) SA construction and O(mlog(n)) per query

License

This repository is released under the MIT license. In short, this means you are free to use this software in any personal, open-source or commercial projects. Attribution is optional but appreciated.