diff --git a/floats/examples_test.go b/floats/examples_test.go index 9145a903..ef2f3f44 100644 --- a/floats/examples_test.go +++ b/floats/examples_test.go @@ -1,12 +1,10 @@ // 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 +// license that can be found in the LICENSE file. package floats -import ( - "fmt" -) +import "fmt" // Set of examples for all the functions @@ -52,7 +50,7 @@ func ExampleAdd_newslice() { func ExampleAdd_unequallengths() { // If the lengths of the slices are unknown, - // use Eqlen to check + // use EqualLengths to check s1 := []float64{1, 2, 3} s2 := []float64{5, 6, 7, 8} diff --git a/floats/floats.go b/floats/floats.go index b32398bd..8da3effe 100644 --- a/floats/floats.go +++ b/floats/floats.go @@ -1,6 +1,6 @@ // 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 +// license that can be found in the LICENSE file. package floats @@ -13,8 +13,8 @@ import ( "gonum.org/v1/gonum/internal/asm/f64" ) -// Add adds, element-wise, the elements of s and dst, and stores in dst. -// Panics if the lengths of dst and s do not match. +// Add adds, element-wise, the elements of s and dst, and stores the result in dst. +// It panics if the lengths of dst and s do not match. func Add(dst, s []float64) { if len(dst) != len(s) { panic("floats: length of the slices do not match") @@ -23,7 +23,7 @@ func Add(dst, s []float64) { } // AddTo adds, element-wise, the elements of s and t and -// stores the result in dst. Panics if the lengths of s, t and dst do not match. +// stores the result in dst. It panics if the lengths of s, t and dst do not match. func AddTo(dst, s, t []float64) []float64 { if len(s) != len(t) { panic("floats: length of adders do not match") @@ -331,17 +331,17 @@ func EqualLengths(slices ...[]float64) bool { // all of the found elements will be returned along with an error. // At the return of the function, the input inds will be in an undetermined state. func Find(inds []int, f func(float64) bool, s []float64, k int) ([]int, error) { - // inds is also returned to allow for calling with nil + // inds is also returned to allow for calling with nil. - // Reslice inds to have zero length + // Reslice inds to have zero length. inds = inds[:0] - // If zero elements requested, can just return + // If zero elements requested, can just return. if k == 0 { return inds, nil } - // If k < 0, return all of the found indices + // If k < 0, return all of the found indices. if k < 0 { for i, val := range s { if f(val) { @@ -351,7 +351,7 @@ func Find(inds []int, f func(float64) bool, s []float64, k int) ([]int, error) { return inds, nil } - // Otherwise, find the first k elements + // Otherwise, find the first k elements. nFound := 0 for i, val := range s { if f(val) { @@ -362,7 +362,7 @@ func Find(inds []int, f func(float64) bool, s []float64, k int) ([]int, error) { } } } - // Finished iterating over the loop, which means k elements were not found + // Finished iterating over the loop, which means k elements were not found. return inds, errors.New("floats: insufficient elements found") } @@ -441,13 +441,13 @@ func MaxIdx(s []float64) int { return ind } -// Min returns the maximum value in the input slice. If the slice is empty, Min will panic. +// Min returns the minimum value in the input slice. If the slice is empty, Min will panic. func Min(s []float64) float64 { return s[MinIdx(s)] } // MinIdx returns the index of the minimum value in the input slice. If several -// entries have the maximum value, the first such index is returned. If the slice +// entries have the minimum value, the first such index is returned. If the slice // is empty, MinIdx will panic. func MinIdx(s []float64) int { if len(s) == 0 { diff --git a/floats/floats_test.go b/floats/floats_test.go index ebb0cac7..fd1238a9 100644 --- a/floats/floats_test.go +++ b/floats/floats_test.go @@ -1,6 +1,6 @@ // 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 +// license that can be found in the LICENSE file. package floats @@ -285,7 +285,7 @@ func TestDiv(t *testing.T) { ans := []float64{5, 6, 9} Div(s1, s2) if !EqualApprox(s1, ans, EqTolerance) { - t.Errorf("Mul doesn't give correct answer") + t.Errorf("Div doesn't give correct answer") } s1short := []float64{1} if !Panics(func() { Div(s1short, s2) }) { @@ -504,13 +504,6 @@ func TestEqualsRelative(t *testing.T) { } } -func nextAfterN(x, y float64, n int) float64 { - for i := 0; i < n; i++ { - x = math.Nextafter(x, y) - } - return x -} - func TestEqualsULP(t *testing.T) { t.Parallel() if f := 67329.242; !EqualWithinULP(f, nextAfterN(f, math.Inf(1), 10), 10) { @@ -533,6 +526,12 @@ func TestEqualsULP(t *testing.T) { } } +func nextAfterN(x, y float64, n int) float64 { + for i := 0; i < n; i++ { + x = math.Nextafter(x, y) + } + return x +} func TestEqualLengths(t *testing.T) { t.Parallel() s1 := []float64{1, 2, 3, 4} diff --git a/floats/parse_example_test.go b/floats/parse_example_test.go index 7e02b2f6..f08ec9d5 100644 --- a/floats/parse_example_test.go +++ b/floats/parse_example_test.go @@ -1,6 +1,6 @@ // Copyright ©2017 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 +// license that can be found in the LICENSE file. package floats_test