eburk/permutation
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Evan Burkey 2022-01-25 13:43:10 -08:00
parent 3889536a56
commit 2ccc3f8af5
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
permutation.go
View File

@ -1,7 +1,17 @@
/*
Package permutation implements Heap's algorithm for generating permutations of
lists. It uses Go 1.18's new generics feature to provide a generic interface
*/
package permutation package permutation
// GenSlice is a generic slice of data
type GenSlice[T any] []T type GenSlice[T any] []T
/*
Permutations uses Heap's Algorithm to generate a list of all possible
permutations of the provided list. Most slices will automatically coerce
their type into a GenSlice[T] with no casting required
*/
func Permutations[T any](arr GenSlice[T]) []GenSlice[T] { func Permutations[T any](arr GenSlice[T]) []GenSlice[T] {
var helper func(GenSlice[T], int) var helper func(GenSlice[T], int)
var res []GenSlice[T] var res []GenSlice[T]