]> gitweb.michael.orlitzky.com - spline3.git/blob - src/Misc.hs
Add two examples (doctests) for the factorial function.
[spline3.git] / src / Misc.hs
1 -- | The Misc module contains helper functions that seem out of place
2 -- anywhere else.
3 module Misc
4 where
5
6
7 -- | The standard factorial function. See
8 -- <http://www.willamette.edu/~fruehr/haskell/evolution.html> for
9 -- possible improvements.
10 --
11 -- Examples:
12 --
13 -- >>> factorial 0
14 -- 1
15 --
16 -- >>> factorial 4
17 -- 24
18 --
19 factorial :: Int -> Int
20 factorial n
21 | n <= 1 = 1
22 | n > 20 = error "integer overflow in factorial function"
23 | otherwise = product [1..n]
24
25
26 -- | Takes a three-dimensional list, and flattens it into a
27 -- one-dimensional one.
28 flatten :: [[[a]]] -> [a]
29 flatten xs = concat $ concat xs
30
31
32 -- | Takes a list, and returns True if its elements are pairwise
33 -- equal. Returns False otherwise.
34 all_equal :: (Eq a) => [a] -> Bool
35 all_equal xs =
36 all (== first_element) other_elements
37 where
38 first_element = head xs
39 other_elements = tail xs