extra_math/README.md

52 lines
1.3 KiB
Markdown

# extra_math
Maths support code for various floating point types
## Features
Each floating point type is feature gated. Some other functionality is enabled in some cases.
- `u256`: Enable a 256 bit unsigned integer type. This is *NOT* a constant time implementation.
## Running the tests
```sh
cargo test
nix flake check
```
## Built With
- [Contributor Covenant](https://www.contributor-covenant.org/) - Used
for the Code of Conduct
- [Math.net](https://github.com/mathnet/mathnet-numerics/blob/master/src/Numerics/SpecialFunctions/Gamma.cs) for some of the code
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
of conduct, and the process for submitting pull requests to us.
## Versioning
We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this
repository](https://github.com/PurpleBooth/a-good-readme-template/tags).
## Authors
- **Charlotte 🦝 Delenk** [DarkKirb](https://lotte.chir.rs)
See also the list of
[contributors](https://github.com/PurpleBooth/a-good-readme-template/contributors)
who participated in this project.
## License
Licensed under either of
* Apache License, Version 2.0
[LICENSE-APACHE](LICENSE-APACHE)
* MIT license
[LICENSE-MIT](LICENSE-MIT)
at your option.