ShootingStar91 / compressionstudy

Compression algorithms. For algorithm practice project course of summer 2020.
0 stars 0 forks source link

Compression study

A Java implementation of different file compression algorithms, and a study of their efficiency.

This project is a practice project by Arttu Kangas for a course at University of Helsinki.

Week reports:

How to use it

Run the program by either compiling it or creating jar with "mvn package" and running the .jar from /target/ -folder.

The user interface allows you to choose any file. I recommend one from the Test Material folder provided with the project.

To test the validity of compression and decompression, choose test and click Run. If there is no error messages, but only text "Test ready", it was successful.

To leave the compressed and decompressed files for you to examine, choose File.

To run performance tests click the last radio button and click Run. Depending on the file size and your computer, the testing might take anywhere from couple seconds to several minutes (for the 1.5MB test files that is most expected).

The results will appear on the user interface. If you run more tests, they will appear below the previous results, but when you run out of room, click Clear text button.

Command line

Run tests and create jacoco report (make sure you are in the /compressionstudy folder):

mvn test jacoco:report

You will find it from /target/site/jacoco/

Create checkstyle report to /target/site/checkstyle.html

mvn jxr:jxr checkstyle:checkstyle

Create javadocs to /target/site/apidocs/:

mvn javadoc:javadoc