mirror of
https://github.com/MontFerret/ferret.git
synced 2025-03-19 21:28:32 +02:00
24d8eedd4c
* 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
88 lines
2.2 KiB
Go
88 lines
2.2 KiB
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"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// PERCENTILE returns the nth percentile of the values in a given array.
|
|
// @param {Int[] | Float[]} array - Array of numbers.
|
|
// @param {Int} number - A number which must be between 0 (excluded) and 100 (included).
|
|
// @param {String} [method="rank"] - "rank" or "interpolation".
|
|
// @return {Float} - The nth percentile, or null if the array is empty or only null values are contained in it or the percentile cannot be calculated.
|
|
func Percentile(_ context.Context, args ...core.Value) (core.Value, error) {
|
|
err := core.ValidateArgs(args, 2, 3)
|
|
|
|
if err != nil {
|
|
return values.None, err
|
|
}
|
|
|
|
err = core.ValidateType(args[0], types.Array)
|
|
|
|
if err != nil {
|
|
return values.None, err
|
|
}
|
|
|
|
err = core.ValidateType(args[1], types.Int)
|
|
|
|
if err != nil {
|
|
return values.None, err
|
|
}
|
|
|
|
// TODO: Implement different methods
|
|
//method := "rank"
|
|
//
|
|
//if len(args) > 2 {
|
|
// err = core.ValidateType(args[2], core.StringType)
|
|
//
|
|
// if err != nil {
|
|
// return values.None, err
|
|
// }
|
|
//
|
|
// if args[2].String() == "interpolation" {
|
|
// method = "interpolation"
|
|
// }
|
|
//}
|
|
|
|
arr := args[0].(*values.Array)
|
|
percent := values.Float(args[1].(values.Int))
|
|
|
|
if arr.Length() == 0 {
|
|
return values.NewFloat(math.NaN()), nil
|
|
}
|
|
|
|
if percent <= 0 || percent > 100 {
|
|
return values.NewFloat(math.NaN()), errors.New("input is outside of range")
|
|
}
|
|
|
|
sorted := arr.Sort()
|
|
|
|
// Multiply percent by length of input
|
|
l := values.Float(sorted.Length())
|
|
index := (percent / 100) * l
|
|
even := values.Float(values.Int(index))
|
|
|
|
var percentile core.Value
|
|
|
|
// Check if the index is a whole number
|
|
switch {
|
|
case index == even:
|
|
i := values.Int(index)
|
|
percentile = sorted.Get(i - 1)
|
|
case index > 1:
|
|
// Convert float to int via truncation
|
|
i := values.Int(index)
|
|
// Find the average of the index and following values
|
|
percentile, _ = mean(values.NewArrayWith(sorted.Get(i-1), sorted.Get(i)))
|
|
default:
|
|
return values.NewFloat(math.NaN()), errors.New("input is outside of range")
|
|
}
|
|
|
|
return percentile, nil
|
|
}
|