docs.rs failed to build ark-ff-0.4.0-alpha.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
ark-ff-0.5.0
This crate defines Finite Field traits and useful abstraction models that follow these traits.
Implementations of concrete finite fields for some popular elliptic curves can be found in arkworks-rs/curves
under arkworks-rs/curves/<your favourite curve>/src/fields/
.
This crate contains two types of traits:
Field
traits: These define interfaces for manipulating field elements, such as addition, multiplication, inverses, square roots, and more.- Field
Config
s: specifies the parameters defining the field in question. For extension fields, it also provides additional functionality required for the field, such as operations involving a (cubic or quadratic) non-residue used for constructing the field (NONRESIDUE
).
The available field traits are:
Field
- Interface for a generic finite field.FftField
- Exposes methods that allow for performing efficient FFTs on field elements.PrimeField
- Field with a primep
number of elements, also referred to asFp
.
The models implemented are:
Quadratic Extension
QuadExtField
- Struct representing a quadratic extension field, in this case holding two base field elementsQuadExtConfig
- Trait defining the necessary parameters needed to instantiate a Quadratic Extension Field
Cubic Extension
CubicExtField
- Struct representing a cubic extension field, holds three base field elementsCubicExtConfig
- Trait defining the necessary parameters needed to instantiate a Cubic Extension Field
The above two models serve as abstractions for constructing the extension fields Fp^m
directly (i.e. m
equal 2 or 3) or for creating extension towers to arrive at higher m
. The latter is done by applying the extensions iteratively, e.g. cubic extension over a quadratic extension field.
Fp2
- Quadratic extension directly on the prime field, i.e.BaseField == BasePrimeField
Fp3
- Cubic extension directly on the prime field, i.e.BaseField == BasePrimeField
Fp6_2over3
- Extension tower: quadratic extension on a cubic extension field, i.e.BaseField = Fp3
, butBasePrimeField = Fp
.Fp6_3over2
- Extension tower, similar to the above except that the towering order is reversed: it's a cubic extension on a quadratic extension field, i.e.BaseField = Fp2
, butBasePrimeField = Fp
. Only this latter one is exported by default asFp6
.Fp12_2over3over2
- Extension tower: quadratic extension ofFp6_3over2
, i.e.BaseField = Fp6
.