From 99df1e3f52836a9f535e91a2b629760a7aa61430 Mon Sep 17 00:00:00 2001 From: Masashi Mizuno <29035331+unageek@users.noreply.github.com> Date: Sat, 20 Feb 2021 16:05:55 +0900 Subject: [PATCH] Update README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c326f53..830b186 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,17 @@ A Rust implementation of set-based [interval arithmetic](https://en.wikipedia.or ## Requirements -The nightly Rust toolchain is required, since the [new `asm!` macro](https://blog.rust-lang.org/inside-rust/2020/06/08/new-inline-asm.html) is used. +### `rustc` version + +A recent version of the nightly toolchain is required, since the [new `asm!` macro](https://blog.rust-lang.org/inside-rust/2020/06/08/new-inline-asm.html) is used. The toolchain is automatically chosen by the [rust-toolchain](rust-toolchain) file. + +### Target CPU + +Haswell or newer microarchitecture is required. This is automatically enforced by the [.cargo/config.toml](https://github.com/unageek/inari/blob/master/.cargo/config.toml) file. ## Conditional features -- `gmp` (enabled by default) - Enables operations that depend on GMP and MPFR, namely transcendental functions and conversion between texts and intervals. You can opt-out the feature to reduce dependency. Even in that case, you can still access to basic arithmetic operations that are required for writing filters for geometric predicates. +- `gmp` (enabled by default) - Enables operations that depend on GMP and MPFR, namely, transcendental functions and conversion between texts and intervals. You can opt-out the feature to reduce dependencies. Even in that case, you still have access to all arithmetic operations that are required for writing filters for robust geometric predicates. ## Made with inari @@ -26,7 +32,7 @@ The nightly Rust toolchain is required, since the [new `asm!` macro](https://blo - Improve conformance to the standard - More formatting options - https://octave.sourceforge.io/interval/function/intervaltotext.html - - https://en.cppreference.com/w/cpp/utility/format/formatter + - https://docs.python.org/3/library/string.html#formatspec ## References