Code Monkey home page Code Monkey logo

inf8770-tp1's Introduction

INF8770 - TP1

Repository for the first project of the INF8770 course at Polytechnique Montréal. It consists in implementing some basic lossless compression algorithms.

Dependencies and run conditions

It uses Rust as the main programming language, so you need to have it installed in your machine. You can install it by following the instructions at Rust's official website. The program should run with cargo run --release. It was tested on Arch Linux with Rust 1.76.0. The run options are:

cargo run --release -- [true | false] [rle | lzw]

  • The first argument is a boolean that indicates if the program should run a single instance of the program or a batch of tests.
    • If it is true, the program will run a single instance of the algorithm chosen in the second argument. It will display the compression rate and the time taken.
    • If it is false, the program will run a batch of tests for the chosen algorithm, 1000 runs for the text data and 100 for the images.
  • The second argument is the algorithm to be used. It can be rle or lzw for the corresponding algorithms.

Directory structure

  • src/: Source code of the project.
    • main.rs: Main file of the project. It contains the command line interface and the main function.
    • utils.rs: Module that contains some utility functions.
    • rle.rs: Module that contains the Run-Length Encoding algorithm.
    • lzw.rs: Module that contains the Lempel-Ziv-Welch algorithm.
  • data/: Directory that contains the data used for the tests.
    • text: Directory that contains the text data.
    • images: Directory that contains the images data.
  • docs/: Directory that contains the documentation of the project. It is written in LaTeX and it is compiled to a PDF file.

inf8770-tp1's People

Contributors

bassetmatt avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.