This repo is for exploring ways to solve NHLS problems.
Control thread number with
export RAYON_NUM_THREADS=n
If this is your first time using rust,
you will need to install the rust toolchain.
This is commonly done with a utility called rustup,
which allows you download and update multiple versions
of the rust toolchains.
For the latest details on obtaining and using rustup,
please refer to the official Install Rust.
Some notable utilities managed by rustup are:
rustc- The actual compiler. Its likely you will never interact with this program directly.cargo- The standard build system and package manager for rust projects. Most actions you will want to run will be of the formcargo <action>.rustanalyzer- This component implements an LSP server to provide and IDE like experience in your editor of choice.
The Rust ecosystem has some great documentation. The official website is a good place to start. There are several resources there for learning rust, including a textbook and a by-example tutorial.
The standard library documentation can be found here.
Rust packages are called crates, and crates.io is the official crate registry. Note that each crate's page includes links to both its github, and documentation hosted on docs.rs.
This project is setup as a rust library. To build the library use
cargo build # Debug build
cargo build --release # Release Build
Note that the first time you build a project, all the dependencies need to be downloaded and built as well. This is mostly a one time expense, as these will all be saved locally.
Tests can be run with
cargo test
Documentation for our library and our dependencies can be generated with
cargo doc
cargo doc --open # Opens the index.html page
Cargo also includes a source formatter.
cargo fmt
Lastly, library projects can include example executables,
included in the examples directory.
For example, to run the file examples/example_1.rs
cargo run --example example_1 # Debug
cargo run --release --example example_1 # Release, recommended