1
0
mirror of https://github.com/MontFerret/ferret.git synced 2024-12-16 11:37:36 +02:00
ferret/pkg/stdlib/math/variance_population.go
3timeslazy de703513e4 Linter Cleanup (#276)
* linter cleanup

* fix default case
2019-03-29 10:48:51 -04:00

37 lines
805 B
Go

package math
import (
"context"
"math"
"github.com/MontFerret/ferret/pkg/runtime/core"
"github.com/MontFerret/ferret/pkg/runtime/values"
"github.com/MontFerret/ferret/pkg/runtime/values/types"
)
// PopulationVariance returns the population variance of the values in a given array.
// @params (Array) - Array of numbers.
// @returns (Float) - The population variance.
func PopulationVariance(_ context.Context, args ...core.Value) (core.Value, error) {
var err 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.NewFloat(math.NaN()), nil
}
return variance(arr, values.NewInt(0)), nil
}