如何避免为类似的 golang 结构重新实现 sort.Interface
How to avoid re-implementing sort.Interface for similar golang structs
Golang 中有一个问题困扰着我。
假设我有 2 个结构:
type Dog struct {
Name string
Breed string
Age int
}
type Cat struct {
Name string
FavoriteFood string
Age int
}
当我尝试按 Age
对 []*Dog
和 []*Cat
进行排序时,我必须定义 2 个不同的排序结构,例如:
type SortCat []*Cat
func (c SortCat) Len() int {//..}
func (c SortCat) Swap(i, j int) {//..}
func (c SortCat) Less(i, j int) bool {//..}
type SortDog []*Dog
func (c SortDog) Len() int {//..}
func (c SortDog) Swap(i, j int) {//..}
func (c SortDog) Less(i, j int) bool {//..}
一个自然的想法是实现一些SortableByAge
接口并使用接口函数创建一个Less
函数。喜欢:
type SortableByAge interface {
AgeValue() int
}
然后:
type SortAnimal []SortableByAge
func (c SortDog) Less(i, j int) bool {
return c[i].AgeValue() < c[j].AgeValue()
}
然而,根据:
http://golang.org/doc/faq#convert_slice_of_interface
dogs := make([]*Dogs, 0 , 1)
//add dogs here
sort.Sort(SortAnimal(dogs))
以上是不可能的。
所以我想知道这种情况的最佳做法是什么
是否有任何其他技术可以减少为我错过的类似结构一次又一次地实现 sort.Interface
的需要?
编辑:
我意识到我的例子很糟糕:(
在现实生活中,这两个结构非常不同,它们之间唯一的共同点是我希望按共同的数值对它们进行排序。
一个更好的例子是:
type Laptop {//...}
type Pizza {//...}
这两个结构的唯一共同点是我希望按价格对它们的切片(啊......不应该在示例中使用 Pizza
)进行排序。
因此,将它们组合成一个通用结构在很多情况下并不适用。
但会研究 go generate.
这种情况的最佳做法是定义
type Animal struct{
Species,Name string
Age int
}
如 twotwotwo 所建议。如果 cat 和 dog 足够相似,可以以相同的方式排序,那么它们也足够相似,可以成为相同的结构。如果它们在某些方面有所不同,那么您应该为每种类型重新实现接口。
另一种方法是将所有指针从 []*Cat
切片复制到相同大小的 []SortableByAge
切片中。如果您要对切片进行排序,则需要 O(n*log(n)),因此额外的 O(n) 不应该是性能问题。
第三种选择,在极少数情况下,您有许多类型,出于某种原因必须区分但仍然具有非常简单的排序功能,您可以查看使用 go generate.[=14 自动生成它们=]
这个具体案例
在这种特定情况下,您不应使用 2 种不同的类型,因为它们是相同的,只需使用常见的 Animal
类型:
type Animal struct {
Name string
Age int
}
func (a Animal) String() string { return fmt.Sprintf("%s(%d)", a.Name, a.Age) }
type SortAnim []*Animal
func (c SortAnim) Len() int { return len(c) }
func (c SortAnim) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
func (c SortAnim) Less(i, j int) bool { return c[i].Age < c[j].Age }
func main() {
dogs := []*Animal{&Animal{"Max", 4}, &Animal{"Buddy", 3}}
cats := []*Animal{&Animal{"Bella", 4}, &Animal{"Kitty", 3}}
fmt.Println(dogs)
sort.Sort(SortAnim(dogs))
fmt.Println(dogs)
fmt.Println(cats)
sort.Sort(SortAnim(cats))
fmt.Println(cats)
}
输出(Go Playground):
[Max(4) Buddy(3)]
[Buddy(3) Max(4)]
[Bella(4) Kitty(3)]
[Kitty(3) Bella(4)]
一般情况
通常,如果您愿意放弃具体类型并改用接口类型,则只能使用通用排序实现。
创建您希望切片保留的接口类型:
type Animal interface {
Name() string
Age() int
}
你可以有一个通用的实现:
type animal struct {
name string
age int
}
func (a *animal) Name() string { return a.name }
func (a *animal) Age() int { return a.age }
func (a animal) String() string { return fmt.Sprintf("%s(%d)", a.name, a.age) }
您的特定动物类型:
type Dog struct {
animal // Embed animal (its methods and fields)
}
type Cat struct {
animal // Embed animal (its methods and fields)
}
您在 SortAnim
上实施 sort.Interface
:
type SortAnim []Animal
func (c SortAnim) Len() int { return len(c) }
func (c SortAnim) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
func (c SortAnim) Less(i, j int) bool { return c[i].Age() < c[j].Age() }
使用:
dogs := SortAnim{&Dog{animal{"Max", 4}}, &Dog{animal{"Buddy", 3}}}
cats := SortAnim{&Cat{animal{"Bella", 4}}, &Cat{animal{"Kitty", 3}}}
fmt.Println(dogs)
sort.Sort(SortAnim(dogs))
fmt.Println(dogs)
fmt.Println(cats)
sort.Sort(SortAnim(cats))
fmt.Println(cats)
输出(Go Playground):
[Max(4) Buddy(3)]
[Buddy(3) Max(4)]
[Bella(4) Kitty(3)]
[Kitty(3) Bella(4)]
注:如commit ad26bb5, in Go 1.8 (Q1 2017), you won't have to implement Len()
and Swap()
and Less()
since issue 16721中所示已解决。只需要Less()
,其余通过反射完成。
问题是:
- Vast majority of sort.Interface uses a slice
- Have to define a new top level type
Len
and Swap
methods are always the same
- Want to make common case simpler with least hit to performance
// Slice sorts the provided slice given the provided less function.
//
// The sort is not guaranteed to be stable. For a stable sort, use
// SliceStable.
//
// The function panics if the provided interface is not a slice.
func Slice(slice interface{}, less func(i, j int) bool) {
rv := reflect.ValueOf(slice)
swap := reflect.Swapper(slice)
length := rv.Len()
quickSort_func(lessSwap{less, swap}, 0, length, maxDepth(length))
}
所以只要你有一个 Less()
函数比较两个关于接口的实例,你就可以根据所述公共接口对任意数量的结构进行排序。
Go 1.18 generics will add another option, as illustrated in nwillc/genfuncs/container/sort.go
.
// Sort sorts a slice by the LessThan order.
func (s GSlice[T]) Sort(lessThan genfuncs.BiFunction[T, T, bool]) {
n := len(s)
s.quickSort(0, n, maxDepth(n), lessThan)
}
// BiFunction accepts two arguments and produces a result.
type BiFunction[T, U, R any] func(T, U) R
这只是说明如何实现通用排序的示例:它不是官方排序(因为在撰写本文时,通用排序在 2022 年第一季度还很新)。
Golang 中有一个问题困扰着我。 假设我有 2 个结构:
type Dog struct {
Name string
Breed string
Age int
}
type Cat struct {
Name string
FavoriteFood string
Age int
}
当我尝试按 Age
对 []*Dog
和 []*Cat
进行排序时,我必须定义 2 个不同的排序结构,例如:
type SortCat []*Cat
func (c SortCat) Len() int {//..}
func (c SortCat) Swap(i, j int) {//..}
func (c SortCat) Less(i, j int) bool {//..}
type SortDog []*Dog
func (c SortDog) Len() int {//..}
func (c SortDog) Swap(i, j int) {//..}
func (c SortDog) Less(i, j int) bool {//..}
一个自然的想法是实现一些SortableByAge
接口并使用接口函数创建一个Less
函数。喜欢:
type SortableByAge interface {
AgeValue() int
}
然后:
type SortAnimal []SortableByAge
func (c SortDog) Less(i, j int) bool {
return c[i].AgeValue() < c[j].AgeValue()
}
然而,根据: http://golang.org/doc/faq#convert_slice_of_interface
dogs := make([]*Dogs, 0 , 1)
//add dogs here
sort.Sort(SortAnimal(dogs))
以上是不可能的。
所以我想知道这种情况的最佳做法是什么
是否有任何其他技术可以减少为我错过的类似结构一次又一次地实现 sort.Interface
的需要?
编辑: 我意识到我的例子很糟糕:(
在现实生活中,这两个结构非常不同,它们之间唯一的共同点是我希望按共同的数值对它们进行排序。
一个更好的例子是:
type Laptop {//...}
type Pizza {//...}
这两个结构的唯一共同点是我希望按价格对它们的切片(啊......不应该在示例中使用 Pizza
)进行排序。
因此,将它们组合成一个通用结构在很多情况下并不适用。 但会研究 go generate.
这种情况的最佳做法是定义
type Animal struct{
Species,Name string
Age int
}
如 twotwotwo 所建议。如果 cat 和 dog 足够相似,可以以相同的方式排序,那么它们也足够相似,可以成为相同的结构。如果它们在某些方面有所不同,那么您应该为每种类型重新实现接口。
另一种方法是将所有指针从 []*Cat
切片复制到相同大小的 []SortableByAge
切片中。如果您要对切片进行排序,则需要 O(n*log(n)),因此额外的 O(n) 不应该是性能问题。
第三种选择,在极少数情况下,您有许多类型,出于某种原因必须区分但仍然具有非常简单的排序功能,您可以查看使用 go generate.[=14 自动生成它们=]
这个具体案例
在这种特定情况下,您不应使用 2 种不同的类型,因为它们是相同的,只需使用常见的 Animal
类型:
type Animal struct {
Name string
Age int
}
func (a Animal) String() string { return fmt.Sprintf("%s(%d)", a.Name, a.Age) }
type SortAnim []*Animal
func (c SortAnim) Len() int { return len(c) }
func (c SortAnim) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
func (c SortAnim) Less(i, j int) bool { return c[i].Age < c[j].Age }
func main() {
dogs := []*Animal{&Animal{"Max", 4}, &Animal{"Buddy", 3}}
cats := []*Animal{&Animal{"Bella", 4}, &Animal{"Kitty", 3}}
fmt.Println(dogs)
sort.Sort(SortAnim(dogs))
fmt.Println(dogs)
fmt.Println(cats)
sort.Sort(SortAnim(cats))
fmt.Println(cats)
}
输出(Go Playground):
[Max(4) Buddy(3)]
[Buddy(3) Max(4)]
[Bella(4) Kitty(3)]
[Kitty(3) Bella(4)]
一般情况
通常,如果您愿意放弃具体类型并改用接口类型,则只能使用通用排序实现。
创建您希望切片保留的接口类型:
type Animal interface {
Name() string
Age() int
}
你可以有一个通用的实现:
type animal struct {
name string
age int
}
func (a *animal) Name() string { return a.name }
func (a *animal) Age() int { return a.age }
func (a animal) String() string { return fmt.Sprintf("%s(%d)", a.name, a.age) }
您的特定动物类型:
type Dog struct {
animal // Embed animal (its methods and fields)
}
type Cat struct {
animal // Embed animal (its methods and fields)
}
您在 SortAnim
上实施 sort.Interface
:
type SortAnim []Animal
func (c SortAnim) Len() int { return len(c) }
func (c SortAnim) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
func (c SortAnim) Less(i, j int) bool { return c[i].Age() < c[j].Age() }
使用:
dogs := SortAnim{&Dog{animal{"Max", 4}}, &Dog{animal{"Buddy", 3}}}
cats := SortAnim{&Cat{animal{"Bella", 4}}, &Cat{animal{"Kitty", 3}}}
fmt.Println(dogs)
sort.Sort(SortAnim(dogs))
fmt.Println(dogs)
fmt.Println(cats)
sort.Sort(SortAnim(cats))
fmt.Println(cats)
输出(Go Playground):
[Max(4) Buddy(3)]
[Buddy(3) Max(4)]
[Bella(4) Kitty(3)]
[Kitty(3) Bella(4)]
注:如commit ad26bb5, in Go 1.8 (Q1 2017), you won't have to implement Len()
and Swap()
and Less()
since issue 16721中所示已解决。只需要Less()
,其余通过反射完成。
问题是:
- Vast majority of sort.Interface uses a slice
- Have to define a new top level type
Len
andSwap
methods are always the same- Want to make common case simpler with least hit to performance
// Slice sorts the provided slice given the provided less function.
//
// The sort is not guaranteed to be stable. For a stable sort, use
// SliceStable.
//
// The function panics if the provided interface is not a slice.
func Slice(slice interface{}, less func(i, j int) bool) {
rv := reflect.ValueOf(slice)
swap := reflect.Swapper(slice)
length := rv.Len()
quickSort_func(lessSwap{less, swap}, 0, length, maxDepth(length))
}
所以只要你有一个 Less()
函数比较两个关于接口的实例,你就可以根据所述公共接口对任意数量的结构进行排序。
Go 1.18 generics will add another option, as illustrated in nwillc/genfuncs/container/sort.go
.
// Sort sorts a slice by the LessThan order.
func (s GSlice[T]) Sort(lessThan genfuncs.BiFunction[T, T, bool]) {
n := len(s)
s.quickSort(0, n, maxDepth(n), lessThan)
}
// BiFunction accepts two arguments and produces a result.
type BiFunction[T, U, R any] func(T, U) R
这只是说明如何实现通用排序的示例:它不是官方排序(因为在撰写本文时,通用排序在 2022 年第一季度还很新)。