Stats - Go语言统计包

一个经过充分测试的、全面的Go语言统计库/包/模块，无任何依赖。

如果您有任何建议、问题或错误报告，请创建一个issue，我会尽最大努力满足您的需求。此外，简单地为该仓库加星表示您对项目的支持，这将不胜感激！

安装

go get github.com/montanaflynn/stats

使用示例

所有函数可以在examples/main.go中查看，但这里给出一个简单的示例：

// 首先准备一些源数据
data := []float64{1.0, 2.1, 3.2, 4.823, 4.1, 5.8}

// 你也可以使用不同的类型，比如：
// data := stats.LoadRawData([]int{1, 2, 3, 4, 5})
// data := stats.LoadRawData([]interface{}{1.1, "2", 3})
// 等等...

median, _ := stats.Median(data)
fmt.Println(median) // 3.65

roundedMedian, _ := stats.Round(median, 0)
fmt.Println(roundedMedian) // 4

文档

完整的API文档可在GoDoc.org或pkg.go.dev上查看。

你也可以使用以下命令离线查看文档：

# 命令行
godoc .              # 显示所有导出的API
godoc . Median       # 显示单个函数
godoc -ex . Round    # 显示带示例的函数
godoc . Float64Data  # 显示类型和方法

# 本地网站
godoc -http=:4444    # 在4444端口启动godoc服务器
open http://localhost:4444/pkg/github.com/montanaflynn/stats/

导出的API如下：

var (
    ErrEmptyInput = statsError{"输入不能为空。"}
    ErrNaN        = statsError{"不是一个数字。"}
    ErrNegative   = statsError{"不能包含负值。"}
    ErrZero       = statsError{"不能包含零值。"}
    ErrBounds     = statsError{"输入超出范围。"}
    ErrSize       = statsError{"长度必须相同。"}
    ErrInfValue   = statsError{"值是无穷大。"}
    ErrYCoord     = statsError{"Y值必须大于零。"}
)

func Round(input float64, places int) (rounded float64, err error) {}

type Float64Data []float64

