Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wcygan/java-practice
java-practice
https://github.com/wcygan/java-practice
algorithms concurrency concurrent-data-structure concurrent-programming data-structures java jvm property-based-testing
Last synced: 2 days ago
JSON representation
java-practice
- Host: GitHub
- URL: https://github.com/wcygan/java-practice
- Owner: wcygan
- Created: 2022-12-09T03:29:35.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T04:19:52.000Z (14 days ago)
- Last Synced: 2024-11-01T05:18:41.240Z (14 days ago)
- Topics: algorithms, concurrency, concurrent-data-structure, concurrent-programming, data-structures, java, jvm, property-based-testing
- Language: Java
- Homepage:
- Size: 169 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Practice
Practicing Data Structures, Algorithms, Concurrency, and more in [Java](https://www.oracle.com/java/technologies/)!
## Table of Contents
- **[Cool Stuff](#cool-stuff)**
- **[Data Structures](#data-structures)**
- **[Algorithms](#algorithms)**
- **[Build and Run](#build-and-run)**
- **[Property-Based Testing with JUnit-Quickcheck](#property-based-testing-with-junit-quickcheck)**
- **[References](#references)**
## Cool Stuff
### Data Structures
1. [LRU Cache](src/main/java/io/wcygan/collections/cache/LRUCache.java)
2. [Red Black Tree](src/main/java/io/wcygan/collections/tree/LLRedBlackTree.java)
3. [Disjoint Set](src/main/java/io/wcygan/collections/set/DisjointSet.java)
4. [D-Way Heap](src/main/java/io/wcygan/collections/queue/DWayHeap.java)
5. [Graph](src/main/java/io/wcygan/collections/graph/SimpleGraph.java)
6. [ArrayBlockingQueue](src/main/java/io/wcygan/concurrent/collections/queue/ArrayBlockingQueue.java)
7. [Non-blocking Queue](src/main/java/io/wcygan/concurrent/collections/queue/NonblockingQueue.java)
8. [Non-blocking Stack](src/main/java/io/wcygan/concurrent/collections/stack/NonblockingStack.java)
9. [Thread-ID based Lock](src/main/java/io/wcygan/concurrent/locks/TIDLock.java)
### Algorithms
1. [Quick Sort](src/main/java/io/wcygan/algorithms/sorting/QuickSort.java)
2. [Merge Sort](src/main/java/io/wcygan/algorithms/sorting/MergeSort.java)
3. [Parallel Merge Sort](src/main/java/io/wcygan/algorithms/sorting/ParallelMergeSort.java)
4. [Shortest Path](src/main/java/io/wcygan/algorithms/graph/pathfinding/ShortestPath.java) (Graph)
5. [Breadth-First Search](src/main/java/io/wcygan/algorithms/graph/traversal/BreadthFirstSearch.java) (Graph)
6. [Depth-First Search](src/main/java/io/wcygan/algorithms/graph/traversal/DepthFirstSearch.java) (Graph)
## Benchmarking
Using [jmh](https://github.com/openjdk/jmh) you are able to benchmark java code.
To execute the benchmarks in `src/jmh`, run the following command:
```
$ gradle jmh
```
For example, you can see this in action in
[CacheLinesBenchmark.java](src/jmh/java/io/wcygan/algorithms/gotchas/CacheLinesBenchmark.java) where we obtain the
following results:
```
(Run on 2021 M1 Max Macbook Pro)
Benchmark Mode Cnt Score Error Units
i.w.a.gotchas.CacheLinesBenchmark.touchEveryItem ss 100 0.167 ± 0.002 ms/op
i.w.a.gotchas.CacheLinesBenchmark.touchEveryLine ss 100 0.136 ± 0.007 ms/op
```
Another example is [SortingBenchmark.java](src/jmh/java/io/wcygan/algorithms/sorting/SortingBenchmark.java) where we
compare the benchmark running time of different sorting algorithms:
```
Benchmark Mode Cnt Score Error Units
i.w.a.sorting.SortingBenchmark.classicSort ss 100 12.142 ± 0.081 ms/op
i.w.a.sorting.SortingBenchmark.heapsort ss 100 13.768 ± 0.073 ms/op
i.w.a.sorting.SortingBenchmark.mergesort ss 100 16.790 ± 0.112 ms/op
i.w.a.sorting.SortingBenchmark.parallelMergesort ss 100 17.958 ± 0.835 ms/op
i.w.a.sorting.SortingBenchmark.parallelStandardSort ss 100 2.338 ± 0.091 ms/op
i.w.a.sorting.SortingBenchmark.quicksort ss 100 12.859 ± 0.088 ms/op
i.w.a.sorting.SortingBenchmark.standardSort ss 100 13.733 ± 0.061 ms/op
```
## Build and Run
This project uses [Gradle](https://gradle.org/install/). Make sure that you
have [Java](https://java.com/en/download/help/download_options.html) installed.
To run the entire suite of tests:
```
$ ./gradlew test
```
To run a specific test class:
```
$ ./gradlew test --tests
```
For example, I can run the tests
at [WeightedShortestPathTest](src/test/java/io/wcygan/algorithms/graph/pathfinding/WeightedShortestPathTest.java)
with:
```
$ ./gradlew test --tests WeightedShortestPathTest
```
Further, we can a **single** test by specifying its fully qualified path like so:
```
$ ./gradlew test --tests io.wcygan.algorithms.graph.pathfinding.WeightedShortestPathTest.testWeightedShortestPath
```
### Building a jar file
Builds a jar containing **all dependencies** of the project
```
$ ./gradlew shadowJar
```
Builds a jar containing **only the application classes** from the project
```
$ ./gradlew jar
```
## Property-Based Testing with JUnit-Quickcheck
Property-Based Testing allows you to test the programs you write by feeding a program randomly generated inputs.
See [Getting Started with JUnit-Quickcheck](https://pholser.github.io/junit-quickcheck/site/1.0/usage/getting-started.html)
for more details.
Once you've written a property-based test (like
[SortingQuickCheck](src/test/java/io/wcygan/algorithms/sorting/SortingQuickCheckTest.java))
you can execute it in isolation just as we did before:
```
$ ./gradlew test --tests io.wcygan.algorithms.sorting.SortingQuickCheckTest.testSortingAlgorithms
```
You can configure the execution of your property-based test using the elements of
the [@Property annotation](https://pholser.github.io/junit-quickcheck/site/1.0/junit-quickcheck-core/apidocs/com/pholser/junit/quickcheck/Property.html)
. For example, you can write `@Property(trials = 10)` to have the test execute 10 times.
## References
I'm using the following material as a reference:
1. [Introduction to Algorithms](https://mitpress.mit.edu/books/introduction-algorithms-third-edition)
2. [Java Concurrency in Practice](https://jcip.net/)
3. [The Art of Multiprocessor Programming](https://www.oreilly.com/library/view/the-art-of/9780123705914/)
4. [Effective Java](https://www.oreilly.com/library/view/effective-java/9780134686097/)