sliceutil

README

sliceutil

sliceutil 提供了针对数组和切片的功能

• At 查找符合条件的元素；
• Index 查找符合条件元素在数组中的位置；
• Indexes 查找所有符合条件元素在数组中的位置；
• Reverse 反转数组中的元素；
• Delete 删除符合条件的切片元素；
• QuickDelete 删除符合条件的切片元素，性能稍高于 Delete；
• Count 统计数组或切片中包含指定什的数量；
• Unique 提取数组中的唯一元素；
• Dup 查看数组或切片中是否包含重得的值；
• Contains 判断一个数组或是切片是否包含了另一个的所有元素；
• Min 查找最小值；
• Max 查找最大值；
• Filter 过滤数据；
• SafeFilter 过滤数据；
• AnySlice 将 slices 转换为 []any 类型；
• MapKeys 获取一个 map 的所有 key；
• MapVals 获取一个 map 的所有值；

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
intArr := [3]int{1, 7, 0}

// index == [3, 7]
index := Dup(intSlice, func(i, j int) bool {
    return intSlice[i] == intSlice[j]
})

// 返回 7 的数量
count := Count(intSlice, func(i, index int) bool {
    return intSlice[i] == 7
})

// 会重新调整切片的内容，将删除后的数据在放最前端，并返回新切片。
slice := Delete(intSlice, func(i, index int) bool {
    return intSlice[i] == 7
})

// ok == true
ok := Contains(intSlice, intArr, func(i, j int) bool {
    return int8(intSlice[i]) == int8Arr[j]
})

安装

go get github.com/issue9/sliceutil

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package sliceutil 提供对切片的相关功能

Index

• func AnySlice[S ~[]T, T any](slices S) []any
• func At[S ~[]T, T any](slice S, eq func(T, int) bool) (T, bool)
• func Contains[S ~[]T, T any](container, sub S, eq func(i, j T) bool) bool
• func Count[S ~[]T, T any](slice S, eq func(T, int) bool) (count int)
• func Delete[S ~[]T, T any](slice S, eq func(T, int) bool) S
• func Dup[S ~[]T, T any](slice S, eq func(i, j T) bool) (indexes []int)
• func Exists[S ~[]T, T any](slice S, eq func(T, int) bool) bool
• func Filter[S ~[]T, T any](slices S, f func(T, int) bool) []T
• func Index[S ~[]T, T any](slice S, eq func(T, int) bool) (index int)
• func Indexes[S ~[]T, T any](slice S, eq func(T, int) bool) (indexes []int)
• func MapKeys[M ~map[K]V, K comparable, V any](m M) []K
• func MapVals[M ~map[K]V, K comparable, V any](m M) []V
• func Max[S ~[]T, T any](slices S, less func(i, j T) bool) T
• func Min[S ~[]T, T any](slices S, less func(i, j T) bool) T
• func QuickDelete[S ~[]T, T any](slice S, eq func(T, int) bool) S
• func Reverse[S ~[]T, T any](slice S)
• func SafeFilter[S ~[]T, T any](slices S, f func(T, int) bool) []T
• func Unique[S ~[]T, T any](slice S, eq func(i, j T) bool) S

Examples

• At
• Contains
• Count
• Delete
• Dup
• Exists
• Index
• Unique

Functions

func AnySlice

func AnySlice[S ~[]T, T any](slices S) []any

AnySlice 将 slices 转换为 []any 类型

func At

func At[S ~[]T, T any](slice S, eq func(T, int) bool) (T, bool)

At 从 slice 中查找符合 eq 的元素

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
v, found := At(intSlice, func(e, _ int) bool {
	return e == 7
})
fmt.Println(found, v)

Output:

true 7

func Contains

func Contains[S ~[]T, T any](container, sub S, eq func(i, j T) bool) bool

Contains container 是否包含了 sub 中的所有元素

container 与 sub 都必须是数组或是切片类型。 如果只是需要判断某一个值是否在 container 中，可以使用 Count() 函数。 eq 用于判断两个数组或是切的某个元素是否相等，其原型为：

func(i, j int) bool

i 表示 sub 的第 i 个元素，j 表示 container 的第 j 个元素，两者顺序不能乱。

