This repository contains a Rust implementation of the N-Queen problem solver. The N-Queen problem is a classic combinatorial problem where the objective is to place N queens on an N x N chessboard in such a way that no two queens threaten each other. In other words, there should not be any two queens on the same row, column, or diagonal.
This implementation focus in efficiency and performance. Thus, it uses a combination of backtracking with bit manipulation to reach a solution in reasonable time given the constraints of the problem.
To get a local copy up and running, follow these simple steps.
- Make sure you have Rust and Cargo installed on your system. If not, follow the official guide to install Rust.
- Clone the repository:
git clone https://github.com/alexfdez1010/n_queens.git- Change directory into the cloned repository:
cd n_queens- Build the project:
cargo build --releaseIt is vital to build the project in release mode, as the solver will run much faster.
After building the project, you can run the solver with the following command:
cargo run --releaseThe input consists of a single integer N, where 1 <= N <= 128. The output consists of N lines, each containing N characters. A character of 'Q' represents a queen, and a character of '0' represents an empty cell.
After inputting the matrix, the solver will ask you if you want all the solutions or just one.
You can run the tests using the following command:
cargo testAdditionally, in the folder input_files you can find a set of input files that can be used to test the solver.
For that aim, you can use the following command:
cargo run --release < input_files/input_file > output_fileWhere input_file is the name of the input file you want to use, and output_file is the name of the file where the output will be stored.
You can generate the documentation using the following command:
cargo doc --openThis will generate the documentation and open it in your default browser.
Distributed under the MIT License. See LICENSE for more information.