Skip to content

Commit

Permalink
remove float32 variant, relocate into separate file
Browse files Browse the repository at this point in the history
This change removes the float32 variant of the AlmostEqual funcs, that we will
likely never use. This change also relocates the function into a separate file
to avoid modifying a file that's a fork of another vendored package.
  • Loading branch information
sbunce committed Sep 28, 2022
1 parent e672c58 commit 46827a2
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 92 deletions.
60 changes: 60 additions & 0 deletions prometheus/internal/almost_equal.go
@@ -0,0 +1,60 @@
// Copyright (c) 2015 Björn Rabenstein
//
// 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.
//
// The code in this package is copy/paste to avoid a dependency. Hence this file
// carries the copyright of the original repo.
// https://github.com/beorn7/floats
package internal

import (
"math"
)

// minNormalFloat64 is the smallest positive normal value of type float64.
var minNormalFloat64 = math.Float64frombits(0x0010000000000000)

// AlmostEqualFloat64 returns true if a and b are equal within a relative error
// of epsilon. See http://floating-point-gui.de/errors/comparison/ for the
// details of the applied method.
func AlmostEqualFloat64(a, b, epsilon float64) bool {
if a == b {
return true
}
absA := math.Abs(a)
absB := math.Abs(b)
diff := math.Abs(a - b)
if a == 0 || b == 0 || absA+absB < minNormalFloat64 {
return diff < epsilon*minNormalFloat64
}
return diff/math.Min(absA+absB, math.MaxFloat64) < epsilon
}

// AlmostEqualFloat64s is the slice form of AlmostEqualFloat64.
func AlmostEqualFloat64s(a, b []float64, epsilon float64) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if !AlmostEqualFloat64(a[i], b[i], epsilon) {
return false
}
}
return true
}
92 changes: 0 additions & 92 deletions prometheus/internal/difflib.go
Expand Up @@ -22,7 +22,6 @@ import (
"bytes"
"fmt"
"io"
"math"
"strings"
)

Expand All @@ -47,97 +46,6 @@ func calculateRatio(matches, length int) float64 {
return 1.0
}

var (
// minNormalFloat64 is the smallest positive normal value of type float64.
minNormalFloat64 = math.Float64frombits(0x0010000000000000)

// minNormalFloat32 is the smallest positive normal value of type float32.
minNormalFloat32 = math.Float32frombits(0x00800000)
)

// AlmostEqualFloat64 returns true if a and b are equal within a relative error
// of epsilon. See http://floating-point-gui.de/errors/comparison/ for the
// details of the applied method.
//
// This function is copy/paste to avoid a dependency.
// https://github.com/beorn7/floats
func AlmostEqualFloat64(a, b, epsilon float64) bool {
if a == b {
return true
}
absA := math.Abs(a)
absB := math.Abs(b)
diff := math.Abs(a - b)
if a == 0 || b == 0 || absA+absB < minNormalFloat64 {
return diff < epsilon*minNormalFloat64
}
return diff/math.Min(absA+absB, math.MaxFloat64) < epsilon
}

// AlmostEqualFloat64s is the slice form of AlmostEqualFloat64.
func AlmostEqualFloat64s(a, b []float64, epsilon float64) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if !AlmostEqualFloat64(a[i], b[i], epsilon) {
return false
}
}
return true
}

// AlmostEqualFloat32 returns true if a and b are equal within a relative error
// of epsilon. See http://floating-point-gui.de/errors/comparison/ for the
// details of the applied method.
//
// This function is copy/paste to avoid a dependency.
// https://github.com/beorn7/floats
func AlmostEqualFloat32(a, b, epsilon float32) bool {
if a == b {
return true
}
absA := AbsFloat32(a)
absB := AbsFloat32(b)
diff := AbsFloat32(a - b)
if a == 0 || b == 0 || absA+absB < minNormalFloat32 {
return diff < epsilon*minNormalFloat32
}
return diff/MinFloat32(absA+absB, math.MaxFloat32) < epsilon
}

// AlmostEqualFloat32s is the slice form of AlmostEqualFloat32.
func AlmostEqualFloat32s(a, b []float32, epsilon float32) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if !AlmostEqualFloat32(a[i], b[i], epsilon) {
return false
}
}
return true
}

// AbsFloat32 works like math.Abs, but for float32.
func AbsFloat32(x float32) float32 {
switch {
case x < 0:
return -x
case x == 0:
return 0 // return correctly abs(-0)
}
return x
}

// MinFloat32 works like math.Min, but for float32.
func MinFloat32(x, y float32) float32 {
if x < y {
return x
}
return y
}

type Match struct {
A int
B int
Expand Down

0 comments on commit 46827a2

Please sign in to comment.