ferret/pkg/stdlib/math/stddev_sample.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"
)

// StandardDeviationSample returns the sample standard deviation of the values in a given array.
// @params (Array) - Array of numbers.
// @returns (Float) - The sample standard deviation.
func StandardDeviationSample(_ 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.NewFloat(math.NaN()), nil
	}

	vp := variance(arr, values.NewInt(1))

	return values.NewFloat(math.Pow(float64(vp), 0.5)), nil
}