Merge pull request #1 from txaty/bugfix/float_rounding

Tommy TIAN · web-flow · commit 811542661ebe · 2022-09-21T16:53:58.000+08:00
Fix float number rounding bug and update license
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Tommy Xiangan TIAN
+Copyright (c) 2022 Tommy TIAN
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/constant.go b/constant.go
@@ -1,3 +1,25 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import "math/big"
diff --git a/gaussian_integer.go b/gaussian_integer.go
@@ -1,3 +1,25 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import (
@@ -155,10 +177,10 @@ func (g *GaussianInt) Div(a, b *GaussianInt) *GaussianInt {
 
 	rsInt := iPool.Get().(*big.Int)
 	defer iPool.Put(rsInt)
-	roundFloat(realScalar, rsInt)
+	rsInt = roundFloat(realScalar)
 	isInt := iPool.Get().(*big.Int)
 	defer iPool.Put(isInt)
-	roundFloat(imagScalar, isInt)
+	isInt = roundFloat(imagScalar)
 	quotient := NewGaussianInt(rsInt, isInt)
 	opt := giPool.Get().(*GaussianInt)
 	defer giPool.Put(opt)
diff --git a/gaussian_integer_test.go b/gaussian_integer_test.go
@@ -1,3 +1,25 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import (
diff --git a/hurwitz_integer.go b/hurwitz_integer.go
@@ -1,3 +1,25 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import (
@@ -146,10 +168,10 @@ func (h *HurwitzInt) Val() (r, i, j, k *big.Float) {
 // ValInt reveals value of a Hurwitz integer in integer
 func (h *HurwitzInt) ValInt() (r, i, j, k *big.Int) {
 	rF, iF, jF, kF := h.Val()
-	roundFloat(rF, r)
-	roundFloat(iF, i)
-	roundFloat(jF, j)
-	roundFloat(kF, k)
+	r = roundFloat(rF)
+	i = roundFloat(iF)
+	j = roundFloat(jF)
+	k = roundFloat(kF)
 	return
 }
 
@@ -360,16 +382,16 @@ func (h *HurwitzInt) Div(a, b *HurwitzInt) *HurwitzInt {
 
 	rsInt := iPool.Get().(*big.Int)
 	defer iPool.Put(rsInt)
-	roundFloat(rScalar, rsInt)
+	rsInt = roundFloat(rScalar)
 	isInt := iPool.Get().(*big.Int)
 	defer iPool.Put(isInt)
-	roundFloat(iScalar, isInt)
+	isInt = roundFloat(iScalar)
 	jsInt := iPool.Get().(*big.Int)
 	defer iPool.Put(jsInt)
-	roundFloat(jScalar, jsInt)
+	jsInt = roundFloat(jScalar)
 	ksInt := iPool.Get().(*big.Int)
 	defer iPool.Put(ksInt)
-	roundFloat(kScalar, ksInt)
+	ksInt = roundFloat(kScalar)
 
 	quotient := NewHurwitzInt(rsInt, isInt, jsInt, ksInt, false)
 	opt := hiPool.Get().(*HurwitzInt)
diff --git a/hurwitz_integer_test.go b/hurwitz_integer_test.go
@@ -130,3 +130,57 @@ func TestHurwitzInt_String(t *testing.T) {
 		})
 	}
 }
+
+func TestHurwitzInt_ValInt(t *testing.T) {
+	type fields struct {
+		dblR *big.Int
+		dblI *big.Int
+		dblJ *big.Int
+		dblK *big.Int
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		wantR  *big.Int
+		wantI  *big.Int
+		wantJ  *big.Int
+		wantK  *big.Int
+	}{
+		{
+			name: "test_1+i+j+k",
+			fields: fields{
+				dblR: big.NewInt(2),
+				dblI: big.NewInt(2),
+				dblJ: big.NewInt(2),
+				dblK: big.NewInt(2),
+			},
+			wantR: big.NewInt(1),
+			wantI: big.NewInt(1),
+			wantJ: big.NewInt(1),
+			wantK: big.NewInt(1),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			h := &HurwitzInt{
+				dblR: tt.fields.dblR,
+				dblI: tt.fields.dblI,
+				dblJ: tt.fields.dblJ,
+				dblK: tt.fields.dblK,
+			}
+			gotR, gotI, gotJ, gotK := h.ValInt()
+			if !reflect.DeepEqual(gotR, tt.wantR) {
+				t.Errorf("ValInt() gotR = %v, want %v", gotR, tt.wantR)
+			}
+			if !reflect.DeepEqual(gotI, tt.wantI) {
+				t.Errorf("ValInt() gotI = %v, want %v", gotI, tt.wantI)
+			}
+			if !reflect.DeepEqual(gotJ, tt.wantJ) {
+				t.Errorf("ValInt() gotJ = %v, want %v", gotJ, tt.wantJ)
+			}
+			if !reflect.DeepEqual(gotK, tt.wantK) {
+				t.Errorf("ValInt() gotK = %v, want %v", gotK, tt.wantK)
+			}
+		})
+	}
+}
diff --git a/pool.go b/pool.go
@@ -1,3 +1,25 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import (
diff --git a/rounding.go b/rounding.go
@@ -1,16 +1,36 @@
+// MIT License
+//
+// Copyright (c) 2022 Tommy TIAN
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 package complex
 
 import "math/big"
 
 // roundFloat rounds the given big float to the nearest big integer
-func roundFloat(f *big.Float, res *big.Int) {
+func roundFloat(f *big.Float) *big.Int {
 	if f.Sign() < 0 {
 		f.Sub(f, rDelta)
 	} else {
 		f.Add(f, rDelta)
 	}
-	if res == nil {
-		res = new(big.Int)
-	}
-	f.Int(res)
+	res, _ := f.Int(nil)
+	return res
 }