Example

ints1 := []int{1, 2, 3, 4, 5}
ints2 := []int{1, 5, 2}
fmt.Println(Contains(ints1, ints2, func(i, j int) bool {
	return i == j
}))

Output:

true

func Count

func Count[S ~[]T, T any](slice S, eq func(T, int) bool) (count int)

Count 检测数组中指定值的数量

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
fmt.Println(Count(intSlice, func(e, _ int) bool {
	return e == 7
}))

Output:

2

func Delete

func Delete[S ~[]T, T any](slice S, eq func(T, int) bool) S

Delete 删除 slice 中符合 eq 条件的元素

eq 对比函数，用于确定指定的元素是否可以删除，返回 true 表示可以删除；

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
rslt := Delete(intSlice, func(e, _ int) bool {
	return e == 7
})
fmt.Println("Delete:", rslt)

intSlice = []int{1, 2, 3, 7, 0, 4, 7}
rslt = QuickDelete(intSlice, func(e, _ int) bool {
	return e == 7 || e == 2
})
fmt.Println("QuickDelete:", rslt)

Output:

Delete: [1 2 3 0 4]
QuickDelete: [1 4 3 0]

func Dup

func Dup[S ~[]T, T any](slice S, eq func(i, j T) bool) (indexes []int)

Dup 检测数组或是切片中是否包含重复的值

在存在相同元素时，会返回该相同元素的下标列表， 当有多组相同元素时，仅返回第一组相同元素的下标。

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
fmt.Println(Dup(intSlice, func(i, j int) bool {
	return i == j
}))

Output:

[3 6]

func Exists

func Exists[S ~[]T, T any](slice S, eq func(T, int) bool) bool

Exists 判断 slice 中是否存在符合 eq 的元素存在

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
fmt.Println(Exists(intSlice, func(e, _ int) bool {
	return e == 7
}))

Output:

true

func Filter

func Filter[S ~[]T, T any](slices S, f func(T, int) bool) []T

Filter 过滤数据

NOTE: 这是基于对原有数据 slices 的修改。

func Index

func Index[S ~[]T, T any](slice S, eq func(T, int) bool) (index int)

Index 从 slice 查找符合 eq 的第一个元素并返回其在数组中的元素

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
fmt.Println(Index(intSlice, func(e, _ int) bool {
	return e == 7
}))

Output:

3

func Indexes

func Indexes[S ~[]T, T any](slice S, eq func(T, int) bool) (indexes []int)

Indexes 返回所有符合条件的索引

func MapKeys

func MapKeys[M ~map[K]V, K comparable, V any](m M) []K

MapKeys 获取一个 map 的所有 key

func MapVals

func MapVals[M ~map[K]V, K comparable, V any](m M) []V

MapVals 获取一个 map 的所有值

func Max

func Max[S ~[]T, T any](slices S, less func(i, j T) bool) T

Max 查找最大值

less 用于判断 i 是否小于 j

func Min

func Min[S ~[]T, T any](slices S, less func(i, j T) bool) T

Min 查找最小值

less 用于判断 i 是否小于 j

func QuickDelete

func QuickDelete[S ~[]T, T any](slice S, eq func(T, int) bool) S

QuickDelete 删除 slice 中符合 eq 条件的元素

功能与 Delete 相同，但是性能相对 Delete 会好一些，同时也不再保证元素顺序与原数组相同。

func Reverse

func Reverse[S ~[]T, T any](slice S)

Reverse 反转数组中的元素

Deprecated: 可以使用标准库的 slices.Reverse 代替

func SafeFilter

func SafeFilter[S ~[]T, T any](slices S, f func(T, int) bool) []T

SafeFilter 过滤数据

func Unique

func Unique[S ~[]T, T any](slice S, eq func(i, j T) bool) S

Unique 提取 slice 中的所有唯一值

NOTE: 此操作会改变 slice 元素顺序。

Example

intSlice := []int{1, 2, 3, 7, 0, 4, 7}
rslt := Unique(intSlice, func(i, j int) bool {
	return i == j
})
fmt.Println(rslt)

Output:

[1 2 3 7 0 4]