Skip to content

shuffle

Static Badge

配列 arr を受け取り、要素をランダムにシャッフルした新しい配列を返します。

パラメータ notFixedPoint は、シャッフル後にすべての要素が元の位置から移動することを強制するかどうかを制御します。

  • false(デフォルト)の場合、Fisher-Yates アルゴリズムを使用します(要素は元の位置に残る可能性があります)。
  • true の場合、Sattolo アルゴリズムを使用します(すべての要素が元の位置に残らないことを保証します)。

Added in v0.1.0

Usage

ts
import { shuffle } from 'parsnip-kit'

const original = [1, 2, 3, 4, 5]
const res0 = shuffle(original) // It would be [3, 2, 4, 1, 5]
const res1 = shuffle(original, true) // It would be [3, 4, 2, 5, 1]
res0 === original // false
res1 === original // false

API

Type Parameter

ArgTypeDescription
T入力配列の要素型

Arguments

ArgTypeOptionalDefaultDescription
arrT[]falseundefinedシャッフル対象の入力配列
noFixedPointBooleantruefalse全要素を元の位置から移動させるか否か

Returns

Type
T[]