Shuffle.jl

Module Overview

Shuffle — Module

Shuffle

Support for a number of deterministic and random shuffling algorithms. Provides functions shuffle, shuffle!, nshuffle and nshuffle! as well as the following shuffling algorithms:

faro (or weave) shuffle,
a cut,
random shuffle (uses Random.shuffle) and
Gilbert-Shannon-Reeds model.

source

Installation

The package is registered. Install in the REPL using:

julia> ]add Shuffle

Basic Usage

Shuffle.shuffle works just like Random.shuffle by default.

julia> using Shuffle

julia> shuffle([1, 2, 3, 4, 5, 6, 7])
7-element Vector{Int64}:
 5
 1
 4
 6
 2
 3
 7

The default shuffling algorithm randomises a collection totally, but you can just as easily use any other algorithm. See Shuffle.DEFAULTS to set another algorithm as the default.

julia> shuffle(collect(1:52), GilbertShannonReeds())
52-element Vector{Int64}:
 30
  1
 31
 32
 33
  2
  3
  4
  5
 34
  ⋮
 49
 50
 51
 25
 26
 27
 52
 28
 29

In-place shuffling works, too.

julia> arr = ["A", "B", "C", "D"];

julia> shuffle!(arr, Faro{:in}());

julia> arr
4-element Vector{String}:
 "C"
 "A"
 "D"
 "B"

We can also shuffle 3 times in a row (and get back to the original order).

julia> nshuffle!(arr, 3, Faro{:in}())
4-element Vector{String}:
 "A"
 "B"
 "C"
 "D"