1
0
mirror of https://github.com/MontFerret/ferret.git synced 2025-03-19 21:28:32 +02:00
ferret/pkg/stdlib/math/average.go
Tim Voronov 24d8eedd4c
Feature/doc markup (#543)
* Added release notes

* #509 fixedOCOD typo

* Updated values

* Updated comments

* Changed stdlib docs format

* Changed format of array in docs

* Use 'any' instead of 'value' in docs

* New format for optional params

* Updated docs for testing package

* Added namespace information
2020-08-07 21:49:29 -04:00

55 lines
1.0 KiB
Go

package math
import (
"context"
"github.com/MontFerret/ferret/pkg/runtime/core"
"github.com/MontFerret/ferret/pkg/runtime/values"
"github.com/MontFerret/ferret/pkg/runtime/values/types"
)
// AVERAGE Returns the average (arithmetic mean) of the values in array.
// @param {Int[] | Float[]} array - Array of numbers.
// @return {Float} - The average of the values in array.
func Average(_ context.Context, args ...core.Value) (core.Value, error) {
err := core.ValidateArgs(args, 1, 1)
if err != nil {
return values.None, err
}
err = core.ValidateType(args[0], types.Array)
if err != nil {
return values.None, err
}
arr := args[0].(*values.Array)
if arr.Length() == 0 {
return values.None, nil
}
var sum float64
arr.ForEach(func(value core.Value, idx int) bool {
err = core.ValidateType(value, types.Float, types.Int)
if err != nil {
return false
}
sum += toFloat(value)
return true
})
if err != nil {
return values.None, nil
}
count := arr.Length()
return values.Float(sum / float64(count)), nil
}