README
¶
go-shuffle
Package shuffle provides primitives for shuffling slices and user-defined collections.
import "github.com/shogo82148/go-shuffle"
// Shuffle slice of int.
ints := []int{3, 1, 4, 1, 5, 9}
shuffle.Ints(ints)
// Shuffle slice of int64.
int64s := []int64{3, 1, 4, 1, 5, 9}
shuffle.Int64s(int64s)
// Shuffle slice of string.
strings := []string{"foo", "bar"}
shuffle.Strings(strings)
// Shuffle slice of float64.
float64s := []float64{3, 1, 4, 1, 5, 9}
shuffle.Float64s(float64s)
// Shuffle slices
shuffle.Slice(ints)
shuffle.Slice(int64s)
shuffle.Slice(strings)
shuffle.Slice(float64s)
See godoc for more information.
LICENSE
This software is released under the MIT License, see LICENSE.md.
Documentation
¶
Overview ¶
Package shuffle provides primitives for shuffling slices and user-defined collections.
As of Go 1.10, the same functionality is now provided by package math/rand, and those implementations should be preferred in new code.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Ints ¶
func Ints(a []int)
Ints shuffles a slice of ints.
Example ¶
x := []int{1, 2, 3, 4, 5}
shuffle.Ints(x)
for _, value := range x {
fmt.Println(value)
Output: 1 2 3 4 5
func Shuffle ¶
func Shuffle(data Interface)
Shuffle shuffles Data.
As of Go 1.10, it just calls rand.Shuffle(data.Len(), data.Swap).
func SortInt64s ¶
func SortInt64s(a []int64)
SortInt64s sorts a slice of int64s in increasing order.
Types ¶
type Int64Slice ¶
type Int64Slice []int64
Int64Slice attaches the methods of Interface to []int64, sorting in increasing order.
func (Int64Slice) Len ¶
func (p Int64Slice) Len() int
func (Int64Slice) Less ¶
func (p Int64Slice) Less(i, j int) bool
func (Int64Slice) Swap ¶
func (p Int64Slice) Swap(i, j int)
type Interface ¶
type Interface interface {
// Len is the number of elements in the collection.
Len() int
// Swap swaps the elements with indexes i and j.
Swap(i, j int)
}
Interface is a type, typically a collection, that satisfies shuffle.Interface can be shuffled by the routines in this package.
type Shuffler ¶
A Shuffler provides Shuffle
func (*Shuffler) Float64s ¶
Float64s shuffles a slice of float64s.
As of Go 1.10, it just calls (*rand.Rand).Shuffle(len(a), func(i, j int) { a[i], a[j] = a[j], a[i]}).
func (*Shuffler) Ints ¶
Ints shuffles a slice of ints.
As of Go 1.10, it just calls (*rand.Rand).Shuffle(len(a), func(i, j int) { a[i], a[j] = a[j], a[i]}).
Source Files