From 9b3186918b44a860918374a2c91665df3cb924d7 Mon Sep 17 00:00:00 2001
From: Youssef El Housni <youssef.housni21@gmail.com>
Date: Sat, 21 Sep 2024 01:13:54 -0400
Subject: [PATCH] style: clean comments

---
 ecc/eisenstein.go      |  8 ++++----
 ecc/eisenstein_test.go | 15 +++++++++++++++
 2 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/ecc/eisenstein.go b/ecc/eisenstein.go
index a950a51fc..e24dbc165 100644
--- a/ecc/eisenstein.go
+++ b/ecc/eisenstein.go
@@ -30,14 +30,14 @@ func (z *ComplexNumber) Set(x *ComplexNumber) *ComplexNumber {
 	return z
 }
 
-// Set sets z to 0, and returns z.
+// SetZero sets z to 0, and returns z.
 func (z *ComplexNumber) SetZero() *ComplexNumber {
 	z.A0 = *big.NewInt(0)
 	z.A1 = *big.NewInt(0)
 	return z
 }
 
-// Set sets z to 1, and returns z.
+// SetOne sets z to 1, and returns z.
 func (z *ComplexNumber) SetOne() *ComplexNumber {
 	z.A0 = *big.NewInt(1)
 	z.A1 = *big.NewInt(0)
@@ -121,8 +121,8 @@ func (z *ComplexNumber) Quo(x, y *ComplexNumber) *ComplexNumber {
 	return z
 }
 
-// HalfGCD returns the rational reconstruction of l mod r.
-// This outputs u, v s.t. l = u/v mod r
+// HalfGCD returns the rational reconstruction of a, b.
+// This outputs w, v, u s.t. w = a*u + b*v.
 func HalfGCD(a, b *ComplexNumber) [3]*ComplexNumber {
 
 	var aRun, bRun, u, v, u_, v_, quotient, remainder, t, t1, t2 ComplexNumber
diff --git a/ecc/eisenstein_test.go b/ecc/eisenstein_test.go
index 40374cdbf..fdd9f2543 100644
--- a/ecc/eisenstein_test.go
+++ b/ecc/eisenstein_test.go
@@ -261,3 +261,18 @@ func GenComplexNumber() gopter.Gen {
 		return &ComplexNumber{A0: values[0].(big.Int), A1: values[1].(big.Int)}
 	})
 }
+
+// bench
+func BenchmarkHalfGCD(b *testing.B) {
+	var prime, _ = new(big.Int).SetString("7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffed", 16) // 2^255 - 19
+	a0, _ := rand.Int(rand.Reader, prime)
+	a1, _ := rand.Int(rand.Reader, prime)
+	c0, _ := rand.Int(rand.Reader, prime)
+	c1, _ := rand.Int(rand.Reader, prime)
+	a := ComplexNumber{A0: *a0, A1: *a1}
+	c := ComplexNumber{A0: *c0, A1: *c1}
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		HalfGCD(&a, &c)
+	}
+}