Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
unageek committed Feb 20, 2021
1 parent 57f7cc2 commit 99df1e3
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down

0 comments on commit 99df1e3

Please sign in to comment.