Merge pull request #232 from ConsenSys/docs/comments

docs: correct some typos in comments
Consensys · Jul 28, 2022 · e8ecd0d · e8ecd0d
2 parents 8d02a7e + d4ee696
commit e8ecd0d
Show file tree

Hide file tree

Showing 31 changed files with 31 additions and 31 deletions.
diff --git a/ecc/bls12-377/g1.go b/ecc/bls12-377/g1.go
diff --git a/ecc/bls12-377/g2.go b/ecc/bls12-377/g2.go
diff --git a/ecc/bls12-377/internal/fptower/e12.go b/ecc/bls12-377/internal/fptower/e12.go
diff --git a/ecc/bls12-378/g1.go b/ecc/bls12-378/g1.go
diff --git a/ecc/bls12-378/g2.go b/ecc/bls12-378/g2.go
diff --git a/ecc/bls12-378/internal/fptower/e12.go b/ecc/bls12-378/internal/fptower/e12.go
diff --git a/ecc/bls12-381/g1.go b/ecc/bls12-381/g1.go
diff --git a/ecc/bls12-381/g2.go b/ecc/bls12-381/g2.go
diff --git a/ecc/bls12-381/internal/fptower/e12.go b/ecc/bls12-381/internal/fptower/e12.go
diff --git a/ecc/bls12-381/internal/fptower/e2_bls381.go b/ecc/bls12-381/internal/fptower/e2_bls381.go
@@ -37,7 +37,7 @@ func mulGenericE2(z, x, y *E2) {
 
 // Square sets z to the E2-product of x,x returns z
 func squareGenericE2(z, x *E2) *E2 {
-	// algo 22 https://eprint.iacr.org/2010/354.pdf
+	// adapted from algo 22 https://eprint.iacr.org/2010/354.pdf
 	var a, b fp.Element
 	a.Add(&x.A0, &x.A1)
 	b.Sub(&x.A0, &x.A1)

diff --git a/ecc/bls24-315/g1.go b/ecc/bls24-315/g1.go
diff --git a/ecc/bls24-315/g2.go b/ecc/bls24-315/g2.go
diff --git a/ecc/bls24-315/internal/fptower/e12.go b/ecc/bls24-315/internal/fptower/e12.go
@@ -250,7 +250,7 @@ func (z *E12) Exp(x E12, k *big.Int) *E12 {
 	e := k
 	if k.Sign() == -1 {
 		// negative k, we invert
-		// if k < 0: xᵏ (mod q) == (x⁻¹)ᵏ (mod q)
+		// if k < 0: xᵏ (mod q¹²) == (x⁻¹)ᵏ (mod q¹²)
 		x.Inverse(&x)
 
 		// we negate k in a temp big.Int since

diff --git a/ecc/bls24-315/internal/fptower/e24.go b/ecc/bls24-315/internal/fptower/e24.go
diff --git a/ecc/bls24-317/g1.go b/ecc/bls24-317/g1.go
diff --git a/ecc/bls24-317/g2.go b/ecc/bls24-317/g2.go
diff --git a/ecc/bls24-317/internal/fptower/e12.go b/ecc/bls24-317/internal/fptower/e12.go
@@ -250,7 +250,7 @@ func (z *E12) Exp(x E12, k *big.Int) *E12 {
 	e := k
 	if k.Sign() == -1 {
 		// negative k, we invert
-		// if k < 0: xᵏ (mod q) == (x⁻¹)ᵏ (mod q)
+		// if k < 0: xᵏ (mod q¹²) == (x⁻¹)ᵏ (mod q¹²)
 		x.Inverse(&x)
 
 		// we negate k in a temp big.Int since

diff --git a/ecc/bls24-317/internal/fptower/e24.go b/ecc/bls24-317/internal/fptower/e24.go
diff --git a/ecc/bn254/g1.go b/ecc/bn254/g1.go
diff --git a/ecc/bn254/g2.go b/ecc/bn254/g2.go
diff --git a/ecc/bn254/internal/fptower/e12.go b/ecc/bn254/internal/fptower/e12.go
diff --git a/ecc/bn254/internal/fptower/e2_bn254.go b/ecc/bn254/internal/fptower/e2_bn254.go
@@ -50,7 +50,7 @@ func mulGenericE2(z, x, y *E2) {
 // squareGenericE2 sets z to the E2-product of x,x returns z
 // note: do not rename, this is referenced in the x86 assembly impl
 func squareGenericE2(z, x *E2) {
-	// algo 22 https://eprint.iacr.org/2010/354.pdf
+	// adapted from algo 22 https://eprint.iacr.org/2010/354.pdf
 	var a, b fp.Element
 	a.Add(&x.A0, &x.A1)
 	b.Sub(&x.A0, &x.A1)

diff --git a/ecc/bw6-633/g1.go b/ecc/bw6-633/g1.go
diff --git a/ecc/bw6-633/g2.go b/ecc/bw6-633/g2.go
diff --git a/ecc/bw6-756/g1.go b/ecc/bw6-756/g1.go
diff --git a/ecc/bw6-756/g2.go b/ecc/bw6-756/g2.go
diff --git a/ecc/bw6-761/g1.go b/ecc/bw6-761/g1.go
diff --git a/ecc/bw6-761/g2.go b/ecc/bw6-761/g2.go
diff --git a/internal/generator/ecc/template/point.go.tmpl b/internal/generator/ecc/template/point.go.tmpl
@@ -362,7 +362,7 @@ func (p *{{ $TJacobian }}) String() string {
 	return _p.String()
 }
 
-// FromAffine sets p = Q, p in Jacboian, Q in affine
+// FromAffine sets p = Q, p in Jacobian, Q in affine
 func (p *{{ $TJacobian }}) FromAffine(Q *{{ $TAffine }}) *{{ $TJacobian }} {
 	if Q.IsInfinity() {
 		p.Z.SetZero()

diff --git a/internal/generator/tower/asm/amd64/e2_bls381.go b/internal/generator/tower/asm/amd64/e2_bls381.go
@@ -56,7 +56,7 @@ func (fq2 *Fq2Amd64) generateMulByNonResidueE2BLS381() {
 func (fq2 *Fq2Amd64) generateSquareE2BLS381(forceCheck bool) {
 	// // Square sets z to the E2-product of x,x returns z
 	// func (z *E2) Square(x *E2) *E2 {
-	// 	// algo 22 https://eprint.iacr.org/2010/354.pdf
+	// 	// adapted from algo 22 https://eprint.iacr.org/2010/354.pdf
 	// 	var a, b fp.Element
 	// 	a.Add(&x.A0, &x.A1)
 	// 	b.Sub(&x.A0, &x.A1)

diff --git a/internal/generator/tower/template/fq12over6over2/fq12.go.tmpl b/internal/generator/tower/template/fq12over6over2/fq12.go.tmpl
@@ -444,7 +444,7 @@ func (z *E12) Exp(x E12, k *big.Int) *E12 {
 	e := k
 	if k.Sign() == -1 {
 		// negative k, we invert
-		// if k < 0: xᵏ (mod q) == (x⁻¹)ᵏ (mod q)
+		// if k < 0: xᵏ (mod q¹²) == (x⁻¹)ᵏ (mod q¹²)
 		x.Inverse(&x)
 
 		// we negate k in a temp big.Int since