mirror of
https://github.com/samber/lo.git
synced 2025-09-27 04:15:58 +08:00
97074eeae7
* feat: create Mean for ints and floats * feat: create MeanBy for ints and floats * chore: add example tests for mean Mean and MeanBy
105 lines
3.0 KiB
Go
105 lines
3.0 KiB
Go
package lo
|
|
|
|
import "golang.org/x/exp/constraints"
|
|
|
|
// Range creates an array of numbers (positive and/or negative) with given length.
|
|
// Play: https://go.dev/play/p/0r6VimXAi9H
|
|
func Range(elementNum int) []int {
|
|
length := If(elementNum < 0, -elementNum).Else(elementNum)
|
|
result := make([]int, length)
|
|
step := If(elementNum < 0, -1).Else(1)
|
|
for i, j := 0, 0; i < length; i, j = i+1, j+step {
|
|
result[i] = j
|
|
}
|
|
return result
|
|
}
|
|
|
|
// RangeFrom creates an array of numbers from start with specified length.
|
|
// Play: https://go.dev/play/p/0r6VimXAi9H
|
|
func RangeFrom[T constraints.Integer | constraints.Float](start T, elementNum int) []T {
|
|
length := If(elementNum < 0, -elementNum).Else(elementNum)
|
|
result := make([]T, length)
|
|
step := If(elementNum < 0, -1).Else(1)
|
|
for i, j := 0, start; i < length; i, j = i+1, j+T(step) {
|
|
result[i] = j
|
|
}
|
|
return result
|
|
}
|
|
|
|
// RangeWithSteps creates an array of numbers (positive and/or negative) progressing from start up to, but not including end.
|
|
// step set to zero will return empty array.
|
|
// Play: https://go.dev/play/p/0r6VimXAi9H
|
|
func RangeWithSteps[T constraints.Integer | constraints.Float](start, end, step T) []T {
|
|
result := []T{}
|
|
if start == end || step == 0 {
|
|
return result
|
|
}
|
|
if start < end {
|
|
if step < 0 {
|
|
return result
|
|
}
|
|
for i := start; i < end; i += step {
|
|
result = append(result, i)
|
|
}
|
|
return result
|
|
}
|
|
if step > 0 {
|
|
return result
|
|
}
|
|
for i := start; i > end; i += step {
|
|
result = append(result, i)
|
|
}
|
|
return result
|
|
}
|
|
|
|
// Clamp clamps number within the inclusive lower and upper bounds.
|
|
// Play: https://go.dev/play/p/RU4lJNC2hlI
|
|
func Clamp[T constraints.Ordered](value T, min T, max T) T {
|
|
if value < min {
|
|
return min
|
|
} else if value > max {
|
|
return max
|
|
}
|
|
return value
|
|
}
|
|
|
|
// Sum sums the values in a collection. If collection is empty 0 is returned.
|
|
// Play: https://go.dev/play/p/upfeJVqs4Bt
|
|
func Sum[T constraints.Float | constraints.Integer | constraints.Complex](collection []T) T {
|
|
var sum T = 0
|
|
for _, val := range collection {
|
|
sum += val
|
|
}
|
|
return sum
|
|
}
|
|
|
|
// SumBy summarizes the values in a collection using the given return value from the iteration function. If collection is empty 0 is returned.
|
|
// Play: https://go.dev/play/p/Dz_a_7jN_ca
|
|
func SumBy[T any, R constraints.Float | constraints.Integer | constraints.Complex](collection []T, iteratee func(item T) R) R {
|
|
var sum R = 0
|
|
for _, item := range collection {
|
|
sum = sum + iteratee(item)
|
|
}
|
|
return sum
|
|
}
|
|
|
|
// Mean calculates the mean of a collection of numbers.
|
|
func Mean[T constraints.Float | constraints.Integer](collection []T) T {
|
|
var length T = T(len(collection))
|
|
if length == 0 {
|
|
return 0
|
|
}
|
|
var sum T = Sum(collection)
|
|
return sum / length
|
|
}
|
|
|
|
// MeanBy calculates the mean of a collection of numbers using the given return value from the iteration function.
|
|
func MeanBy[T any, R constraints.Float | constraints.Integer](collection []T, iteratee func(item T) R) R {
|
|
var length R = R(len(collection))
|
|
if length == 0 {
|
|
return 0
|
|
}
|
|
var sum R = SumBy(collection, iteratee)
|
|
return sum / length
|
|
}
|