stat

README

stat

Install

go install github.com/xuender/stat@latest

License

© ender, 2023~time.Now

MIT LICENSE

Documentation

Index

• func Ceil[F constraints.Float](float F) F
• func Clone[T any](elems []T) []T
• func Floor[F constraints.Float](float F) F
• func GeometricMean[F constraints.Float](floats ...F) F
• func HarmonicMean[F constraints.Float](floats ...F) F
• func Max[O constraints.Ordered](ordereds ...O) O
• func Mean[N Number](numbers ...N) N
• func Median[O Number](ordereds ...O) O
• func Min[O constraints.Ordered](ordereds ...O) O
• func Modf[F constraints.Float](float F) (F, F)
• func Pow[N Number](x, y N) N
• func Round[F constraints.Float](float F, places int) F
• func Sort[O constraints.Ordered](ordereds []O)
• func Sum[O constraints.Ordered](ordereds ...O) O
• type Number

Examples

• GeometricMean
• HarmonicMean
• Max
• Mean
• Median
• Min
• Pow
• Round
• Sum

Functions

func Ceil

func Ceil[F constraints.Float](float F) F

func Clone

func Clone[T any](elems []T) []T

func Floor

func Floor[F constraints.Float](float F) F

func GeometricMean

func GeometricMean[F constraints.Float](floats ...F) F

GeometricMean returns the geometric mean for floats.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.GeometricMean(2.0, 18.0))
	fmt.Println(stat.GeometricMean([]float32{}...))

}

Output:

6
0

func HarmonicMean

func HarmonicMean[F constraints.Float](floats ...F) F

HarmonicMean return the harmonic mean for floats.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Round(stat.HarmonicMean(1.0, 2.0, 3.0, 4.0, 5.0), 2))
	fmt.Println(stat.HarmonicMean([]float32{}...))
	fmt.Println(stat.Round(stat.HarmonicMean(0.0), 2))

}

Output:

2.19
0
0

func Max

func Max[O constraints.Ordered](ordereds ...O) O

Max returns the highest elem in ordereds.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Max(9.1, 1.0, 2.2, 30.2, 4.0))
	fmt.Println(stat.Max([]int{}...))

}

Output:

30.2
0

func Mean

func Mean[N Number](numbers ...N) N

Mean returns the average of numbers.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Mean(1, 2, 3, 6))
	fmt.Println(stat.Mean([]int{}...))

}

Output:

3
0

func Median

func Median[O Number](ordereds ...O) O

Median return the median elem of ordereds.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Median(5, 3, 4, 2, 1))
	fmt.Println(stat.Median(6.0, 3.0, 2.0, 4.0, 5.0, 1.0))
	fmt.Println(stat.Median(1))
	fmt.Println(stat.Median([]int{}...))

}

Output:

3
3.5
1
0

func Min

func Min[O constraints.Ordered](ordereds ...O) O

Min returns the lowest elem in ordereds.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Min(9, 1, 2, 3, 4))
	fmt.Println(stat.Min([]int{}...))

}

Output:

1
0

func Modf

func Modf[F constraints.Float](float F) (F, F)

func Pow

func Pow[N Number](x, y N) N

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Pow(2, 3))
	fmt.Println(stat.Pow(4.0, 0.5))

}

Output:

8
2

func Round

func Round[F constraints.Float](float F, places int) F

Round returns a float to a specific decimal place or precision.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Round(3.1415926, 2))
	fmt.Println(stat.Round(-3.005926, 2))

}

Output:

3.14
-3.01

func Sort

func Sort[O constraints.Ordered](ordereds []O)

func Sum

func Sum[O constraints.Ordered](ordereds ...O) O

Sum returns the sum of ordereds.

Example

package main

import (
	"fmt"

	"github.com/xuender/stat"
)

func main() {
	fmt.Println(stat.Sum(1, 2, 3, 4))
	fmt.Println(stat.Sum("a", "b", "c"))

}

Output:

10
abc

Types

type Number

type Number interface {
	constraints.Integer | constraints.Float
}