Files
gonum/floats_test.go
2013-08-16 12:56:33 -07:00

645 lines
16 KiB
Go

// Copyright 2013 The Gonum Authors. All rights reserved.
// Use of this code is governed by a BSD-style
// license that can be found in the LICENSE file
package floats
import (
"math"
"math/rand"
"strconv"
"testing"
)
const (
EQTOLERANCE = 1E-14
SMALL = 10
MEDIUM = 1000
LARGE = 100000
HUGE = 10000000
)
func AreSlicesEqual(t *testing.T, truth, comp []float64, str string) {
if !Eq(comp, truth, EQTOLERANCE) {
t.Errorf(str+". Expected %v, returned %v", truth, comp)
}
}
func Panics(fun func()) (b bool) {
defer func() {
err := recover()
if err != nil {
b = true
}
}()
fun()
return
}
func TestAdd(t *testing.T) {
a := []float64{1, 2, 3}
b := []float64{4, 5, 6}
c := []float64{7, 8, 9}
truth := []float64{12, 15, 18}
n := make([]float64, len(a))
Add(n, a, b, c)
AreSlicesEqual(t, truth, n, "Wrong addition of slices new receiver")
Add(a, b, c)
AreSlicesEqual(t, truth, n, "Wrong addition of slices for no new receiver")
// Test that it panics
if !Panics(func() { Add(make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with length mismatch")
}
}
func TestAddconst(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
c := 6.0
truth := []float64{9, 10, 7, 13, 11}
AddConst(c, s)
AreSlicesEqual(t, truth, s, "Wrong addition of constant")
}
func TestApply(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
f := math.Sin
truth := make([]float64, len(s))
for i, val := range s {
truth[i] = math.Sin(val)
}
Apply(f, s)
AreSlicesEqual(t, truth, s, "Wrong application of function")
}
func TestCount(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
f := func(v float64) bool { return v > 3.5 }
truth := 3
n := Count(f, s)
if n != truth {
t.Errorf("Wrong number of elements counted")
}
}
func TestCumProd(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
receiver := make([]float64, len(s))
CumProd(receiver, s)
truth := []float64{3, 12, 12, 84, 420}
AreSlicesEqual(t, truth, receiver, "Wrong cumprod returned with new receiver")
CumProd(receiver, s)
AreSlicesEqual(t, truth, receiver, "Wrong cumprod returned with reused receiver")
// Test that it panics
if !Panics(func() { CumProd(make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with length mismatch")
}
}
func TestCumSum(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
receiver := make([]float64, len(s))
CumSum(receiver, s)
truth := []float64{3, 7, 8, 15, 20}
AreSlicesEqual(t, truth, receiver, "Wrong cumsum returned with new receiver")
CumSum(receiver, s)
AreSlicesEqual(t, truth, receiver, "Wrong cumsum returned with reused receiver")
// Test that it panics
if !Panics(func() { CumSum(make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with length mismatch")
}
}
func TestDot(t *testing.T) {
s1 := []float64{1, 2, 3, 4}
s2 := []float64{-3, 4, 5, -6}
truth := -4.0
ans := Dot(s1, s2)
if ans != truth {
t.Errorf("Dot product computed incorrectly")
}
// Test that it panics
if !Panics(func() { Dot(make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with length mismatch")
}
}
func TestEq(t *testing.T) {
s1 := []float64{1, 2, 3, 4}
s2 := []float64{1, 2, 3, 4 + 1E-14}
if !Eq(s1, s2, 1E-13) {
t.Errorf("Equal slices returned as unequal")
}
if Eq(s1, s2, 1E-15) {
t.Errorf("Unequal slices returned as equal")
}
}
func TestEqLen(t *testing.T) {
s1 := []float64{1, 2, 3, 4}
s2 := []float64{1, 2, 3, 4}
s3 := []float64{1, 2, 3}
if !EqLen(s1, s2) {
t.Errorf("Equal lengths returned as unequal")
}
if EqLen(s1, s3) {
t.Errorf("Unequal lengths returned as equal")
}
if !EqLen(s1) {
t.Errorf("Single slice returned as unequal")
}
if !EqLen() {
t.Errorf("No slices returned as unequal")
}
}
func eqIntSlice(one, two []int) string {
if len(one) != len(two) {
return "Length mismatch"
}
for i, val := range one {
if val != two[i] {
return "Index " + strconv.Itoa(i) + " mismatch"
}
}
return ""
}
func TestFind(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
f := func(v float64) bool { return v > 3.5 }
allTrueInds := []int{1, 3, 4}
// Test finding first two elements
inds, err := Find(nil, f, s, 2)
if err != nil {
t.Errorf("Find first two: Improper error return")
}
trueInds := allTrueInds[:2]
str := eqIntSlice(inds, trueInds)
if str != "" {
t.Errorf("Find first two: " + str)
}
// Test finding first two elements with non nil slice
inds = []int{1, 2, 3, 4, 5, 6}
inds, err = Find(inds, f, s, 2)
if err != nil {
t.Errorf("Find first two non-nil: Improper error return")
}
str = eqIntSlice(inds, trueInds)
if str != "" {
t.Errorf("Find first two non-nil: " + str)
}
// Test finding too many elements
inds, err = Find(inds, f, s, 4)
if err == nil {
t.Errorf("Request too many: No error returned")
}
str = eqIntSlice(inds, allTrueInds)
if str != "" {
t.Errorf("Request too many: Does not match all of the inds: " + str)
}
// Test finding all elements
inds, err = Find(nil, f, s, -1)
if err != nil {
t.Errorf("Find all: Improper error returned")
}
str = eqIntSlice(inds, allTrueInds)
if str != "" {
t.Errorf("Find all: Does not match all of the inds: " + str)
}
}
func TestLogSpan(t *testing.T) {
receiver := make([]float64, 6)
truth := []float64{0.001, 0.01, 0.1, 1, 10, 100}
LogSpan(receiver, 0.001, 100)
tst := make([]float64, 6)
for i := range truth {
tst[i] = receiver[i] / truth[i]
}
comp := make([]float64, 6)
for i := range comp {
comp[i] = 1
}
AreSlicesEqual(t, comp, tst, "Improper logspace")
if !Panics(func() { LogSpan(nil, 1, 5) }) {
t.Errorf("Span accepts nil argument")
}
if !Panics(func() { LogSpan(make([]float64, 1), 1, 5) }) {
t.Errorf("Span accepts argument of len = 1")
}
}
func TestLogSumExp(t *testing.T) {
s := []float64{1, 2, 3, 4, 5}
val := LogSumExp(s)
// http://www.wolframalpha.com/input/?i=log%28exp%281%29+%2B+exp%282%29+%2B+exp%283%29+%2B+exp%284%29+%2B+exp%285%29%29
truth := 5.4519143959375933331957225109748087179338972737576824
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Wrong logsumexp for many values")
}
s = []float64{1, 2}
// http://www.wolframalpha.com/input/?i=log%28exp%281%29+%2B+exp%282%29%29
truth = 2.3132616875182228340489954949678556419152800856703483
val = LogSumExp(s)
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Wrong logsumexp for two values. %v expected, %v found", truth, val)
}
// This case would normally underflow
s = []float64{-1001, -1002, -1003, -1004, -1005}
// http://www.wolframalpha.com/input/?i=log%28exp%28-1001%29%2Bexp%28-1002%29%2Bexp%28-1003%29%2Bexp%28-1004%29%2Bexp%28-1005%29%29
truth = -1000.54808560406240666680427748902519128206610272624
val = LogSumExp(s)
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Doesn't match for underflow case. %v expected, %v found", truth, val)
}
}
func TestMax(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
val, ind := Max(s)
if val != 7 {
t.Errorf("Wrong value returned")
}
if ind != 3 {
t.Errorf("Wrong index returned")
}
}
func TestMin(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
val, ind := Min(s)
if val != 1 {
t.Errorf("Wrong value returned")
}
if ind != 2 {
t.Errorf("Wrong index returned")
}
}
func TestMul(t *testing.T) {
}
func TestNearest(t *testing.T) {
s := []float64{6.2, 3, 5, 6.2, 8}
ind := Nearest(s, 2.0)
if ind != 1 {
t.Errorf("Wrong index returned when value is less than all of elements")
}
ind = Nearest(s, 9.0)
if ind != 4 {
t.Errorf("Wrong index returned when value is greater than all of elements")
}
ind = Nearest(s, 3.1)
if ind != 1 {
t.Errorf("Wrong index returned when value is greater than closest element")
}
ind = Nearest(s, 3.1)
if ind != 1 {
t.Errorf("Wrong index returned when value is greater than closest element")
}
ind = Nearest(s, 2.9)
if ind != 1 {
t.Errorf("Wrong index returned when value is less than closest element")
}
ind = Nearest(s, 3)
if ind != 1 {
t.Errorf("Wrong index returned when value is equal to element")
}
ind = Nearest(s, 6.2)
if ind != 0 {
t.Errorf("Wrong index returned when value is equal to several elements")
}
ind = Nearest(s, 4)
if ind != 1 {
t.Errorf("Wrong index returned when value is exactly between two closest elements")
}
}
func TestNearestWithinSpan(t *testing.T) {
if !Panics(func() { NearestWithinSpan(13, 7, 8.2, 10) }) {
t.Errorf("Did not panic below lower bound")
}
if !Panics(func() { NearestWithinSpan(13, 7, 8.2, 10) }) {
t.Errorf("Did not panic above upper bound")
}
ind := NearestWithinSpan(13, 7, 8.2, 7.19)
if ind != 2 {
t.Errorf("Wrong value when just below the bucket. %i found, %i expected", ind, 2)
}
ind = NearestWithinSpan(13, 7, 8.2, 7.21)
if ind != 2 {
t.Errorf("Wrong value when just above the bucket. %i found, %i expected", ind, 2)
}
ind = NearestWithinSpan(13, 7, 8.2, 7.2)
if ind != 2 {
t.Errorf("Wrong value when equal to bucket. %i found, %i expected", ind, 2)
}
ind = NearestWithinSpan(13, 7, 8.2, 7.151)
if ind != 2 {
t.Errorf("Wrong value when just above halfway point. %i found, %i expected", ind, 2)
}
ind = NearestWithinSpan(13, 7, 8.2, 7.249)
if ind != 2 {
t.Errorf("Wrong value when just below halfway point. %i found, %i expected", ind, 2)
}
}
func TestNorm(t *testing.T) {
s := []float64{-1, -3.4, 5, 6}
val := Norm(s, math.Inf(1))
truth := 6.0
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Doesn't match for inf norm. %v expected, %v found", truth, val)
}
// http://www.wolframalpha.com/input/?i=%28%28-1%29%5E2+%2B++%28-3.4%29%5E2+%2B+5%5E2%2B++6%5E2%29%5E%281%2F2%29
val = Norm(s, 2)
truth = 8.5767126569566267590651614132751986658027271236078592
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Doesn't match for inf norm. %v expected, %v found", truth, val)
}
// http://www.wolframalpha.com/input/?i=%28%28%7C-1%7C%29%5E3+%2B++%28%7C-3.4%7C%29%5E3+%2B+%7C5%7C%5E3%2B++%7C6%7C%5E3%29%5E%281%2F3%29
val = Norm(s, 3)
truth = 7.2514321388020228478109121239004816430071237369356233
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Doesn't match for inf norm. %v expected, %v found", truth, val)
}
//http://www.wolframalpha.com/input/?i=%7C-1%7C+%2B+%7C-3.4%7C+%2B+%7C5%7C%2B++%7C6%7C
val = Norm(s, 1)
truth = 15.4
if math.Abs(val-truth) > EQTOLERANCE {
t.Errorf("Doesn't match for inf norm. %v expected, %v found", truth, val)
}
}
func TestProd(t *testing.T) {
s := []float64{}
val := Prod(s)
if val != 1 {
t.Errorf("Val not returned as default when slice length is zero")
}
s = []float64{3, 4, 1, 7, 5}
val = Prod(s)
if val != 420 {
t.Errorf("Wrong prod returned. Expected %v returned %v", 420, val)
}
}
func TestScale(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
c := 5.0
truth := []float64{15, 20, 5, 35, 25}
Scale(c, s)
AreSlicesEqual(t, truth, s, "Bad scaling")
}
func TestSpan(t *testing.T) {
receiver := make([]float64, 5)
truth := []float64{1, 2, 3, 4, 5}
Span(receiver, 1, 5)
AreSlicesEqual(t, truth, receiver, "Improper linspace")
receiver = make([]float64, 6)
truth = []float64{0, 0.2, 0.4, 0.6, 0.8, 1.0}
Span(receiver, 0, 1)
AreSlicesEqual(t, truth, receiver, "Improper linspace")
if !Panics(func() { Span(nil, 1, 5) }) {
t.Errorf("Span accepts nil argument")
}
if !Panics(func() { Span(make([]float64, 1), 1, 5) }) {
t.Errorf("Span accepts argument of len = 1")
}
}
func TestSub(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
v := []float64{1, 2, 3, 4, 5}
truth := []float64{2, 2, -2, 3, 0}
Sub(s, v)
AreSlicesEqual(t, truth, s, "Bad subtract")
// Test that it panics
if !Panics(func() { Sub(make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with length mismatch")
}
}
func TestSubTo(t *testing.T) {
s := []float64{3, 4, 1, 7, 5}
v := []float64{1, 2, 3, 4, 5}
truth := []float64{2, 2, -2, 3, 0}
dst := make([]float64, len(s))
SubTo(dst, s, v)
AreSlicesEqual(t, truth, dst, "Bad subtract")
// Test that all mismatch combinations panic
if !Panics(func() { SubTo(make([]float64, 2), make([]float64, 3), make([]float64, 3)) }) {
t.Errorf("Did not panic with dst different length")
}
if !Panics(func() { SubTo(make([]float64, 3), make([]float64, 2), make([]float64, 3)) }) {
t.Errorf("Did not panic with subtractor different length")
}
if !Panics(func() { SubTo(make([]float64, 3), make([]float64, 3), make([]float64, 2)) }) {
t.Errorf("Did not panic with subtractee different length")
}
}
func TestSum(t *testing.T) {
s := []float64{}
val := Sum(s)
if val != 0 {
t.Errorf("Val not returned as default when slice length is zero")
}
s = []float64{3, 4, 1, 7, 5}
val = Sum(s)
if val != 20 {
t.Errorf("Wrong sum returned")
}
}
func RandomSlice(l int) []float64 {
s := make([]float64, l)
for i := range s {
s[i] = rand.Float64()
}
return s
}
func benchmarkMin(b *testing.B, s []float64) {
b.StartTimer()
for i := 0; i < b.N; i++ {
_, _ = Min(s)
}
}
func BenchmarkMinSmall(b *testing.B) {
b.StopTimer()
s := RandomSlice(SMALL)
benchmarkMin(b, s)
}
func BenchmarkMinMed(b *testing.B) {
b.StopTimer()
s := RandomSlice(MEDIUM)
benchmarkMin(b, s)
}
func BenchmarkMinLarge(b *testing.B) {
b.StopTimer()
s := RandomSlice(LARGE)
benchmarkMin(b, s)
}
func BenchmarkMinHuge(b *testing.B) {
b.StopTimer()
s := RandomSlice(HUGE)
benchmarkMin(b, s)
}
func benchmarkAdd(b *testing.B, s ...[]float64) {
b.StartTimer()
for i := 0; i < b.N; i++ {
Add(s[0], s[1:]...)
}
}
func BenchmarkAddTwoSmall(b *testing.B) {
b.StopTimer()
i := SMALL
s := RandomSlice(i)
t := RandomSlice(i)
benchmarkAdd(b, s, t)
}
func BenchmarkAddFourSmall(b *testing.B) {
b.StopTimer()
i := SMALL
s := RandomSlice(i)
t := RandomSlice(i)
u := RandomSlice(i)
v := RandomSlice(i)
benchmarkAdd(b, s, t, u, v)
}
func BenchmarkAddTwoMed(b *testing.B) {
b.StopTimer()
i := MEDIUM
s := RandomSlice(i)
t := RandomSlice(i)
benchmarkAdd(b, s, t)
}
func BenchmarkAddFourMed(b *testing.B) {
b.StopTimer()
i := MEDIUM
s := RandomSlice(i)
t := RandomSlice(i)
u := RandomSlice(i)
v := RandomSlice(i)
benchmarkAdd(b, s, t, u, v)
}
func BenchmarkAddTwoLarge(b *testing.B) {
b.StopTimer()
i := LARGE
s := RandomSlice(i)
t := RandomSlice(i)
benchmarkAdd(b, s, t)
}
func BenchmarkAddFourLarge(b *testing.B) {
b.StopTimer()
i := LARGE
s := RandomSlice(i)
t := RandomSlice(i)
u := RandomSlice(i)
v := RandomSlice(i)
benchmarkAdd(b, s, t, u, v)
}
func BenchmarkAddTwoHuge(b *testing.B) {
b.StopTimer()
i := HUGE
s := RandomSlice(i)
t := RandomSlice(i)
benchmarkAdd(b, s, t)
}
func BenchmarkAddFourHuge(b *testing.B) {
b.StopTimer()
i := HUGE
s := RandomSlice(i)
t := RandomSlice(i)
u := RandomSlice(i)
v := RandomSlice(i)
benchmarkAdd(b, s, t, u, v)
}
func benchmarkLogSumExp(b *testing.B, s []float64) {
b.StartTimer()
for i := 0; i < b.N; i++ {
_ = LogSumExp(s)
}
}
func BenchmarkLogSumExpSmall(b *testing.B) {
b.StopTimer()
s := RandomSlice(SMALL)
benchmarkLogSumExp(b, s)
}
func BenchmarkLogSumExpMed(b *testing.B) {
b.StopTimer()
s := RandomSlice(MEDIUM)
benchmarkLogSumExp(b, s)
}
func BenchmarkLogSumExpLarge(b *testing.B) {
b.StopTimer()
s := RandomSlice(LARGE)
benchmarkLogSumExp(b, s)
}
func BenchmarkLogSumExpHuge(b *testing.B) {
b.StopTimer()
s := RandomSlice(HUGE)
benchmarkLogSumExp(b, s)
}
func benchmarkDot(b *testing.B, s1 []float64, s2 []float64) {
b.StartTimer()
for i := 0; i < b.N; i++ {
_ = Dot(s1, s2)
}
}
func BenchmarkDotSmall(b *testing.B) {
b.StopTimer()
s1 := RandomSlice(SMALL)
s2 := RandomSlice(SMALL)
benchmarkDot(b, s1, s2)
}
func BenchmarkDotMed(b *testing.B) {
b.StopTimer()
s1 := RandomSlice(MEDIUM)
s2 := RandomSlice(MEDIUM)
benchmarkDot(b, s1, s2)
}
func BenchmarkDotLarge(b *testing.B) {
b.StopTimer()
s1 := RandomSlice(LARGE)
s2 := RandomSlice(LARGE)
benchmarkDot(b, s1, s2)
}
func BenchmarkDotHuge(b *testing.B) {
b.StopTimer()
s1 := RandomSlice(HUGE)
s2 := RandomSlice(HUGE)
benchmarkDot(b, s1, s2)
}