文档优化

This commit is contained in:
kercylan98 2023-06-12 10:24:07 +08:00
parent b52398e1d7
commit bdb0ded8be
2 changed files with 6 additions and 2 deletions

2
utils/g2d/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Package g2d 提供了大量用于2D计算的辅助函数及组件例如图形搜索、辐射关系、适用于矩阵的计算函数等
package g2d

View File

@ -57,12 +57,14 @@ func PositionToInt(width, x, y int) int {
return y*width + x
}
// PositionToIntWithArray 将坐标转换为数字
// PositionToIntWithArray 将坐标转换为二维数组的顺序位置
// - 需要确保x的取值范围必须小于width或者将会得到不正确的值
func PositionToIntWithArray(width int, xy [2]int) int {
return PositionToInt(width, xy[0], xy[1])
}
// PositionsToIntWithArray 将一组坐标转换为数字
// PositionsToIntWithArray 将一组坐标转换为二维数组的顺序位置
// - 需要确保x的取值范围必须小于width或者将会得到不正确的值
func PositionsToIntWithArray(width int, xys ...[2]int) []int {
var result = make([]int, len(xys), len(xys))
for i := 0; i < len(xys); i++ {