# Arrangement [![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur) ![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat) arrangement 包提供了一些有用的函数来处理数组的排列。更多的详细信息和使用示例，可以参考每个函数的文档。 ## 目录导航列出了该 `package` 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️

展开 / 折叠目录导航

*** ## 详情信息 #### func WithAreaConstraint\[ID comparable, AreaInfo any\](constraint AreaConstraintHandle[ID, AreaInfo]) AreaOption[ID, AreaInfo] > 设置编排区域的约束条件 > - 该约束用于判断一个成员是否可以被添加到该编排区域中 > - 与 WithAreaConflict 不同的是，约束通常用于非成员关系导致的硬性约束，例如：成员的等级过滤、成员的性别等 *** #### func WithAreaConflict\[ID comparable, AreaInfo any\](conflict AreaConflictHandle[ID, AreaInfo]) AreaOption[ID, AreaInfo] > 设置编排区域的冲突条件，冲突处理函数需要返回造成冲突的成员列表 > - 该冲突用于判断一个成员是否可以被添加到该编排区域中 > - 与 WithAreaConstraint 不同的是，冲突通常用于成员关系导致的软性约束，例如：成员的职业唯一性、成员的种族唯一性等 *** #### func WithAreaEvaluate\[ID comparable, AreaInfo any\](evaluate AreaEvaluateHandle[ID, AreaInfo]) AreaOption[ID, AreaInfo] > 设置编排区域的评估函数 > - 该评估函数将影响成员被编入区域的优先级 *** #### func NewArrangement\[ID comparable, AreaInfo any\](options ...Option[ID, AreaInfo]) *Arrangement[ID, AreaInfo] > 创建一个新的编排 *** #### func WithItemFixed\[ID comparable, AreaInfo any\](matcher ItemFixedAreaHandle[AreaInfo]) ItemOption[ID, AreaInfo] > 设置成员的固定编排区域 *** #### func WithItemPriority\[ID comparable, AreaInfo any\](priority ItemPriorityHandle[ID, AreaInfo]) ItemOption[ID, AreaInfo] > 设置成员的优先级 *** #### func WithItemNotAllow\[ID comparable, AreaInfo any\](verify ItemNotAllowVerifyHandle[ID, AreaInfo]) ItemOption[ID, AreaInfo] > 设置成员不允许的编排区域 *** #### func WithRetryThreshold\[ID comparable, AreaInfo any\](threshold int) Option[ID, AreaInfo] > 设置编排时的重试阈值 > - 当每一轮编排结束任有成员未被编排时，将会进行下一轮编排，直到编排次数达到该阈值 > - 默认的阈值为 10 次 *** #### func WithConstraintHandle\[ID comparable, AreaInfo any\](handle ConstraintHandle[ID, AreaInfo]) Option[ID, AreaInfo] > 设置编排时触发约束时的处理函数 > - 当约束条件触发时，将会调用该函数。如果无法在该函数中处理约束，应该继续返回 err，尝试进行下一层的约束处理 > - 当该函数的返回值为 nil 时，表示约束已经被处理，将会命中当前的编排区域 > - 当所有的约束处理函数都无法处理约束时，将会进入下一个编排区域的尝试，如果均无法完成，将会将该成员加入到编排队列的末端，等待下一次编排 > > 有意思的是，硬性约束应该永远是无解的，而当需要进行一些打破规则的操作时，则可以透过该函数传入的 editor 进行操作 *** #### func WithConflictHandle\[ID comparable, AreaInfo any\](handle ConflictHandle[ID, AreaInfo]) Option[ID, AreaInfo] > 设置编排时触发冲突时的处理函数 > - 当冲突条件触发时，将会调用该函数。如果无法在该函数中处理冲突，应该继续返回这一批成员，尝试进行下一层的冲突处理 > - 当该函数的返回值长度为 0 时，表示冲突已经被处理，将会命中当前的编排区域 > - 当所有的冲突处理函数都无法处理冲突时，将会进入下一个编排区域的尝试，如果均无法完成，将会将该成员加入到编排队列的末端，等待下一次编排 *** ### Area `STRUCT` 编排区域 ```go type Area[ID comparable, AreaInfo any] struct { info AreaInfo items map[ID]Item[ID] constraints []AreaConstraintHandle[ID, AreaInfo] conflicts []AreaConflictHandle[ID, AreaInfo] evaluate AreaEvaluateHandle[ID, AreaInfo] } ``` #### func (*Area) GetAreaInfo() AreaInfo > 获取编排区域的信息 *** #### func (*Area) GetItems() map[ID]Item[ID] > 获取编排区域中的所有成员 *** #### func (*Area) IsAllow(item Item[ID]) (constraintErr error, conflictItems map[ID]Item[ID], allow bool) > 检测一个成员是否可以被添加到该编排区域中 *** #### func (*Area) IsConflict(item Item[ID]) bool > 检测一个成员是否会造成冲突 *** #### func (*Area) GetConflictItems(item Item[ID]) map[ID]Item[ID] > 获取与一个成员产生冲突的所有其他成员 *** #### func (*Area) GetScore(extra ...Item[ID]) float64 > 获取该编排区域的评估分数 > - 当 extra 不为空时，将会将 extra 中的内容添加到 items 中进行评估 *** ### AreaOption `STRUCT` 编排区域选项 ```go type AreaOption[ID comparable, AreaInfo any] func(area *Area[ID, AreaInfo]) ``` ### AreaConstraintHandle `STRUCT` ```go type AreaConstraintHandle[ID comparable, AreaInfo any] func(area *Area[ID, AreaInfo], item Item[ID]) error ``` ### Arrangement `STRUCT` 用于针对多条数据进行合理编排的数据结构 - 我不知道这个数据结构的具体用途，但是我觉得这个数据结构应该是有用的 - 目前我能想到的用途只有我的过往经历：排课 - 如果是在游戏领域，或许适用于多人小队匹配编排等类似情况 ```go type Arrangement[ID comparable, AreaInfo any] struct { areas []*Area[ID, AreaInfo] items map[ID]Item[ID] fixed map[ID]ItemFixedAreaHandle[AreaInfo] priority map[ID][]ItemPriorityHandle[ID, AreaInfo] itemNotAllow map[ID][]ItemNotAllowVerifyHandle[ID, AreaInfo] threshold int constraintHandles []ConstraintHandle[ID, AreaInfo] conflictHandles []ConflictHandle[ID, AreaInfo] } ``` #### func (*Arrangement) AddArea(areaInfo AreaInfo, options ...AreaOption[ID, AreaInfo]) > 添加一个编排区域 *** #### func (*Arrangement) AddItem(item Item[ID]) > 添加一个成员 *** #### func (*Arrangement) Arrange() (areas []*Area[ID, AreaInfo], noSolution map[ID]Item[ID]) > 编排

