Skip to content

Commit

Permalink
Allow 1 ULP of error in GDA tests
Browse files Browse the repository at this point in the history
In the GDA arithmetic specification, inexact exp, ln, log10 and power
operations may be up to 1 ulp (unit in last place) in error.
  • Loading branch information
rdingwall committed May 24, 2020
1 parent 88212e6 commit e65a659
Showing 1 changed file with 42 additions and 8 deletions.
50 changes: 42 additions & 8 deletions dectest/test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"reflect"
"strconv"
"strings"
"testing"

"github.com/ericlagergren/decimal"
Expand Down Expand Up @@ -277,15 +278,15 @@ got : %v
func check(t *testing.T, z, r *decimal.Big, c *Case, flags decimal.Condition) {
helper(t)()
if !equal(z, r) {
str := fmt.Sprintf(`%s
wanted: %q (%s:%d)
got : %q (%s:%d)
`,
s := []string{
c.ShortString(10000),
r, flags, -r.Scale(),
z, z.Context.Conditions, -z.Scale(),
)
t.Log(str)
fmt.Sprintf("wanted: %q (%s:%d)", r, flags, -r.Scale()),
fmt.Sprintf("got : %q (%s:%d)", z, z.Context.Conditions, -z.Scale()),
}
if isInexact(z) && allow1ULPError[c.Op] && equalWithin1ULP(z, r) {
s = append(s, "passed within 1 ULP")
}
t.Log(strings.Join(s, "\n"), "\n")
}
}

Expand Down Expand Up @@ -321,6 +322,35 @@ func equal(x, y *decimal.Big) bool {
return cmp && scl && prec
}

func equalWithin1ULP(x, y *decimal.Big) bool {
if !x.IsFinite() || !y.IsFinite() {
return false
}
formX, negX, coeffX, expX := x.Decompose(make([]byte, 2<<3))
formY, negY, coeffY, expY := y.Decompose(make([]byte, 2<<3))
if formX != formY || negX != negY || expX != expY {
return false
}
l := len(coeffX)
if len(coeffY) != l {
return false
}
for i := 0; i < l-1; i++ {
if coeffX[i] != coeffY[i] {
return false
}
}
d := coeffX[l-1] - coeffY[l-1]
return d == 0x01 || d == 0xff
}

var allow1ULPError = map[Op]bool{
Exp: true,
Ln: true,
Log10: true,
Power: true,
}

// helper returns testing.T.Helper, if it exists.
func helper(v interface{}) func() {
if fn, ok := v.(interface {
Expand All @@ -345,3 +375,7 @@ func convertConditions(c Condition) (decimal.Condition, bool) {
}
return r, true
}

func isInexact(x *decimal.Big) bool {
return x.Context.Conditions&decimal.Inexact == decimal.Inexact
}

0 comments on commit e65a659

Please sign in to comment.