integer-sqrt-rs/README.md

17 lines
370 B
Markdown

# Integer square root
This module contains the single trait `IntegerSquareRoot` and implements it
for primitive integer types.
![ci badge](https://github.com/derekdreery/integer-sqrt-rs/workflows/Continuous%20integration/badge.svg)
## Example
```rust
// `use` trait to get functionality
use integer_sqrt::IntegerSquareRoot;
assert_eq!(4u8.integer_sqrt(), 2);
```