Rust Advent of Code 2024 Solution 🦀

Welcome to the Rust-based solutions for the Advent of Code 2024! This repository contains efficient and idiomatic Rust code to tackle the intriguing puzzles presented during the event. Additionally, we provide benchmarking tools to measure and optimize the performance of each solution.

Getting Started 🚀

To begin, ensure you have a working Rust installation. If Rust isn't installed on your system, you can follow the instructions on the official Rust installation page. Verify your installation with the following command:

rustc --version

For a seamless Rust development experience, especially if you're using Visual Studio Code, consider installing these extensions:

• Rust-analyzer for advanced code analysis and smart code completion.
• even better TOML for TOML syntax highlighting and formatting.

Running the Solutions ⚙️

To execute the solutions, first clone the repository and navigate into the project directory:

git clone <Repository-URL>
cd <Repository-Name>

Run all the solutions with:

cargo run

To execute a specific day's solution, supply the day number as a CLI argument:

cargo run -- <day>

Valid CLI arguments include:

• 1 | one to run the solution for Day 1.
• ex | example to run the example solution.

For optimized performance, append the --release flag to run the solutions in release mode:

cargo run --release -- <day>

Workflow 🛠️

This project is structured to help you focus on solving the puzzles. Each day's challenge has a corresponding skeleton structure that requires implementing the following methods:

fn new() -> Self;

fn part_one(&self) -> impl std::fmt::Display;

fn part_two(&self) -> impl std::fmt::Display;

You'll find the solution templates in the src/implementation directory. An example.rs is also provided to demonstrate a sample solution.

Testing 🧪

To ensure your solutions work as expected, you can write tests and run them with:

cargo test

Benchmarking 💪

Performance matters! This repository includes benchmarks for all solutions. To run the benchmarks and generate reports:

sh ./bench.sh

Benchmarking results are located in the target/criterion directory of the repository.

Benchmark Results

Day	Solved	Part 1 runtime	Part 2 runtime
1		$${\color{green}\text{93.16 μs}}$$	$${\color{green}\text{94.49 μs}}$$
2		$${\color{green}\text{1.78 μs}}$$	$${\color{green}\text{3.98 μs}}$$
3		$${\color{green}\text{25.53 μs}}$$	$${\color{green}\text{11.86 μs}}$$
4		$${\color{green}\text{122.72 μs}}$$	$${\color{green}\text{63.43 μs}}$$
5		$${\color{green}\text{70.13 μs}}$$	$${\color{green}\text{167.47 μs}}$$
6		$${\color{green}\text{165.00 μs}}$$	$${\color{yellow}\text{7.95 ms}}$$
7		$${\color{green}\text{34.94 μs}}$$	$${\color{green}\text{92.19 μs}}$$
8		$${\color{green}\text{418.29 μs}}$$	$${\color{green}\text{469.01 μs}}$$
9		$${\color{green}\text{538.76 μs}}$$	$${\color{yellow}\text{134.80 ms}}$$
10		$${\color{green}\text{57.45 μs}}$$	$${\color{green}\text{23.62 μs}}$$
11		$${\color{green}\text{246.57 μs}}$$	$${\color{yellow}\text{9.26 ms}}$$
12		$${\color{green}\text{249.25 μs}}$$	$${\color{green}\text{596.43 μs}}$$
13	❌	N/A	N/A
14	❌	N/A	N/A
15	❌	N/A	N/A
16	❌	N/A	N/A
17	❌	N/A	N/A
18	❌	N/A	N/A
19	❌	N/A	N/A
20	❌	N/A	N/A
21	❌	N/A	N/A
22	❌	N/A	N/A
23	❌	N/A	N/A
24	❌	N/A	N/A
25	❌	N/A	N/A