#finite-fields #finite-field #ff

ff

Library for building and interfacing with finite fields

12 releases (breaking)

0.10.0 Jun 1, 2021
0.9.0 Jan 5, 2021
0.8.0 Sep 8, 2020
0.6.0 Mar 13, 2020
0.2.0 Jun 27, 2017

#22 in Algorithms

Download history 19644/week @ 2021-04-11 19583/week @ 2021-04-18 18560/week @ 2021-04-25 17038/week @ 2021-05-02 16468/week @ 2021-05-09 19079/week @ 2021-05-16 17661/week @ 2021-05-23 20438/week @ 2021-05-30 20711/week @ 2021-06-06 21607/week @ 2021-06-13 20828/week @ 2021-06-20 20420/week @ 2021-06-27 19521/week @ 2021-07-04 20448/week @ 2021-07-11 26146/week @ 2021-07-18 24951/week @ 2021-07-25

85,578 downloads per month
Used in 111 crates (31 directly)

MIT/Apache

23KB
412 lines

ff

ff is a finite field library written in pure Rust, with no unsafe{} code.

Disclaimers

  • This library does not provide constant-time guarantees.

Usage

Add the ff crate to your Cargo.toml:

[dependencies]
ff = "0.10"

The ff crate contains the Field and PrimeField traits. See the documentation for more.

#![derive(PrimeField)]

If you need an implementation of a prime field, this library also provides a procedural macro that will expand into an efficient implementation of a prime field when supplied with the modulus. PrimeFieldGenerator must be an element of Fp of p-1 order, that is also quadratic nonresidue.

First, enable the derive crate feature:

[dependencies]
ff = { version = "0.10", features = ["derive"] }

And then use the macro like so:

#[macro_use]
extern crate ff;

#[derive(PrimeField)]
#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"]
#[PrimeFieldGenerator = "7"]
#[PrimeFieldReprEndianness = "little"]
struct Fp([u64; 4]);

And that's it! Fp now implements Field and PrimeField.

Minimum Supported Rust Version

Requires Rust 1.51 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~73–540KB
~10K SLoC