func LoadRawData(raw interface{}) (f Float64Data) {}
func 自相关(数据 Float64Data, 滞后数 int) (float64, error) {}
func 切比雪夫距离(数据点X, 数据点Y Float64Data) (距离 float64, 错误 error) {}
func 相关性(数据1, 数据2 Float64Data) (float64, error) {}
func 协方差(数据1, 数据2 Float64Data) (float64, error) {}
func 总体协方差(数据1, 数据2 Float64Data) (float64, error) {}
func 累积和(输入 Float64Data) ([]float64, error) {}
func 描述统计(输入 Float64Data, 允许NaN bool, 百分位数 *[]float64) (*描述, error) {}
func 自定义百分位函数描述统计(输入 Float64Data, 允许NaN bool, 百分位数 *[]float64, 百分位函数 func(Float64Data, float64) (float64, error)) (*描述, error) {}
func 熵(输入 Float64Data) (float64, error) {}
func 欧几里得距离(数据点X, 数据点Y Float64Data) (距离 float64, 错误 error) {}
func 几何平均数(输入 Float64Data) (float64, error) {}
func 调和平均数(输入 Float64Data) (float64, error) {}
func 四分位距(输入 Float64Data) (float64, error) {}
func 曼哈顿距离(数据点X, 数据点Y Float64Data) (距离 float64, 错误 error) {}
func 最大值(输入 Float64Data) (最大值 float64, 错误 error) {}
func 平均值(输入 Float64Data) (float64, error) {}
func 中位数(输入 Float64Data) (中位数 float64, 错误 error) {}
func 中位数绝对偏差(输入 Float64Data) (中位数绝对偏差 float64, 错误 error) {}
func 总体中位数绝对偏差(输入 Float64Data) (中位数绝对偏差 float64, 错误 error) {}
func 中铰(输入 Float64Data) (float64, error) {}
func 最小值(输入 Float64Data) (最小值 float64, 错误 error) {}
func 闵可夫斯基距离(数据点X, 数据点Y Float64Data, lambda float64) (距离 float64, 错误 error) {}
func 众数(输入 Float64Data) (众数 []float64, 错误 error) {}
func 正态分布Box_Muller随机变量(位置 float64, 尺度 float64, 大小 int) []float64 {}
func 正态分布累积分布函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布熵(位置 float64, 尺度 float64) float64 {}
func 正态分布拟合(数据 []float64) [2]float64{}
func 正态分布置信区间(alpha float64, 位置 float64, 尺度 float64) [2]float64 {}
func 正态分布逆生存函数(p float64, 位置 float64, 尺度 float64) (x float64) {}
func 正态分布对数累积分布函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布对数概率密度函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布对数生存函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布均值(位置 float64, 尺度 float64) float64 {}
func 正态分布中位数(位置 float64, 尺度 float64) float64 {}
func 正态分布矩(n int, 位置 float64, 尺度 float64) float64 {}
func 正态分布概率密度函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布百分点函数(p float64, 位置 float64, 尺度 float64) (x float64) {}
func 正态分布百分点函数随机变量(位置 float64, 尺度 float64, 大小 int) []float64 {}
func 正态分布生存函数(x float64, 位置 float64, 尺度 float64) float64 {}
func 正态分布统计量(位置 float64, 尺度 float64, 矩 string) []float64 {}
func 正态分布标准差(位置 float64, 尺度 float64) float64 {}
func 正态分布方差(位置 float64, 尺度 float64) float64 {}
func 皮尔逊相关系数(数据1, 数据2 Float64Data) (float64, error) {}
func 百分位数(输入 Float64Data, 百分比 float64) (百分位数 float64, 错误 error) {}
func 最近秩百分位数(输入 Float64Data, 百分比 float64) (百分位数 float64, 错误 error) {}
func 总体方差(输入 Float64Data) (总体方差 float64, 错误 error) {}
func 采样(输入 Float64Data, 取样数 int, 替换 bool) ([]float64, error) {}
func 样本方差(输入 Float64Data) (样本方差 float64, 错误 error) {}
func S形函数(输入 Float64Data) ([]float64, error) {}
func 软最大值(输入 Float64Data) ([]float64, error) {}
func 稳定采样(输入 Float64Data, 取样数 int) ([]float64, error) {}
func StandardDeviation(输入 Float64Data) (标准差 float64, 错误 error) {}
func StandardDeviationPopulation(输入 Float64Data) (总体标准差 float64, 错误 error) {}
func StandardDeviationSample(输入 Float64Data) (样本标准差 float64, 错误 error) {}
func StdDevP(输入 Float64Data) (总体标准差 float64, 错误 error) {}
func StdDevS(输入 Float64Data) (样本标准差 float64, 错误 error) {}
func Sum(输入 Float64Data) (和 float64, 错误 error) {}
func Trimean(输入 Float64Data) (float64, error) {}
func VarP(输入 Float64Data) (总体方差 float64, 错误 error) {}
func VarS(输入 Float64Data) (样本方差 float64, 错误 error) {}
func Variance(输入 Float64Data) (方差 float64, 错误 error) {}
func ProbGeom(a int, b int, p float64) (几何概率 float64, 错误 error) {}
func ExpGeom(p float64) (几何期望 float64, 错误 error) {}
func VarGeom(p float64) (几何方差 float64, 错误 error) {}
type Coordinate struct {
    X, Y float64
}

type Series []Coordinate

func ExponentialRegression(s Series) (regressions Series, err error) {}
func LinearRegression(s Series) (regressions Series, err error) {}
func LogarithmicRegression(s Series) (regressions Series, err error) {}

type Outliers struct {
    Mild    Float64Data
    Extreme Float64Data
}

type Quartiles struct {
    Q1 float64
    Q2 float64
    Q3 float64
}

func Quartile(input Float64Data) (Quartiles, error) {}
func QuartileOutliers(input Float64Data) (Outliers, error) {}

贡献

无论大小，我们都欢迎提交拉取请求。我在 Makefile 中包含了许多辅助目标，用于常见操作如代码检查、测试、代码覆盖率报告等。

复刻仓库并克隆你的复刻版本
创建新分支（git checkout -b some-thing）
进行所需更改
确保测试通过（go test -cover 或 make test）
运行代码检查并修复问题（go vet . 或 make lint）
提交更改（git commit -am '做了某事'）
推送分支（git push origin some-thing）
提交拉取请求

为使过程尽可能顺畅，请也考虑以下步骤：

在 examples/main.go 中添加新功能的简单示例
在 README.md 文档部分更新任何新导出的 API
保持 100% 代码覆盖率（可以用 make coverage 检查）
使用 git rebase -i new-feature 将提交压缩成单个工作单元

发布

这不是贡献者必需的，主要是作为我这个仓库维护者的提醒。发布新版本时，我们应该更新 CHANGELOG.md 和 DOCUMENTATION.md。

首先安装用于生成 Markdown 文件和发布的工具：

go install github.com/davecheney/godoc2md@latest
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
brew tap git-chglog/git-chglog
brew install gnu-sed hub git-chglog

然后你可以运行这些 make 指令：