shuffle

package
v1.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2024 License: MIT, MIT Imports: 3 Imported by: 0

README

go-shuffle

Forked from github.com/shogo82148/go-shuffle and add more features.

Build Status

Package shuffle provides primitives for shuffling slices and user-defined collections.

import "github.com/gogoods/x/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.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Float64s

func Float64s(a []float64)

Float64s shuffles a slice of float64s.

func Int64s

func Int64s(a []int64)

Int64s shuffles a slice of int64s.

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.

func Slice

func Slice(slice interface{})

Slice shuffles the slice.

func SortInt64s

func SortInt64s(a []int64)

SortInt64s sorts a slice of int64s in increasing order.

func Strings

func Strings(a []string)

Strings shuffles a slice of strings.

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

type Shuffler rand.Rand

A Shuffler provides Shuffle

func New

func New(src rand.Source) *Shuffler

New returns a new Shuffler that uses random values from src to shuffle

func (*Shuffler) Float64s

func (s *Shuffler) Float64s(a []float64)

Float64s shuffles a slice of float64s.

func (*Shuffler) Ints

func (s *Shuffler) Ints(a []int)

Ints shuffles a slice of ints.

func (*Shuffler) Shuffle

func (s *Shuffler) Shuffle(data Interface)

Shuffle shuffles Data.

func (*Shuffler) Slice

func (s *Shuffler) Slice(slice Interface)

Slice shuffles the slice.

func (*Shuffler) Strings

func (s *Shuffler) Strings(a []string)

Strings shuffles a slice of strings.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL