saymrwulf/pasta_curves-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/pasta_curves-source.git synced 2026-09-04 20:03:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document that the generator in SqrtRatio::sqrt_ratio might change

Browse source
This commit is contained in:
Jack Grigg 2021-09-30 13:45:26 +01:00
parent 32cc10db46
commit a91e262235
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/arithmetic/fields.rs
View file

@ -46,8 +46,12 @@ pub trait SqrtRatio: ff::PrimeField {
/// $\textsf{num}$ and $\textsf{div}$ are nonzero and $\textsf{num}/\textsf{div}$ is
/// a nonsquare in the field;
///
/// where $G_S$ ([`ff::PrimeField::root_of_unity`]) is a generator of the order $2^S$
/// subgroup (and therefore a nonsquare).
/// where $G_S$ is a non-square.
///
/// For `pasta_curves`, $G_S$ is currently [`ff::PrimeField::root_of_unity`], a
/// generator of the order $2^S$ subgroup. Users of this crate should not rely on this
/// generator being fixed; it may be changed in future crate versions to simplify the
/// implementation of the SSWU hash-to-curve algorithm.
///
/// The choice of root from sqrt is unspecified.
fn sqrt_ratio(num: &Self, div: &Self) -> (Choice, Self);