查看 / 收起单元测试

```go func TestArrangement_Arrange(t *testing.T) { var a = arrangement.NewArrangement[int, *Team]() a.AddArea(&Team{ID: 1}, arrangement.WithAreaConstraint[int, *Team](func(area *arrangement.Area[int, *Team], item arrangement.Item[int]) error { if len(area.GetItems()) >= 2 { return errors.New("too many") } return nil })) a.AddArea(&Team{ID: 2}, arrangement.WithAreaConstraint[int, *Team](func(area *arrangement.Area[int, *Team], item arrangement.Item[int]) error { if len(area.GetItems()) >= 1 { return errors.New("too many") } return nil })) a.AddArea(&Team{ID: 3}, arrangement.WithAreaConstraint[int, *Team](func(area *arrangement.Area[int, *Team], item arrangement.Item[int]) error { if len(area.GetItems()) >= 2 { return errors.New("too many") } return nil })) for i := 0; i < 10; i++ { a.AddItem(&Player{ID: i + 1}) } res, no := a.Arrange() for _, area := range res { var str = fmt.Sprintf("area %d: ", area.GetAreaInfo().ID) for id := range area.GetItems() { str += fmt.Sprintf("%d ", id) } fmt.Println(str) } var noStr = "no: " for _, i := range no { noStr += fmt.Sprintf("%d ", i.GetID()) } fmt.Println(noStr) } ```

