RandomizeList.hs

-- | This module prvodies the randomizeList function, which randomizes Sortable
--   lists.
module Data.Tensort.Utils.RandomizeList (randomizeList) where

import Data.Tensort.Utils.Types (Sortable (..))
import System.Random (mkStdGen)
import System.Random.Shuffle (shuffle')

-- | Takes a seed for random generation and a Sortable list and returns a new
--   Sortable list with the same elements as the input list but in a random
--   order.

-- | ==== __Examples__
-- >>> randomizeList 143 (SortBit [4, 8, 15, 16, 23, 42])
-- SortBit [16,23,4,8,15,42]
--
-- >>> randomizeList 143 (SortRec [(2,4),(3,8),(0,15),(1,16),(5,23),(4,42)])
-- SortRec [(1,16),(5,23),(2,4),(3,8),(0,15),(4,42)]
randomizeList :: Int -> Sortable -> Sortable
randomizeList seed (SortBit xs) = SortBit (shuffle' xs (length xs) (mkStdGen seed))
randomizeList seed (SortRec xs) = SortRec (shuffle' xs (length xs) (mkStdGen seed))