Check.hs

-- | This module provides the isSorted function, which checks if a list of
--   elements is sorted in ascending order.
module Data.Tensort.Utils.Check (isSorted) where

-- | Takes a list and returns True if the list is sorted in ascending
--   order and False otherwise.

-- | ==== __Examples__
-- >>> isSorted ([0, 1, 2, 3, 4] :: [Int])
-- True
--
-- >>> isSorted ([0, 1, 2, 4, 3] :: [Int])
-- False
isSorted :: (Ord a) => [a] -> Bool
isSorted [] = True
isSorted [_] = True
isSorted (x : y : remainingElements) =
  x <= y && isSorted (y : remainingElements)