Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benesjan committed Jul 15, 2024
1 parent 140429a commit 46db3de
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions yarn-project/foundation/src/fields/point.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,11 @@ export class Point {

/**
* Uses the x coordinate and isPositive flag (+/-) to reconstruct the point.
* @dev The y coordinate can be derived from the x coordinate and the sign flag by solving the grumpkin curve
* @dev The y coordinate can be derived from the x coordinate and the "sign" flag by solving the grumpkin curve
* equation for y.
* @param x - The x coordinate of the point
* @param sign - The sign of the y coordinate
* @param sign - The "sign" of the y coordinate - note that this is not a sign as is known in integer arithmetic.
* Instead it is a boolean flag that determines whether the y coordinate is <= (Fr.MODULUS - 1) / 2
* @returns The point as an array of 2 fields
*/
static fromXAndSign(x: Fr, sign: boolean) {
Expand Down

0 comments on commit 46db3de

Please sign in to comment.