*** ### Editor `STRUCT` 提供了大量辅助函数的编辑器 ```go type Editor[ID comparable, AreaInfo any] struct { a *Arrangement[ID, AreaInfo] pending []Item[ID] fails []Item[ID] falls map[ID]struct{} retryCount int } ``` #### func (*Editor) GetPendingCount() int > 获取待编排的成员数量 *** #### func (*Editor) RemoveAreaItem(area *Area[ID, AreaInfo], item Item[ID]) > 从编排区域中移除一个成员到待编排队列中，如果该成员不存在于编排区域中，则不进行任何操作 *** #### func (*Editor) AddAreaItem(area *Area[ID, AreaInfo], item Item[ID]) > 将一个成员添加到编排区域中，如果该成员已经存在于编排区域中，则不进行任何操作 *** #### func (*Editor) GetAreas() []*Area[ID, AreaInfo] > 获取所有的编排区域 *** #### func (*Editor) GetAreasWithScoreAsc(extra ...Item[ID]) []*Area[ID, AreaInfo] > 获取所有的编排区域，并按照分数升序排序 *** #### func (*Editor) GetAreasWithScoreDesc(extra ...Item[ID]) []*Area[ID, AreaInfo] > 获取所有的编排区域，并按照分数降序排序 *** #### func (*Editor) GetRetryCount() int > 获取重试次数 *** #### func (*Editor) GetThresholdProgressRate() float64 > 获取重试次数阈值进度 *** #### func (*Editor) GetAllowAreas(item Item[ID]) []*Area[ID, AreaInfo] > 获取允许的编排区域 *** #### func (*Editor) GetNoAllowAreas(item Item[ID]) []*Area[ID, AreaInfo] > 获取不允许的编排区域 *** #### func (*Editor) GetBestAllowArea(item Item[ID]) *Area[ID, AreaInfo] > 获取最佳的允许的编排区域，如果不存在，则返回 nil *** #### func (*Editor) GetBestNoAllowArea(item Item[ID]) *Area[ID, AreaInfo] > 获取最佳的不允许的编排区域，如果不存在，则返回 nil *** #### func (*Editor) GetWorstAllowArea(item Item[ID]) *Area[ID, AreaInfo] > 获取最差的允许的编排区域，如果不存在，则返回 nil *** #### func (*Editor) GetWorstNoAllowArea(item Item[ID]) *Area[ID, AreaInfo] > 获取最差的不允许的编排区域，如果不存在，则返回 nil *** ### Item `INTERFACE` 编排成员 ```go type Item[ID comparable] interface { GetID() ID Equal(item Item[ID]) bool } ``` ### ItemOption `STRUCT` 编排成员选项 ```go type ItemOption[ID comparable, AreaInfo any] func(arrangement *Arrangement[ID, AreaInfo], item Item[ID]) ``` ### ItemFixedAreaHandle `STRUCT` ```go type ItemFixedAreaHandle[AreaInfo any] func(areaInfo AreaInfo) bool ``` ### Option `STRUCT` 编排选项 ```go type Option[ID comparable, AreaInfo any] func(arrangement *Arrangement[ID, AreaInfo]) ``` ### ConstraintHandle `STRUCT` ```go type ConstraintHandle[ID comparable, AreaInfo any] func(editor *Editor[ID, AreaInfo], area *Area[ID, AreaInfo], item Item[ID], err error) error ```