Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct some typos in comments #232

Merged
merged 1 commit into from
Jul 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ecc/bls12-377/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-377/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-377/internal/fptower/e12.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-378/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-378/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-378/internal/fptower/e12.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-381/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-381/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-381/internal/fptower/e12.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls12-381/internal/fptower/e2_bls381.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion ecc/bls24-315/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls24-315/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls24-315/internal/fptower/e12.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ecc/bls24-315/internal/fptower/e24.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls24-317/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls24-317/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bls24-317/internal/fptower/e12.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ecc/bls24-317/internal/fptower/e24.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bn254/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bn254/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bn254/internal/fptower/e12.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bn254/internal/fptower/e2_bn254.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion ecc/bw6-633/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bw6-633/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bw6-756/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bw6-756/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bw6-761/g1.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ecc/bw6-761/g2.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/generator/ecc/template/point.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion internal/generator/tower/asm/amd64/e2_bls381.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down